Merge pull request #3570 from bjornhellander/feature/sa1402-record

Update SA1402 to handle records and record structs

Author: sharwell

StyleCop.Analyzers/StyleCop.Analyzers.CodeFixes/MaintainabilityRules/SA1402CodeFixProvider.cs

@@ -90,6 +90,8 @@ private static async Task<Solution> GetTransformedSolutionAsync(Document documen
                     case SyntaxKind.InterfaceDeclaration:
                     case SyntaxKind.EnumDeclaration:
                     case SyntaxKind.DelegateDeclaration:
+                    case SyntaxKindEx.RecordDeclaration:
+                    case SyntaxKindEx.RecordStructDeclaration:
                         nodesToRemoveFromExtracted.Add(child);
                         break;
 

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp10/MaintainabilityRules/SA1402CSharp10ForRecordClassUnitTests.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.MaintainabilityRules;
+
+    public class SA1402CSharp10ForRecordClassUnitTests : SA1402ForBlockDeclarationUnitTestsBase
+    {
+        public override string Keyword => "record class";
+
+        protected override string SettingKeyword => "class";
+
+        protected override bool IsConfiguredAsTopLevelTypeByDefault => true;
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp10/MaintainabilityRules/SA1402CSharp10ForRecordStructUnitTests.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.MaintainabilityRules;
+
+    public class SA1402CSharp10ForRecordStructUnitTests : SA1402ForBlockDeclarationUnitTestsBase
+    {
+        public override string Keyword => "record struct";
+
+        protected override string SettingKeyword => "struct";
+
+        protected override bool IsConfiguredAsTopLevelTypeByDefault => false;
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp10/MaintainabilityRules/SA1402CSharp10ForRecordUnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.CSharp9.MaintainabilityRules;
+
+    public class SA1402CSharp10ForRecordUnitTests : SA1402CSharp9ForRecordUnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402CSharp11ForRecordClassUnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+
+    public class SA1402CSharp11ForRecordClassUnitTests : SA1402CSharp10ForRecordClassUnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402CSharp11ForRecordStructUnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+
+    public class SA1402CSharp11ForRecordStructUnitTests : SA1402CSharp10ForRecordStructUnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402CSharp11ForRecordUnitTests.cs

@@ -0,0 +1,11 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+
+    public class SA1402CSharp11ForRecordUnitTests : SA1402CSharp10ForRecordUnitTests
+    {
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp9/MaintainabilityRules/SA1402CSharp9ForRecordUnitTests.cs

@@ -0,0 +1,16 @@
+// Copyright (c) Tunnel Vision Laboratories, LLC. All Rights Reserved.
+// Licensed under the MIT License. See LICENSE in the project root for license information.
+
+namespace StyleCop.Analyzers.Test.CSharp9.MaintainabilityRules
+{
+    using StyleCop.Analyzers.Test.MaintainabilityRules;
+
+    public class SA1402CSharp9ForRecordUnitTests : SA1402ForBlockDeclarationUnitTestsBase
+    {
+        public override string Keyword => "record";
+
+        protected override string SettingKeyword => "class";
+
+        protected override bool IsConfiguredAsTopLevelTypeByDefault => true;
+    }
+}

StyleCop.Analyzers/StyleCop.Analyzers.Test/MaintainabilityRules/SA1402ForBlockDeclarationUnitTestsBase.cs

@@ -24,6 +24,8 @@ public abstract class SA1402ForBlockDeclarationUnitTestsBase : FileMayOnlyContai
 
         protected SA1402SettingsConfiguration SettingsConfiguration { get; set; } = SA1402SettingsConfiguration.ConfigureAsTopLevelType;
 
+        protected virtual string SettingKeyword => this.Keyword;
+
         protected abstract bool IsConfiguredAsTopLevelTypeByDefault { get; }
 
         [Fact]
@@ -190,7 +192,7 @@ public async Task TestNestedTypesAsync()
 
         protected override string GetSettings()
         {
-            return this.SettingsConfiguration.GetSettings(this.Keyword);
+            return this.SettingsConfiguration.GetSettings(this.SettingKeyword);
         }
     }
 }

StyleCop.Analyzers/StyleCop.Analyzers/MaintainabilityRules/SA1402FileMayOnlyContainASingleType.cs

@@ -113,12 +113,14 @@ private static bool IsRelevantType(SyntaxNode node, StyleCopSettings settings)
             switch (node.Kind())
             {
             case SyntaxKind.ClassDeclaration:
+            case SyntaxKindEx.RecordDeclaration:
                 isRelevant = topLevelTypes.Contains(TopLevelType.Class);
                 break;
             case SyntaxKind.InterfaceDeclaration:
                 isRelevant = topLevelTypes.Contains(TopLevelType.Interface);
                 break;
             case SyntaxKind.StructDeclaration:
+            case SyntaxKindEx.RecordStructDeclaration:
                 isRelevant = topLevelTypes.Contains(TopLevelType.Struct);
                 break;
             case SyntaxKind.EnumDeclaration: