Merge pull request #2390 from sharwell/csharp7-readability

Update readability rules for C# 7

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/ReadabilityRules/SA1100CodeFixProvider.cs

@@ -13,6 +13,7 @@ namespace StyleCop.Analyzers.ReadabilityRules
     using Microsoft.CodeAnalysis.CodeActions;
     using Microsoft.CodeAnalysis.CodeFixes;
     using Microsoft.CodeAnalysis.CSharp;
+    using Microsoft.CodeAnalysis.CSharp.Syntax;
     using Microsoft.CodeAnalysis.Text;
 
     /// <summary>
@@ -51,26 +52,22 @@ public override Task RegisterCodeFixesAsync(CodeFixContext context)
             return SpecializedTasks.CompletedTask;
         }
 
-        private static SyntaxToken GetBaseKeywordToken(SyntaxNode root, TextSpan sourceSpan)
+        private static BaseExpressionSyntax GetBaseExpressionNode(SyntaxNode root, TextSpan sourceSpan)
         {
-            return root.FindToken(sourceSpan.Start);
+            return (BaseExpressionSyntax)root.FindToken(sourceSpan.Start).Parent;
         }
 
-        private static SyntaxToken RewriteBaseAsThis(SyntaxToken token)
+        private static ThisExpressionSyntax RewriteBaseAsThis(BaseExpressionSyntax token)
         {
-            // By creating a `base` token with the literal text `this`, we can replace a token with the code fix instead
-            // of replacing an entire syntax node. This improves the performance of the code fix, but the resulting tree
-            // could be considered in a bad state. However, this is not a problem under any interpretation of the result
-            // because SA1100 is only reported in cases where `base.` and `this.` have the same meaning.
-            return SyntaxFactory.Token(token.LeadingTrivia, SyntaxKind.BaseKeyword, "this", "this", token.TrailingTrivia);
+            return SyntaxFactory.ThisExpression(SyntaxFactory.Token(SyntaxKind.ThisKeyword).WithTriviaFrom(token.Token));
         }
 
         private static async Task<Document> GetTransformedDocumentAsync(Document document, Diagnostic diagnostic, CancellationToken cancellationToken)
         {
             var root = await document.GetSyntaxRootAsync(cancellationToken).ConfigureAwait(false);
-            var token = GetBaseKeywordToken(root, diagnostic.Location.SourceSpan);
+            var node = GetBaseExpressionNode(root, diagnostic.Location.SourceSpan);
 
-            SyntaxNode newSyntaxRoot = root.ReplaceToken(token, RewriteBaseAsThis(token));
+            SyntaxNode newSyntaxRoot = root.ReplaceNode(node, RewriteBaseAsThis(node));
             return document.WithSyntaxRoot(newSyntaxRoot);
         }
 
@@ -91,13 +88,13 @@ protected override async Task<SyntaxNode> FixAllInDocumentAsync(FixAllContext fi
 
                 var syntaxRoot = await document.GetSyntaxRootAsync().ConfigureAwait(false);
 
-                List<SyntaxToken> tokensToReplace = new List<SyntaxToken>(diagnostics.Length);
+                List<BaseExpressionSyntax> nodesToReplace = new List<BaseExpressionSyntax>(diagnostics.Length);
                 foreach (var diagnostic in diagnostics)
                 {
-                    tokensToReplace.Add(GetBaseKeywordToken(syntaxRoot, diagnostic.Location.SourceSpan));
+                    nodesToReplace.Add(GetBaseExpressionNode(syntaxRoot, diagnostic.Location.SourceSpan));
                 }
 
-                return syntaxRoot.ReplaceTokens(tokensToReplace, (originalToken, rewrittenToken) => RewriteBaseAsThis(rewrittenToken));
+                return syntaxRoot.ReplaceNodes(nodesToReplace, (originalNode, rewrittenNode) => RewriteBaseAsThis(rewrittenNode));
             }
         }
     }

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1100CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1100CSharp7UnitTests : SA1100UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1101CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1101CSharp7UnitTests : SA1101UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1102CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1102CSharp7UnitTests : SA1102UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1103CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1103CSharp7UnitTests : SA1103UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1104CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1104CSharp7UnitTests : SA1104UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1105CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1105CSharp7UnitTests : SA1105UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1106CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1106CSharp7UnitTests : SA1106UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1107CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1107CSharp7UnitTests : SA1107UnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp7/ReadabilityRules/SA1108CSharp7UnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the Apache License, Version 2.0. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp7.ReadabilityRules
+{
+    using StyleCop.Analyzers.Test.ReadabilityRules;
+
+    public class SA1108CSharp7UnitTests : SA1108UnitTests
+    {
+    }
+}