From a048b6c29d2759b4b492806454cbf0d8cb2b8217 Mon Sep 17 00:00:00 2001
From: David Wengier <david.wengier@microsoft.com>
Date: Fri, 18 Sep 2020 08:15:45 +1000
Subject: [PATCH] Don't remove leading trivia when removing suppression
 attributes (#47733)

---
 .../RemoveUnnecessaryPragmaSuppressionsCodeFixProvider.cs | 5 ++++-
 .../RemoveUnnecessaryPragmaSuppressionsTests.cs           | 8 +++++---
 2 files changed, 9 insertions(+), 4 deletions(-)

diff --git a/src/Analyzers/Core/CodeFixes/RemoveUnnecessarySuppressions/RemoveUnnecessaryPragmaSuppressionsCodeFixProvider.cs b/src/Analyzers/Core/CodeFixes/RemoveUnnecessarySuppressions/RemoveUnnecessaryPragmaSuppressionsCodeFixProvider.cs
index 39965a5419d..a2ef4fca8d4 100644
--- a/src/Analyzers/Core/CodeFixes/RemoveUnnecessarySuppressions/RemoveUnnecessaryPragmaSuppressionsCodeFixProvider.cs
+++ b/src/Analyzers/Core/CodeFixes/RemoveUnnecessarySuppressions/RemoveUnnecessaryPragmaSuppressionsCodeFixProvider.cs
@@ -81,10 +81,13 @@ protected override Task FixAllAsync(Document document, ImmutableArray<Diagnostic
                 ISyntaxFacts syntaxFacts)
             {
                 SyntaxNode node;
+                var options = SyntaxGenerator.DefaultRemoveOptions;
                 if (editor.OriginalRoot.FindNode(location.SourceSpan) is { } attribute &&
                     syntaxFacts.IsAttribute(attribute))
                 {
                     node = attribute;
+                    // Keep leading trivia for attributes as we don't want to remove doc comments, or anything else
+                    options |= SyntaxRemoveOptions.KeepLeadingTrivia;
                 }
                 else
                 {
@@ -93,7 +96,7 @@ protected override Task FixAllAsync(Document document, ImmutableArray<Diagnostic
 
                 if (processedNodes.Add(node))
                 {
-                    editor.RemoveNode(node);
+                    editor.RemoveNode(node, options);
                 }
             }
         }
diff --git a/src/EditorFeatures/CSharpTest/Diagnostics/Suppression/RemoveUnnecessaryPragmaSuppressionsTests.cs b/src/EditorFeatures/CSharpTest/Diagnostics/Suppression/RemoveUnnecessaryPragmaSuppressionsTests.cs
index 6a5dcf03dc3..88cdc4f8a5f 100644
--- a/src/EditorFeatures/CSharpTest/Diagnostics/Suppression/RemoveUnnecessaryPragmaSuppressionsTests.cs
+++ b/src/EditorFeatures/CSharpTest/Diagnostics/Suppression/RemoveUnnecessaryPragmaSuppressionsTests.cs
@@ -493,9 +493,6 @@ void M()
             [Fact]
             public async Task TestRemoveDiagnosticSuppression_Attribute_Trivia()
             {
-                // This test should not remove Comment1 and DocComment.
-                // TODO: File a bug for SyntaxEditor.RemoveNode API removing doc comment and its preceeeding trivia.
-
                 await TestInRegularAndScript1Async(
         $@"
 class Class
@@ -516,6 +513,11 @@ void M()
         @"
 class Class
 {
+    // Comment1
+    /// <summary>
+    /// DocComment
+    /// </summary>
+    // Comment2
     // Comment4
     void M()
     {
-- 
GitLab