Skip to content

Commit 27b7396

Browse files
sharwellsharwell
committed
Use RegisterSyntaxNodeAction instead of RegisterSyntaxNodeActionHonorExclusions
1 parent 64d3935 commit 27b7396

98 files changed

Lines changed: 401 additions & 785 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/ElementDocumentationSummaryBase.cs‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@ internal abstract class ElementDocumentationSummaryBase : DiagnosticAnalyzer
3131

3232
protected ElementDocumentationSummaryBase()
3333
{
34-
this.compilationStartAction = this.HandleCompilationStart;
3534
this.typeDeclarationAction = this.HandleTypeDeclaration;
3635
this.methodDeclarationAction = this.HandleMethodDeclaration;
3736
this.constructorDeclarationAction = this.HandleConstructorDeclaration;
@@ -46,7 +45,17 @@ protected ElementDocumentationSummaryBase()
4645
/// <inheritdoc/>
4746
public override void Initialize(AnalysisContext context)
4847
{
49-
context.RegisterCompilationStartAction(this.compilationStartAction);
48+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
49+
50+
context.RegisterSyntaxNodeAction(this.typeDeclarationAction, SyntaxKinds.BaseTypeDeclaration);
51+
context.RegisterSyntaxNodeAction(this.methodDeclarationAction, SyntaxKind.MethodDeclaration);
52+
context.RegisterSyntaxNodeAction(this.constructorDeclarationAction, SyntaxKind.ConstructorDeclaration);
53+
context.RegisterSyntaxNodeAction(this.destructorDeclarationAction, SyntaxKind.DestructorDeclaration);
54+
context.RegisterSyntaxNodeAction(this.propertyDeclarationAction, SyntaxKind.PropertyDeclaration);
55+
context.RegisterSyntaxNodeAction(this.indexerDeclarationAction, SyntaxKind.IndexerDeclaration);
56+
context.RegisterSyntaxNodeAction(this.fieldDeclarationAction, SyntaxKinds.BaseFieldDeclaration);
57+
context.RegisterSyntaxNodeAction(this.delegateDeclarationAction, SyntaxKind.DelegateDeclaration);
58+
context.RegisterSyntaxNodeAction(this.eventDeclarationAction, SyntaxKind.EventDeclaration);
5059
}
5160

5261
/// <summary>
@@ -63,19 +72,6 @@ public override void Initialize(AnalysisContext context)
6372
/// <param name="diagnosticLocations">The location(s) where diagnostics, if any, should be reported.</param>
6473
protected abstract void HandleXmlElement(SyntaxNodeAnalysisContext context, DocumentationCommentTriviaSyntax documentation, XmlNodeSyntax syntax, XElement completeDocumentation, params Location[] diagnosticLocations);
6574

66-
private void HandleCompilationStart(CompilationStartAnalysisContext context)
67-
{
68-
context.RegisterSyntaxNodeActionHonorExclusions(this.typeDeclarationAction, SyntaxKinds.BaseTypeDeclaration);
69-
context.RegisterSyntaxNodeActionHonorExclusions(this.methodDeclarationAction, SyntaxKind.MethodDeclaration);
70-
context.RegisterSyntaxNodeActionHonorExclusions(this.constructorDeclarationAction, SyntaxKind.ConstructorDeclaration);
71-
context.RegisterSyntaxNodeActionHonorExclusions(this.destructorDeclarationAction, SyntaxKind.DestructorDeclaration);
72-
context.RegisterSyntaxNodeActionHonorExclusions(this.propertyDeclarationAction, SyntaxKind.PropertyDeclaration);
73-
context.RegisterSyntaxNodeActionHonorExclusions(this.indexerDeclarationAction, SyntaxKind.IndexerDeclaration);
74-
context.RegisterSyntaxNodeActionHonorExclusions(this.fieldDeclarationAction, SyntaxKinds.BaseFieldDeclaration);
75-
context.RegisterSyntaxNodeActionHonorExclusions(this.delegateDeclarationAction, SyntaxKind.DelegateDeclaration);
76-
context.RegisterSyntaxNodeActionHonorExclusions(this.eventDeclarationAction, SyntaxKind.EventDeclaration);
77-
}
78-
7975
private void HandleTypeDeclaration(SyntaxNodeAnalysisContext context)
8076
{
8177
var node = (BaseTypeDeclarationSyntax)context.Node;

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PartialElementDocumentationSummaryBase.cs‎

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -24,15 +24,17 @@ internal abstract class PartialElementDocumentationSummaryBase : DiagnosticAnaly
2424

2525
protected PartialElementDocumentationSummaryBase()
2626
{
27-
this.compilationStartAction = this.HandleCompilationStart;
2827
this.typeDeclarationAction = this.HandleTypeDeclaration;
2928
this.methodDeclarationAction = this.HandleMethodDeclaration;
3029
}
3130

3231
/// <inheritdoc/>
3332
public override void Initialize(AnalysisContext context)
3433
{
35-
context.RegisterCompilationStartAction(this.compilationStartAction);
34+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
35+
36+
context.RegisterSyntaxNodeAction(this.typeDeclarationAction, SyntaxKinds.TypeDeclaration);
37+
context.RegisterSyntaxNodeAction(this.methodDeclarationAction, SyntaxKind.MethodDeclaration);
3638
}
3739

3840
/// <summary>
@@ -44,12 +46,6 @@ public override void Initialize(AnalysisContext context)
4446
/// <param name="diagnosticLocations">The location(s) where diagnostics, if any, should be reported.</param>
4547
protected abstract void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax syntax, params Location[] diagnosticLocations);
4648

47-
private void HandleCompilationStart(CompilationStartAnalysisContext context)
48-
{
49-
context.RegisterSyntaxNodeActionHonorExclusions(this.typeDeclarationAction, SyntaxKinds.TypeDeclaration);
50-
context.RegisterSyntaxNodeActionHonorExclusions(this.methodDeclarationAction, SyntaxKind.MethodDeclaration);
51-
}
52-
5349
private void HandleTypeDeclaration(SyntaxNodeAnalysisContext context)
5450
{
5551
// We handle TypeDeclarationSyntax instead of BaseTypeDeclarationSyntax because enums are not allowed to be

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/PropertyDocumentationBase.cs‎

Lines changed: 3 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -15,12 +15,10 @@ namespace StyleCop.Analyzers.DocumentationRules
1515
/// </summary>
1616
internal abstract class PropertyDocumentationBase : DiagnosticAnalyzer
1717
{
18-
private readonly Action<CompilationStartAnalysisContext> compilationStartAction;
1918
private readonly Action<SyntaxNodeAnalysisContext> propertyDeclarationAction;
2019

2120
protected PropertyDocumentationBase()
2221
{
23-
this.compilationStartAction = this.HandleCompilationStart;
2422
this.propertyDeclarationAction = this.HandlePropertyDeclaration;
2523
}
2624

@@ -33,7 +31,9 @@ protected PropertyDocumentationBase()
3331
/// <inheritdoc/>
3432
public override void Initialize(AnalysisContext context)
3533
{
36-
context.RegisterCompilationStartAction(this.compilationStartAction);
34+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
35+
36+
context.RegisterSyntaxNodeAction(this.propertyDeclarationAction, SyntaxKind.PropertyDeclaration);
3737
}
3838

3939
/// <summary>
@@ -45,11 +45,6 @@ public override void Initialize(AnalysisContext context)
4545
/// <param name="diagnosticLocation">The location where diagnostics, if any, should be reported.</param>
4646
protected abstract void HandleXmlElement(SyntaxNodeAnalysisContext context, XmlNodeSyntax syntax, Location diagnosticLocation);
4747

48-
private void HandleCompilationStart(CompilationStartAnalysisContext context)
49-
{
50-
context.RegisterSyntaxNodeActionHonorExclusions(this.propertyDeclarationAction, SyntaxKind.PropertyDeclaration);
51-
}
52-
5348
private void HandlePropertyDeclaration(SyntaxNodeAnalysisContext context)
5449
{
5550
var node = (PropertyDeclarationSyntax)context.Node;

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1608ElementDocumentationMustNotHaveDefaultSummary.cs‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,6 @@ internal class SA1608ElementDocumentationMustNotHaveDefaultSummary : DiagnosticA
4747
private static readonly DiagnosticDescriptor Descriptor =
4848
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
4949

50-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
5150
private static readonly Action<SyntaxNodeAnalysisContext> DocumentationAction = HandleDocumentation;
5251

5352
/// <inheritdoc/>
@@ -57,12 +56,9 @@ internal class SA1608ElementDocumentationMustNotHaveDefaultSummary : DiagnosticA
5756
/// <inheritdoc/>
5857
public override void Initialize(AnalysisContext context)
5958
{
60-
context.RegisterCompilationStartAction(CompilationStartAction);
61-
}
59+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
6260

63-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
64-
{
65-
context.RegisterSyntaxNodeActionHonorExclusions(DocumentationAction, SyntaxKinds.DocumentationComment);
61+
context.RegisterSyntaxNodeAction(DocumentationAction, SyntaxKinds.DocumentationComment);
6662
}
6763

6864
private static void HandleDocumentation(SyntaxNodeAnalysisContext context)

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1611ElementParametersMustBeDocumented.cs‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,6 @@ internal class SA1611ElementParametersMustBeDocumented : DiagnosticAnalyzer
5151
SyntaxKind.OperatorDeclaration,
5252
SyntaxKind.ConversionOperatorDeclaration);
5353

54-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
5554
private static readonly Action<SyntaxNodeAnalysisContext> SyntaxNodeAction = HandleSyntaxNode;
5655

5756
/// <inheritdoc/>
@@ -61,12 +60,9 @@ internal class SA1611ElementParametersMustBeDocumented : DiagnosticAnalyzer
6160
/// <inheritdoc/>
6261
public override void Initialize(AnalysisContext context)
6362
{
64-
context.RegisterCompilationStartAction(CompilationStartAction);
65-
}
63+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
6664

67-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
68-
{
69-
context.RegisterSyntaxNodeActionHonorExclusions(SyntaxNodeAction, HandledSyntaxKinds);
65+
context.RegisterSyntaxNodeAction(SyntaxNodeAction, HandledSyntaxKinds);
7066
}
7167

7268
private static void HandleSyntaxNode(SyntaxNodeAnalysisContext context)

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1612ElementParameterDocumentationMustMatchElementParameters.cs‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,6 @@ internal class SA1612ElementParameterDocumentationMustMatchElementParameters : D
4848
private static readonly DiagnosticDescriptor OrderDescriptor =
4949
new DiagnosticDescriptor(DiagnosticId, Title, ParamWrongOrderMessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
5050

51-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
5251
private static readonly Action<SyntaxNodeAnalysisContext> DocumentationTriviaAction = HandleDocumentationTrivia;
5352

5453
/// <inheritdoc/>
@@ -58,12 +57,9 @@ internal class SA1612ElementParameterDocumentationMustMatchElementParameters : D
5857
/// <inheritdoc/>
5958
public override void Initialize(AnalysisContext context)
6059
{
61-
context.RegisterCompilationStartAction(CompilationStartAction);
62-
}
60+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
6361

64-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
65-
{
66-
context.RegisterSyntaxNodeActionHonorExclusions(DocumentationTriviaAction, SyntaxKind.SingleLineDocumentationCommentTrivia);
62+
context.RegisterSyntaxNodeAction(DocumentationTriviaAction, SyntaxKind.SingleLineDocumentationCommentTrivia);
6763
}
6864

6965
private static void HandleDocumentationTrivia(SyntaxNodeAnalysisContext context)

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1613ElementParameterDocumentationMustDeclareParameterName.cs‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ internal class SA1613ElementParameterDocumentationMustDeclareParameterName : Dia
4141
private static readonly DiagnosticDescriptor Descriptor =
4242
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
4343

44-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
4544
private static readonly Action<SyntaxNodeAnalysisContext> XmlElementAction = HandleXmlElement;
4645
private static readonly Action<SyntaxNodeAnalysisContext> XmlEmptyElementAction = HandleXmlEmptyElement;
4746

@@ -52,13 +51,10 @@ internal class SA1613ElementParameterDocumentationMustDeclareParameterName : Dia
5251
/// <inheritdoc/>
5352
public override void Initialize(AnalysisContext context)
5453
{
55-
context.RegisterCompilationStartAction(CompilationStartAction);
56-
}
54+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
5755

58-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
59-
{
60-
context.RegisterSyntaxNodeActionHonorExclusions(XmlElementAction, SyntaxKind.XmlElement);
61-
context.RegisterSyntaxNodeActionHonorExclusions(XmlEmptyElementAction, SyntaxKind.XmlEmptyElement);
56+
context.RegisterSyntaxNodeAction(XmlElementAction, SyntaxKind.XmlElement);
57+
context.RegisterSyntaxNodeAction(XmlEmptyElementAction, SyntaxKind.XmlEmptyElement);
6258
}
6359

6460
private static void HandleXmlElement(SyntaxNodeAnalysisContext context)

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1614ElementParameterDocumentationMustHaveText.cs‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ internal class SA1614ElementParameterDocumentationMustHaveText : DiagnosticAnaly
4141
private static readonly DiagnosticDescriptor Descriptor =
4242
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
4343

44-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
4544
private static readonly Action<SyntaxNodeAnalysisContext> XmlElementAction = HandleXmlElement;
4645
private static readonly Action<SyntaxNodeAnalysisContext> XmlEmptyElementAction = HandleXmlEmptyElement;
4746

@@ -52,13 +51,10 @@ internal class SA1614ElementParameterDocumentationMustHaveText : DiagnosticAnaly
5251
/// <inheritdoc/>
5352
public override void Initialize(AnalysisContext context)
5453
{
55-
context.RegisterCompilationStartAction(CompilationStartAction);
56-
}
54+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
5755

58-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
59-
{
60-
context.RegisterSyntaxNodeActionHonorExclusions(XmlElementAction, SyntaxKind.XmlElement);
61-
context.RegisterSyntaxNodeActionHonorExclusions(XmlEmptyElementAction, SyntaxKind.XmlEmptyElement);
56+
context.RegisterSyntaxNodeAction(XmlElementAction, SyntaxKind.XmlElement);
57+
context.RegisterSyntaxNodeAction(XmlEmptyElementAction, SyntaxKind.XmlEmptyElement);
6258
}
6359

6460
private static void HandleXmlElement(SyntaxNodeAnalysisContext context)

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1615ElementReturnValueMustBeDocumented.cs‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,6 @@ internal class SA1615ElementReturnValueMustBeDocumented : DiagnosticAnalyzer
4141
private static readonly DiagnosticDescriptor Descriptor =
4242
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
4343

44-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
4544
private static readonly Action<SyntaxNodeAnalysisContext> MethodDeclarationAction = HandleMethodDeclaration;
4645
private static readonly Action<SyntaxNodeAnalysisContext> DelegateDeclarationAction = HandleDelegateDeclaration;
4746

@@ -52,13 +51,10 @@ internal class SA1615ElementReturnValueMustBeDocumented : DiagnosticAnalyzer
5251
/// <inheritdoc/>
5352
public override void Initialize(AnalysisContext context)
5453
{
55-
context.RegisterCompilationStartAction(CompilationStartAction);
56-
}
54+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
5755

58-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
59-
{
60-
context.RegisterSyntaxNodeActionHonorExclusions(MethodDeclarationAction, SyntaxKind.MethodDeclaration);
61-
context.RegisterSyntaxNodeActionHonorExclusions(DelegateDeclarationAction, SyntaxKind.DelegateDeclaration);
56+
context.RegisterSyntaxNodeAction(MethodDeclarationAction, SyntaxKind.MethodDeclaration);
57+
context.RegisterSyntaxNodeAction(DelegateDeclarationAction, SyntaxKind.DelegateDeclaration);
6258
}
6359

6460
private static void HandleMethodDeclaration(SyntaxNodeAnalysisContext context)

‎StyleCop.Analyzers/StyleCop.Analyzers/DocumentationRules/SA1616ElementReturnValueDocumentationMustHaveText.cs‎

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,6 @@ internal class SA1616ElementReturnValueDocumentationMustHaveText : DiagnosticAna
4040
private static readonly DiagnosticDescriptor Descriptor =
4141
new DiagnosticDescriptor(DiagnosticId, Title, MessageFormat, AnalyzerCategory.DocumentationRules, DiagnosticSeverity.Warning, AnalyzerConstants.EnabledByDefault, Description, HelpLink);
4242

43-
private static readonly Action<CompilationStartAnalysisContext> CompilationStartAction = HandleCompilationStart;
4443
private static readonly Action<SyntaxNodeAnalysisContext> XmlElementAction = HandleXmlElement;
4544
private static readonly Action<SyntaxNodeAnalysisContext> XmlEmptyElementAction = HandleXmlEmptyElement;
4645

@@ -51,13 +50,10 @@ internal class SA1616ElementReturnValueDocumentationMustHaveText : DiagnosticAna
5150
/// <inheritdoc/>
5251
public override void Initialize(AnalysisContext context)
5352
{
54-
context.RegisterCompilationStartAction(CompilationStartAction);
55-
}
53+
context.ConfigureGeneratedCodeAnalysis(GeneratedCodeAnalysisFlags.None);
5654

57-
private static void HandleCompilationStart(CompilationStartAnalysisContext context)
58-
{
59-
context.RegisterSyntaxNodeActionHonorExclusions(XmlElementAction, SyntaxKind.XmlElement);
60-
context.RegisterSyntaxNodeActionHonorExclusions(XmlEmptyElementAction, SyntaxKind.XmlEmptyElement);
55+
context.RegisterSyntaxNodeAction(XmlElementAction, SyntaxKind.XmlElement);
56+
context.RegisterSyntaxNodeAction(XmlEmptyElementAction, SyntaxKind.XmlEmptyElement);
6157
}
6258

6359
private static void HandleXmlElement(SyntaxNodeAnalysisContext context)

0 commit comments

Comments
 (0)