Update SA1642 and its code fix to handle record structs correctly. Al…

…so add tests for records and record classes. #3518
DotNetAnalyzers · Sep 16, 2023 · 9ac20da · 9ac20da
1 parent 890236e
commit 9ac20da
Show file tree

Hide file tree

Showing 3 changed files with 216 additions and 117 deletions.
diff --git a/....Analyzers/StyleCop.Analyzers.CodeFixes/DocumentationRules/SA1642SA1643CodeFixProvider.cs b/....Analyzers/StyleCop.Analyzers.CodeFixes/DocumentationRules/SA1642SA1643CodeFixProvider.cs
@@ -8,7 +8,7 @@ namespace StyleCop.Analyzers.DocumentationRules
     using System;
     using System.Collections.Immutable;
     using System.Composition;
-    using System.Globalization;
+    using System.Diagnostics;
     using System.Linq;
     using System.Text.RegularExpressions;
     using System.Threading;
@@ -20,6 +20,7 @@ namespace StyleCop.Analyzers.DocumentationRules
     using Microsoft.CodeAnalysis.CSharp.Syntax;
     using Microsoft.CodeAnalysis.Formatting;
     using StyleCop.Analyzers.Helpers;
+    using StyleCop.Analyzers.Lightup;
 
     /// <summary>
     /// Implements a code fix for <see cref="SA1642ConstructorSummaryDocumentationMustBeginWithStandardText"/>
@@ -83,7 +84,7 @@ public override async Task RegisterCodeFixesAsync(CodeFixContext context)
 
         internal static ImmutableArray<string> GenerateStandardText(Document document, BaseMethodDeclarationSyntax methodDeclaration, BaseTypeDeclarationSyntax typeDeclaration, CancellationToken cancellationToken)
         {
-            bool isStruct = typeDeclaration.IsKind(SyntaxKind.StructDeclaration);
+            bool isStruct = typeDeclaration.IsKind(SyntaxKind.StructDeclaration) || typeDeclaration.IsKind(SyntaxKindEx.RecordStructDeclaration);
             var settings = document.Project.AnalyzerOptions.GetStyleCopSettings(methodDeclaration.SyntaxTree, cancellationToken);
             var culture = settings.DocumentationRules.DocumentationCultureInfo;
             var resourceManager = DocumentationResources.ResourceManager;
@@ -147,7 +148,19 @@ private static TypeParameterListSyntax GetTypeParameterList(BaseTypeDeclarationS
                 return classDeclaration.TypeParameterList;
             }
 
-            return (typeDeclaration as StructDeclarationSyntax)?.TypeParameterList;
+            if (typeDeclaration is StructDeclarationSyntax structDeclaration)
+            {
+                return structDeclaration.TypeParameterList;
+            }
+
+            if (RecordDeclarationSyntaxWrapper.IsInstance(typeDeclaration))
+            {
+                var recordDeclaration = (RecordDeclarationSyntaxWrapper)typeDeclaration;
+                return recordDeclaration.TypeParameterList;
+            }
+
+            Debug.Assert(false, $"Unhandled type {typeDeclaration.Kind()}");
+            return null;
         }
 
         private static Task<Document> GetTransformedDocumentAsync(Document document, SyntaxNode root, XmlElementSyntax node, CancellationToken cancellationToken)
@@ -202,21 +215,10 @@ private static bool IsMultiLine(XmlElementSyntax node)
         private static Task<Document> GetTransformedDocumentAsync(Document document, SyntaxNode root, XmlEmptyElementSyntax node)
         {
             var typeDeclaration = node.FirstAncestorOrSelf<BaseTypeDeclarationSyntax>();
-
-            TypeParameterListSyntax typeParameterList;
-            if (typeDeclaration is ClassDeclarationSyntax classDeclaration)
-            {
-                typeParameterList = classDeclaration.TypeParameterList;
-            }
-            else
-            {
-                typeParameterList = (typeDeclaration as StructDeclarationSyntax)?.TypeParameterList;
-            }
+            var typeParameterList = GetTypeParameterList(typeDeclaration);
 
             var newRoot = root.ReplaceNode(node, BuildSeeElement(typeDeclaration.Identifier, typeParameterList));
-
             var newDocument = document.WithSyntaxRoot(newRoot);
-
             return Task.FromResult(newDocument);
         }