Class RuleSet

Inheritance
object
RuleSet
Inherited Members
Namespace: Microsoft.CodeAnalysis
Assembly: Microsoft.CodeAnalysis.dll
Syntax
public class RuleSet

Constructors

RuleSet(string, ReportDiagnostic, ImmutableDictionary<string, ReportDiagnostic>, ImmutableArray<RuleSetInclude>)

Declaration
public RuleSet(string filePath, ReportDiagnostic generalOption, ImmutableDictionary<string, ReportDiagnostic> specificOptions, ImmutableArray<RuleSetInclude> includes)
Parameters
Type Name Description
string filePath
ReportDiagnostic generalOption
ImmutableDictionary<string, ReportDiagnostic> specificOptions
ImmutableArray<RuleSetInclude> includes

Properties

FilePath

Declaration
public string FilePath { get; }
Property Value
Type Description
string

GeneralDiagnosticOption

Declaration
public ReportDiagnostic GeneralDiagnosticOption { get; }
Property Value
Type Description
ReportDiagnostic

Includes

Declaration
public ImmutableArray<RuleSetInclude> Includes { get; }
Property Value
Type Description
ImmutableArray<RuleSetInclude>

SpecificDiagnosticOptions

Declaration
public ImmutableDictionary<string, ReportDiagnostic> SpecificDiagnosticOptions { get; }
Property Value
Type Description
ImmutableDictionary<string, ReportDiagnostic>

Methods

GetDiagnosticOptionsFromRulesetFile(string?, out Dictionary<string, ReportDiagnostic>)

Declaration
public static ReportDiagnostic GetDiagnosticOptionsFromRulesetFile(string? rulesetFileFullPath, out Dictionary<string, ReportDiagnostic> specificDiagnosticOptions)
Parameters
Type Name Description
string rulesetFileFullPath
Dictionary<string, ReportDiagnostic> specificDiagnosticOptions
Returns
Type Description
ReportDiagnostic

GetEffectiveIncludesFromFile(string)

Declaration
public static ImmutableArray<string> GetEffectiveIncludesFromFile(string filePath)
Parameters
Type Name Description
string filePath
Returns
Type Description
ImmutableArray<string>

LoadEffectiveRuleSetFromFile(string)

Declaration
public static RuleSet LoadEffectiveRuleSetFromFile(string filePath)
Parameters
Type Name Description
string filePath
Returns
Type Description
RuleSet

WithEffectiveAction(ReportDiagnostic)

Declaration
public RuleSet? WithEffectiveAction(ReportDiagnostic action)
Parameters
Type Name Description
ReportDiagnostic action
Returns
Type Description
RuleSet