Merge pull request #3879 from 6bee/fix/3803

sharwell · web-flow · commit 73af9b468e35 · 2025-11-24T07:29:45.000-08:00
Exempt file-local types from SA1402 [resolves #3803]
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForClassCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForClassCSharp11UnitTests.cs
@@ -3,9 +3,48 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForClassCSharp11UnitTests : SA1402ForClassCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local class types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalClassExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public class TestClass1 { }
+
+file class TestClass2 { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
+
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local static class types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalStaticClassExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public class TestClass1 { }
+
+file static class TestClass2 { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForDelegateCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForDelegateCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForDelegateCSharp11UnitTests : SA1402ForDelegateCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local delegate types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalDelegateExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public class TestClass { }
+
+file delegate void TestDelegate();
+";
+
+            await VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForEnumCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForEnumCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForEnumCSharp11UnitTests : SA1402ForEnumCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local enum types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalEnumExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public class TestClass1 { }
+
+file enum TestEnum { }
+";
+
+            await VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForInterfaceCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForInterfaceCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForInterfaceCSharp11UnitTests : SA1402ForInterfaceCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local interface types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalInterfaceExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public interface TestInterface1 { }
+
+file interface TestInterface2 { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForRecordCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForRecordCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForRecordCSharp11UnitTests : SA1402ForRecordCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local record types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalRecordExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public record TestRecord1 { }
+
+file record TestRecord2 { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForRecordClassCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForRecordClassCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForRecordClassCSharp11UnitTests : SA1402ForRecordClassCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local record class types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalRecordClassExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public class TestClass { }
+
+file record class TestRecordClass { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForRecordStructCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForRecordStructCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForRecordStructCSharp11UnitTests : SA1402ForRecordStructCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local record struct types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalRecordStructExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public class TestClass { }
+
+file record struct TestRecordStruct { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForStructCSharp11UnitTests.cs b/StyleCop.Analyzers/StyleCop.Analyzers.Test.CSharp11/MaintainabilityRules/SA1402ForStructCSharp11UnitTests.cs
@@ -3,9 +3,30 @@
 
 namespace StyleCop.Analyzers.Test.CSharp11.MaintainabilityRules
 {
+    using System.Threading;
+    using System.Threading.Tasks;
+    using Microsoft.CodeAnalysis.Testing;
     using StyleCop.Analyzers.Test.CSharp10.MaintainabilityRules;
+    using Xunit;
 
     public partial class SA1402ForStructCSharp11UnitTests : SA1402ForStructCSharp10UnitTests
     {
+        /// <summary>
+        /// Verifies that SA1402 is not reported for file-local struct types.
+        /// </summary>
+        /// <returns>A <see cref="Task"/> representing the asynchronous unit test.</returns>
+        [Fact]
+        [WorkItem(3803, "https://github.com/DotNetAnalyzers/StyleCopAnalyzers/issues/3803")]
+        public async Task VerifyFileLocalStructExemptionAsync()
+        {
+            var testCode = @"namespace TestNamespace;
+
+public struct TestStruct1 { }
+
+file struct TestStruct2 { }
+";
+
+            await this.VerifyCSharpDiagnosticAsync(testCode, this.GetSettings(), DiagnosticResult.EmptyDiagnosticResults, CancellationToken.None).ConfigureAwait(false);
+        }
     }
 }
diff --git a/StyleCop.Analyzers/StyleCop.Analyzers/MaintainabilityRules/SA1402FileMayOnlyContainASingleType.cs b/StyleCop.Analyzers/StyleCop.Analyzers/MaintainabilityRules/SA1402FileMayOnlyContainASingleType.cs
@@ -108,8 +108,13 @@ private static bool ContainsTopLevelTypeDeclarations(SyntaxNode node)
             return node.IsKind(SyntaxKind.CompilationUnit) || node.IsKind(SyntaxKind.NamespaceDeclaration) || node.IsKind(SyntaxKindEx.FileScopedNamespaceDeclaration);
         }
 
-        private static bool IsRelevantType(SyntaxNode node, StyleCopSettings settings)
+        private static bool IsRelevantType(MemberDeclarationSyntax node, StyleCopSettings settings)
         {
+            if (IsFileLocalType(node))
+            {
+                return false;
+            }
+
             var topLevelTypes = settings.MaintainabilityRules.TopLevelTypes;
             var isRelevant = false;
 
@@ -136,5 +141,10 @@ private static bool IsRelevantType(SyntaxNode node, StyleCopSettings settings)
 
             return isRelevant;
         }
+
+        private static bool IsFileLocalType(MemberDeclarationSyntax node)
+        {
+            return node.GetModifiers().Any(SyntaxKindEx.FileKeyword);
+        }
     }
 }
diff --git a/documentation/SA1402.md b/documentation/SA1402.md
@@ -27,6 +27,8 @@ It is possible to configure which kind of types this rule should affect. By defa
 
 It is also possible to place multiple parts of the same partial type within the same file.
 
+File-local types declared using `file` modifier are exempt from this rule.
+
 ## How to fix violations
 
 To fix an instance of this violation, move each type into its own file.

Original file line number	Diff line number	Diff line change
`@@ -108,8 +108,13 @@ private static bool ContainsTopLevelTypeDeclarations(SyntaxNode node)`
`108`	`108`	`return node.IsKind(SyntaxKind.CompilationUnit) \|\| node.IsKind(SyntaxKind.NamespaceDeclaration) \|\| node.IsKind(SyntaxKindEx.FileScopedNamespaceDeclaration);`
`109`	`109`	`}`
`110`	`110`
`111`		`- private static bool IsRelevantType(SyntaxNode node, StyleCopSettings settings)`
	`111`	`+ private static bool IsRelevantType(MemberDeclarationSyntax node, StyleCopSettings settings)`
`112`	`112`	`{`
	`113`	`+ if (IsFileLocalType(node))`
	`114`	`+ {`
	`115`	`+ return false;`
	`116`	`+ }`
	`117`	`+`
`113`	`118`	`var topLevelTypes = settings.MaintainabilityRules.TopLevelTypes;`
`114`	`119`	`var isRelevant = false;`
`115`	`120`
`@@ -136,5 +141,10 @@ private static bool IsRelevantType(SyntaxNode node, StyleCopSettings settings)`
`136`	`141`
`137`	`142`	`return isRelevant;`
`138`	`143`	`}`
	`144`	`+`
	`145`	`+ private static bool IsFileLocalType(MemberDeclarationSyntax node)`
	`146`	`+ {`
	`147`	`+ return node.GetModifiers().Any(SyntaxKindEx.FileKeyword);`
	`148`	`+ }`
`139`	`149`	`}`
`140`	`150`	`}`