Merge pull request #1472 from sharwell/fix-684

Fix behavior of SA1009 when preceded by a comment

Author: sharwell

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

@@ -701,6 +701,40 @@ public void TestMethod2(
             await this.VerifyCSharpFixAsync(testCode, fixedCode).ConfigureAwait(false);
         }
 
+        /// <summary>
+        /// This is a regression test for DotNetAnalyzers/StyleCopAnalyzers#684:
+        /// https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/684
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        public async Task TestEmbeddedCommentAsync()
+        {
+            var testCode = @"
+public class TestClass
+{
+    public void TestMethod()
+    {
+        System.Console.WriteLine(""{0}"", 1 /*text*/ );
+    }
+}
+";
+            var fixedCode = @"
+public class TestClass
+{
+    public void TestMethod()
+    {
+        System.Console.WriteLine(""{0}"", 1 /*text*/);
+    }
+}
+";
+
+            DiagnosticResult expected = this.CSharpDiagnostic().WithLocation(6, 52).WithArguments(" not", "preceded");
+
+            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);
+        }
+
         /// <inheritdoc/>
         protected override IEnumerable<DiagnosticAnalyzer> GetCSharpDiagnosticAnalyzers()
         {

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

@@ -188,7 +188,9 @@ private static void HandleCloseParenToken(SyntaxTreeAnalysisContext context, Syn
             if (precededBySpace)
             {
                 // Closing parenthesis must{ not} be {preceded} by a space.
-                var properties = TokenSpacingCodeFixProvider.RemovePreceding;
+                var properties = token.IsFirstInLine()
+                    ? TokenSpacingCodeFixProvider.RemovePreceding
+                    : TokenSpacingCodeFixProvider.RemoveImmediatePreceding;
                 context.ReportDiagnostic(Diagnostic.Create(Descriptor, token.GetLocation(), properties, " not", "preceded"));
             }