Migrate from FxCop to .NET Analyzers

.editorconfig

@@ -134,11 +134,31 @@ dotnet_diagnostic.CA1062.severity = suggestion
 dotnet_code_quality.CA1062.exclude_extension_method_this_parameter = true
 dotnet_code_quality.exclude_extension_method_this_parameter = true
 dotnet_code_quality.null_check_validation_methods = ThrowIfArgumentIsNull
+# CA1031: Do not catch general exception types
+dotnet_diagnostic.CA1031.severity = none
+# CA1303: Do not pass literals as localized parameters
+dotnet_diagnostic.CA1303.severity = none
+# CA1304: Specify CultureInfo
 dotnet_diagnostic.CA1304.severity = error
+# CA1307: Specify StringComparison for clarity
 dotnet_diagnostic.CA1307.severity = error
+# CA1308: Normalize strings to uppercase
 dotnet_diagnostic.CA1308.severity = error
+# CA1309: Use ordinal StringComparison
 dotnet_diagnostic.CA1309.severity = error
+# CA1724: Type names should not match namespaces
+dotnet_diagnostic.CA1724.severity = none
+# CA1819: Properties should not return arrays
+dotnet_diagnostic.CA1819.severity = none
+# CA1851: Possible multiple enumerations of IEnumerable collection. Related to GH-issue #2000
+dotnet_diagnostic.CA1851.severity = suggestion
+# CA2007: Do not directly await a Task
+dotnet_diagnostic.CA2007.severity = none
+# CA2225: Operator overloads have named alternates
+dotnet_diagnostic.CA2225.severity = none
+# CA3075: Insecure DTD Processing
 dotnet_diagnostic.CA3075.severity = none
+# CA5369: Use XmlReader for Deserialize
 dotnet_diagnostic.CA5369.severity = none
 
 # Banned API Analyzers
@@ -317,6 +337,10 @@ dotnet_diagnostic.RCS1124.severity = suggestion
 # Add exception to documentation comment. Nice suggestion, but we don't want to document exceptions for internal code.
 dotnet_diagnostic.RCS1140.severity = suggestion
 
+# Missing documentation
+dotnet_diagnostic.RCS1141.severity = suggestion
+dotnet_diagnostic.RCS1142.severity = suggestion
+
 # Use conditional access. Suggestion because it doesn't always improve readability
 dotnet_diagnostic.RCS1146.severity = suggestion
 

Build/.editorconfig

@@ -9,8 +9,16 @@ csharp_style_expression_bodied_properties = true:warning
 csharp_style_expression_bodied_indexers = true:warning
 csharp_style_expression_bodied_accessors = true:warning
 
-dotnet_diagnostic.ide0044.severity = none
-dotnet_diagnostic.ide0051.severity = none
+dotnet_diagnostic.IDE0044.severity = none
+dotnet_diagnostic.IDE0051.severity = none
+dotnet_diagnostic.RCS1110.severity = none
+dotnet_diagnostic.RCS1169.severity = none
+dotnet_diagnostic.S2365.severity = none
+dotnet_diagnostic.S3903.severity = none
+dotnet_diagnostic.SA1009.severity = none
+dotnet_diagnostic.SA1111.severity = none
+dotnet_diagnostic.SA1306.severity = none
+dotnet_diagnostic.SA1400.severity = none
 
 # ReSharper properties
 resharper_place_field_attribute_on_same_line = false

Build/Build.cs

@@ -38,7 +38,9 @@ class Build : NukeBuild
     GitHubActions GitHubActions => GitHubActions.Instance;
 
     string BranchSpec => GitHubActions?.Ref;
+
     string BuildNumber => GitHubActions?.RunNumber.ToString();
+
     string PullRequestBase => GitHubActions?.BaseRef;
 
     [Parameter("Use this parameter if you encounter build problems in any way, " +
@@ -375,7 +377,9 @@ void ReportTestOutcome(params string[] globFilters)
             .ToArray();
 
     Repository Repository => new(GitRepository.LocalDirectory);
+
     Tree TargetBranch => Repository.Branches[PullRequestBase].Tip.Tree;
+
     Tree SourceBranch => Repository.Branches[Repository.Head.FriendlyName].Tip.Tree;
 
     bool RunAllTargets => string.IsNullOrWhiteSpace(PullRequestBase) || Changes.Any(x => x.StartsWith("Build"));

Build/Configuration.cs

@@ -4,9 +4,11 @@
 [TypeConverter(typeof(TypeConverter<Configuration>))]
 public class Configuration : Enumeration
 {
-    public static Configuration Debug = new() { Value = nameof(Debug) };
-    public static Configuration Release = new() { Value = nameof(Release) };
-    public static Configuration CI = new() { Value = nameof(CI) };
+    public static Configuration Debug { get; } = new() { Value = nameof(Debug) };
+
+    public static Configuration Release { get; } = new() { Value = nameof(Release) };
+
+    public static Configuration CI { get; } = new() { Value = nameof(CI) };
 
     public static implicit operator string(Configuration configuration)
     {

Directory.Build.props

@@ -4,4 +4,39 @@
     <CheckEolTargetFramework>false</CheckEolTargetFramework>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
   </PropertyGroup>
+
+  <!-- To reduce build times, we only enable analyzers for the newest TFM -->
+  <PropertyGroup Condition="'$(TargetFramework)' != 'net6.0'">
+    <RunAnalyzersDuringBuild>false</RunAnalyzersDuringBuild>
+    <RunAnalyzersDuringLiveAnalysis>false</RunAnalyzersDuringLiveAnalysis>
+    <RunAnalyzers>false</RunAnalyzers>
+  </PropertyGroup>
+  <PropertyGroup Condition="'$(TargetFramework)' == 'net6.0'">
+    <EnableNETAnalyzers>true</EnableNETAnalyzers>
+    <AnalysisLevel>latest</AnalysisLevel>
+    <AnalysisMode>All</AnalysisMode>
+    <CodeAnalysisTreatWarningsAsErrors>true</CodeAnalysisTreatWarningsAsErrors>
+  </PropertyGroup>
+  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
+    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.3">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Roslynator.Analyzers" Version="4.2.0">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+    <PackageReference Include="Meziantou.Analyzer" Version="2.0.26">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 </Project>

FluentAssertions.sln

@@ -16,6 +16,9 @@ EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "_build", "Build\_build.csproj", "{364DD16C-D759-49DC-A04A-64D40205295B}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Specs", "Specs", "{963262D0-9FD5-4741-8C0E-E2F34F110EF3}"
+	ProjectSection(SolutionItems) = preProject
+		Tests\.editorconfig = Tests\.editorconfig
+	EndProjectSection
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "AssemblyA", "Tests\AssemblyA\AssemblyA.csproj", "{7144BD9D-2A5F-45B6-AC5B-E35578D03350}"
 EndProject

Src/FluentAssertions/CallerIdentifier.cs

@@ -243,7 +243,7 @@ private static bool StartsWithNewKeyword(string candidate)
 
     private static bool IsStringLiteral(string candidate)
     {
-        return candidate.StartsWith("\"", StringComparison.Ordinal);
+        return candidate.StartsWith('\"');
     }
 
     private static bool IsNumeric(string candidate)

Src/FluentAssertions/Common/StringExtensions.cs

@@ -88,7 +88,7 @@ public static string Combine(this string @this, string other, string separator =
             return @this;
         }
 
-        if (other.StartsWith("[", StringComparison.Ordinal))
+        if (other.StartsWith('['))
         {
             separator = string.Empty;
         }

Src/FluentAssertions/CustomAssertionAttribute.cs

@@ -7,6 +7,7 @@ namespace FluentAssertions;
 /// internally, or directly uses the <c>Execute.Assertion</c>.
 /// </summary>
 [AttributeUsage(AttributeTargets.Method)]
+#pragma warning disable CA1813 // Avoid unsealed attributes. This type has shipped.
 public class CustomAssertionAttribute : Attribute
 {
 }

Src/FluentAssertions/Equivalency/SelfReferenceEquivalencyAssertionOptions.cs

@@ -17,6 +17,8 @@
 
 namespace FluentAssertions.Equivalency;
 
+#pragma warning disable CA1033 //An unsealed externally visible type provides an explicit method implementation of a public interface and does not provide an alternative externally visible method that has the same name.
+
 /// <summary>
 /// Represents the run-time behavior of a structural equivalency assertion.
 /// </summary>

Src/FluentAssertions/Execution/LateBoundTestFramework.cs

@@ -16,7 +16,7 @@ public void Throw(string message)
 
         if (exceptionType is null)
         {
-            throw new Exception(
+            throw new NotSupportedException(
                 $"Failed to create the assertion exception for the current test framework: \"{ExceptionFullName}, {assembly.FullName}\"");
         }
 

Src/FluentAssertions/Execution/NSpecFramework.cs

@@ -30,12 +30,8 @@ public bool IsAvailable
     [DoesNotReturn]
     public void Throw(string message)
     {
-        Type exceptionType = assembly.GetType("NSpec.Domain.AssertionException");
-
-        if (exceptionType is null)
-        {
-            throw new Exception("Failed to create the NSpec assertion type");
-        }
+        Type exceptionType = assembly.GetType("NSpec.Domain.AssertionException")
+            ?? throw new NotSupportedException("Failed to create the NSpec assertion type");
 
         throw (Exception)Activator.CreateInstance(exceptionType, message);
     }

Src/FluentAssertions/Execution/XUnit2TestFramework.cs

@@ -32,12 +32,8 @@ public bool IsAvailable
     [DoesNotReturn]
     public void Throw(string message)
     {
-        Type exceptionType = assembly.GetType("Xunit.Sdk.XunitException");
-
-        if (exceptionType is null)
-        {
-            throw new Exception("Failed to create the XUnit assertion type");
-        }
+        Type exceptionType = assembly.GetType("Xunit.Sdk.XunitException")
+            ?? throw new NotSupportedException("Failed to create the XUnit assertion type");
 
         throw (Exception)Activator.CreateInstance(exceptionType, message);
     }

Src/FluentAssertions/FluentAssertions.csproj

@@ -7,7 +7,6 @@
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <NoWarn>1591;1573</NoWarn>
     <GeneratePackageOnBuild>False</GeneratePackageOnBuild>
-    <CodeAnalysisRuleSet>..\..\Rules.ruleset</CodeAnalysisRuleSet>
     <AllowedOutputExtensionsInPackageBuildOutputFolder>$(AllowedOutputExtensionsInPackageBuildOutputFolder);.pdb</AllowedOutputExtensionsInPackageBuildOutputFolder>
     <EmbedUntrackedSources>true</EmbedUntrackedSources>
     <ProduceReferenceAssembly>true</ProduceReferenceAssembly>
@@ -30,11 +29,6 @@
     <PackageReleaseNotes>See https://fluentassertions.com/releases/</PackageReleaseNotes>
     <Copyright>Copyright Dennis Doomen 2010-$([System.DateTime]::Now.ToString(yyyy))</Copyright>
   </PropertyGroup>
-  <PropertyGroup Condition="'$(TargetFramework)' != 'net6.0'">
-    <RunAnalyzersDuringBuild>false</RunAnalyzersDuringBuild>
-    <RunAnalyzersDuringLiveAnalysis>false</RunAnalyzersDuringLiveAnalysis>
-    <RunAnalyzers>false</RunAnalyzers>
-  </PropertyGroup>
   <ItemGroup>
     <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleToAttribute">
       <_Parameter1>FluentAssertions.Specs, PublicKey=00240000048000009400000006020000002400005253413100040000010001002d25ff515c85b13ba08f61d466cff5d80a7f28ba197bbf8796085213e7a3406f970d2a4874932fed35db546e89af2da88c194bf1b7f7ac70de7988c78406f7629c547283061282a825616eb7eb48a9514a7570942936020a9bb37dca9ff60b778309900851575614491c6d25018fadb75828f4c7a17bf2d7dc86e7b6eafc5d8f</_Parameter1>
@@ -100,30 +94,4 @@
     <Reference Include="System.Xml" />
     <Reference Include="System.Xml.Linq" />
   </ItemGroup>
-  <ItemGroup Condition="'$(TargetFramework)' == 'net6.0'">
-    <PackageReference Include="Microsoft.CodeAnalysis.BannedApiAnalyzers" Version="3.3.4">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="Microsoft.CodeAnalysis.FxCopAnalyzers" Version="3.3.1">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="CSharpGuidelinesAnalyzer" Version="3.8.2">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="Roslynator.Analyzers" Version="4.2.0">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-    <PackageReference Include="Meziantou.Analyzer" Version="2.0.26">
-      <PrivateAssets>all</PrivateAssets>
-      <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-    </PackageReference>
-  </ItemGroup>
 </Project>

Src/FluentAssertions/Formatting/ValueFormatterAttribute.cs

@@ -6,6 +6,7 @@ namespace FluentAssertions.Formatting;
 /// Marks a static method as a kind of <see cref="IValueFormatter"/> for a particular type.
 /// </summary>
 [AttributeUsage(AttributeTargets.Method)]
+#pragma warning disable CA1813 // Avoid unsealed attributes. This type has shipped.
 public class ValueFormatterAttribute : Attribute
 {
 }

Src/FluentAssertions/ObjectAssertionsExtensions.cs

@@ -151,11 +151,11 @@ private static object CreateCloneUsingBinarySerializer(object subject)
             Binder = new SimpleBinder(subject.GetType())
         };
 
-#pragma warning disable SYSLIB0011 // BinaryFormatter is obsoleted, GH-issue 1779 tracks the upcoming removal in .NET 8.0
+#pragma warning disable SYSLIB0011, CA2300 // BinaryFormatter is obsoleted, GH-issue 1779 tracks the upcoming removal in .NET 8.0
         binaryFormatter.Serialize(stream, subject);
         stream.Position = 0;
         return binaryFormatter.Deserialize(stream);
-#pragma warning restore SYSLIB0011
+#pragma warning restore SYSLIB0011, CA2300
     }
 
     private sealed class SimpleBinder : SerializationBinder

Src/FluentAssertions/Primitives/ReferenceTypeAssertions.cs

@@ -6,7 +6,7 @@
 
 namespace FluentAssertions.Primitives;
 
-#pragma warning disable CS0659 // Ignore not overriding Object.GetHashCode()
+#pragma warning disable CS0659, S1206 // Ignore not overriding Object.GetHashCode()
 #pragma warning disable CA1065 // Ignore throwing NotSupportedException from Equals
 /// <summary>
 /// Contains a number of methods to assert that a reference type object is in the expected state.

Src/FluentAssertions/Primitives/SimpleTimeSpanAssertions.cs

@@ -18,7 +18,7 @@ public SimpleTimeSpanAssertions(TimeSpan? value)
     }
 }
 
-#pragma warning disable CS0659 // Ignore not overriding Object.GetHashCode()
+#pragma warning disable CS0659, S1206 // Ignore not overriding Object.GetHashCode()
 #pragma warning disable CA1065 // Ignore throwing NotSupportedException from Equals
 /// <summary>
 /// Contains a number of methods to assert that a nullable <see cref="TimeSpan"/> is in the expected state.

Src/FluentAssertions/Primitives/TimeOnlyAssertions.cs

@@ -20,7 +20,7 @@ public TimeOnlyAssertions(TimeOnly? value)
     }
 }
 
-#pragma warning disable CS0659 // Ignore not overriding Object.GetHashCode()
+#pragma warning disable CS0659, S1206 // Ignore not overriding Object.GetHashCode()
 #pragma warning disable CA1065 // Ignore throwing NotSupportedException from Equals
 /// <summary>
 /// Contains a number of methods to assert that a <see cref="TimeOnly"/> is in the expected state.

Src/FluentAssertions/Specialized/ExecutionTimeAssertions.cs

@@ -5,7 +5,7 @@
 
 namespace FluentAssertions.Specialized;
 
-#pragma warning disable CS0659 // Ignore not overriding Object.GetHashCode()
+#pragma warning disable CS0659, S1206 // Ignore not overriding Object.GetHashCode()
 #pragma warning disable CA1065 // Ignore throwing NotSupportedException from Equals
 /// <summary>
 /// Provides methods for asserting that the execution time of an <see cref="Action"/> satisfies certain conditions.