Merge pull request #3317 from sharwell/with-init

Update SA1118 to allow 'with' expressions
DotNetAnalyzers · Mar 10, 2021 · 24755d2 · 24755d2
2 parents 28795c0 + 4239b71
commit 24755d2
Show file tree

Hide file tree

Showing 3 changed files with 72 additions and 1 deletion.
diff --git a/...eCop.Analyzers/StyleCop.Analyzers.Test.CSharp9/ReadabilityRules/SA1118CSharp9UnitTests.cs b/...eCop.Analyzers/StyleCop.Analyzers.Test.CSharp9/ReadabilityRules/SA1118CSharp9UnitTests.cs
@@ -3,9 +3,77 @@
 
 namespace StyleCop.Analyzers.Test.CSharp9.ReadabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.CSharp;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp8.ReadabilityRules;
+    using Xunit;
+    using static StyleCop.Analyzers.Test.Verifiers.StyleCopDiagnosticVerifier<StyleCop.Analyzers.ReadabilityRules.SA1118ParameterMustNotSpanMultipleLines>;
 
     public class SA1118CSharp9UnitTests : SA1118CSharp8UnitTests
     {
+        [Fact]
+        [WorkItem(3314, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3314")]
+        public async Task TestWithExpressionAsync()
+        {
+            var testCode = @"
+class Foo
+{
+    public record R(int X, int Y);
+
+    public void FunA(params object[] j)
+    {
+    }
+
+    public void FunB(R r)
+    {
+        FunA(
+            1,
+            r with
+            {
+                X = 1,
+            });
+    }
+}";
+
+            await new CSharpTest(LanguageVersion.CSharp9)
+            {
+                ReferenceAssemblies = ReferenceAssemblies.Net.Net50,
+                TestCode = testCode,
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
+        }
+
+        [Fact]
+        [WorkItem(3314, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3314")]
+        public async Task TestWithExpression2Async()
+        {
+            var testCode = @"
+class Foo
+{
+    public record R(int X, int Y);
+
+    public void FunA(params object[] j)
+    {
+    }
+
+    public void FunB(R r)
+    {
+        FunA(
+            1,
+            r with
+            {
+                X = 1,
+            },
+            2);
+    }
+}";
+
+            await new CSharpTest(LanguageVersion.CSharp9)
+            {
+                ReferenceAssemblies = ReferenceAssemblies.Net.Net50,
+                TestCode = testCode,
+            }.RunAsync(CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/....Analyzers/StyleCop.Analyzers/ReadabilityRules/SA1118ParameterMustNotSpanMultipleLines.cs b/....Analyzers/StyleCop.Analyzers/ReadabilityRules/SA1118ParameterMustNotSpanMultipleLines.cs
@@ -11,6 +11,7 @@ namespace StyleCop.Analyzers.ReadabilityRules
     using Microsoft.CodeAnalysis.CSharp.Syntax;
     using Microsoft.CodeAnalysis.Diagnostics;
     using StyleCop.Analyzers.Helpers;
+    using StyleCop.Analyzers.Lightup;
 
     /// <summary>
     /// A parameter to a C# method or indexer, other than the first parameter, spans across multiple lines.
@@ -82,6 +83,7 @@ internal class SA1118ParameterMustNotSpanMultipleLines : DiagnosticAnalyzer
             SyntaxKind.AnonymousObjectCreationExpression,
             SyntaxKind.ArrayCreationExpression,
             SyntaxKind.ImplicitArrayCreationExpression,
+            SyntaxKindEx.WithExpression,
         };
 
         /// <inheritdoc/>

diff --git a/documentation/SA1118.md b/documentation/SA1118.md
@@ -30,7 +30,8 @@ cases:
 * The first parameter may span multiple lines
 * Anonymous methods (including lambda expressions) may span multiple lines
 * Invocation expressions may span multiple lines
-* Object creation expressions may span multiple lines
+* Object and array creation expressions may span multiple lines
+* `with` expressions (C# 9) may span multiple lines
 
 For example, the following code would violate this rule, since the second parameter spans across multiple lines: