Table of Contents

Class DevSkimRuleSet

Namespace
Microsoft.DevSkim
Assembly
Microsoft.DevSkim.dll

Storage for rules

public class DevSkimRuleSet : TypedRuleSet<DevSkimRule>, IEnumerable<DevSkimRule>, IEnumerable
Inheritance
AbstractRuleSet
TypedRuleSet<DevSkimRule>
DevSkimRuleSet
Implements
Inherited Members
TypedRuleSet<DevSkimRule>.GetEnumerator()
TypedRuleSet<DevSkimRule>.AddRule(DevSkimRule)
AbstractRuleSet._oatRules
AbstractRuleSet._logger
AbstractRuleSet.GetUniversalRules()
AbstractRuleSet.AppInspectorRuleToOatRule(Rule)
AbstractRuleSet.GetOatRules()
AbstractRuleSet.GetAppInspectorRules()
AbstractRuleSet._rules
AbstractRuleSet.EnableNonBacktrackingRegex

Constructors

DevSkimRuleSet()

Creates instance of Ruleset

public DevSkimRuleSet()

Methods

GetDefaultRuleSet()

Load the default rules embedded in the DevSkim binary

public static DevSkimRuleSet GetDefaultRuleSet()

Returns

DevSkimRuleSet

A DevSkimRuleSet

WithConfidenceFilter(Confidence)

Return a new RuleSet containing only rules that have one of the flags of the specified confidence enum, or Unspecified

public DevSkimRuleSet WithConfidenceFilter(Confidence filter)

Parameters

filter Confidence

The Enum with flags set for which Confidence rules to use

Returns

DevSkimRuleSet

A new DevSkimRuleSet with only rules that have the specified confidence set at the Rule level

WithIds(IEnumerable<string>)

Returns a new DevSkimRuleSet with only rules that have an ID matching one of the ids provided in ruleIds

public DevSkimRuleSet WithIds(IEnumerable<string> ruleIds)

Parameters

ruleIds IEnumerable<string>

Returns

DevSkimRuleSet

WithoutIds(IEnumerable<string>)

Returns a new DevSkimRuleSet with no rules that have an ID matching one of the ids provided in optsIgnoreRuleIds

public DevSkimRuleSet WithoutIds(IEnumerable<string> optsIgnoreRuleIds)

Parameters

optsIgnoreRuleIds IEnumerable<string>

Returns

DevSkimRuleSet