Merge pull request #1840 from sharwell/fix-1834

Fix SA1009 behavior inside trivia

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.Test/SpacingRules/SA1009UnitTests.cs

@@ -60,6 +60,33 @@ public void Method()
             await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);
         }
 
+        [Fact]
+        public async Task TestDocumentationMethodReferenceWithWhitespaceBeforeClosingParenthesisAsync()
+        {
+            const string testCode = @"
+public class Foo
+{
+    /// <see cref=""Method( )""/>
+    public void Method()
+    {
+    }
+}";
+            const string fixedCode = @"
+public class Foo
+{
+    /// <see cref=""Method()""/>
+    public void Method()
+    {
+    }
+}";
+
+            DiagnosticResult expected = this.CSharpDiagnostic().WithArguments(" not", "preceded").WithLocation(4, 28);
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpDiagnosticAsync(fixedCode, EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+            await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);
+        }
+
         [Fact]
         public async Task TestMethodWith2CorrectlySpacedParametersAsync()
         {
@@ -667,6 +694,13 @@ public void TestMethod2(
     }
 
     public int TestMethod3(int a) { return a; }
+
+    public int TestMethod4(string[] args)
+    {
+#if !(X || NOT )
+        return 1;
+#endif
+    }
 }
 ";
 
@@ -698,6 +732,13 @@ public void TestMethod2(
     }
 
     public int TestMethod3(int a) { return a; }
+
+    public int TestMethod4(string[] args)
+    {
+#if !(X || NOT)
+        return 1;
+#endif
+    }
 }
 ";
 
@@ -706,7 +747,8 @@ public void TestMethod2(
                 this.CSharpDiagnostic().WithLocation(10, 9).WithArguments(" not", "preceded"),
                 this.CSharpDiagnostic().WithLocation(16, 7).WithArguments(" not", "preceded"),
                 this.CSharpDiagnostic().WithLocation(21, 19).WithArguments(" not", "preceded"),
-                this.CSharpDiagnostic().WithLocation(25, 17).WithArguments(" not", "preceded")
+                this.CSharpDiagnostic().WithLocation(25, 17).WithArguments(" not", "preceded"),
+                this.CSharpDiagnostic().WithLocation(32, 16).WithArguments(" not", "preceded"),
             };
 
             await this.VerifyCSharpDiagnosticAsync(testCode, expected, CancellationToken.None).ConfigureAwait(false);

StyleCop.Analyzers/StyleCop.Analyzers/SpacingRules/SA1009ClosingParenthesisMustBeSpacedCorrectly.cs

@@ -63,7 +63,7 @@ private static void HandleCompilationStart(CompilationStartAnalysisContext conte
         private static void HandleSyntaxTree(SyntaxTreeAnalysisContext context)
         {
             SyntaxNode root = context.Tree.GetCompilationUnitRoot(context.CancellationToken);
-            foreach (var token in root.DescendantTokens())
+            foreach (var token in root.DescendantTokens(descendIntoTrivia: true))
             {
                 if (token.IsKind(SyntaxKind.CloseParenToken))
                 {
@@ -96,6 +96,7 @@ private static void HandleCloseParenToken(SyntaxTreeAnalysisContext context, Syn
             case SyntaxKind.CloseBracketToken:
             case SyntaxKind.SemicolonToken:
             case SyntaxKind.CommaToken:
+            case SyntaxKind.DoubleQuoteToken:
                 precedesStickyCharacter = true;
                 break;