From 0e1f6fc69b3be70208b5099d3634c943760c0f97 Mon Sep 17 00:00:00 2001
From: James Jackson-South <james_south@hotmail.com>
Date: Fri, 20 Nov 2020 00:02:05 +0000
Subject: [PATCH] Remove rulset noise and allow further customization

---
 linting/codeanalysis.ruleset         | 26 +++++++++++++
 linting/codeanalysis.tests.ruleset   | 57 ++++++++++++++++++++++++++++
 src/Umbraco.Core/Umbraco.Core.csproj | 27 +++++++------
 src/umbraco-netcore-only.sln         |  4 ++
 src/umbraco.sln                      |  2 +
 5 files changed, 104 insertions(+), 12 deletions(-)
 create mode 100644 linting/codeanalysis.ruleset
 create mode 100644 linting/codeanalysis.tests.ruleset

diff --git a/linting/codeanalysis.ruleset b/linting/codeanalysis.ruleset
new file mode 100644
index 0000000000..e4a1e8fe83
--- /dev/null
+++ b/linting/codeanalysis.ruleset
@@ -0,0 +1,26 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="CodeAnalysis" ToolsVersion="15.0">
+  <Rules AnalyzerId="Roslynator.CSharp.Analyzers" RuleNamespace="Roslynator.CSharp">
+
+    <!--Call 'ConfigureAwait(false)'-->
+    <Rule Id="RCS1090" Action="None" />
+  </Rules>
+
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+
+    <!--Using directive should appear within a namespace declaration-->
+    <Rule Id="SA1200" Action="None" />
+
+    <!--A C# code file contains more than one unique type.-->
+    <Rule Id="SA1402" Action="None" />
+
+    <!--The last statement in a multi-line C# initializer or list is missing a trailing comma.-->
+    <Rule Id="SA1413" Action="None" />
+
+    <!--Comments should end with a period.-->
+    <Rule Id="SA1629" Action="None" />
+
+    <!--A C# code file is missing a standard file header.-->
+    <Rule Id="SA1633" Action="Warning" />
+  </Rules>
+</RuleSet>
diff --git a/linting/codeanalysis.tests.ruleset b/linting/codeanalysis.tests.ruleset
new file mode 100644
index 0000000000..7074c8c25b
--- /dev/null
+++ b/linting/codeanalysis.tests.ruleset
@@ -0,0 +1,57 @@
+<?xml version="1.0" encoding="utf-8"?>
+<RuleSet Name="CodeAnalysis.Tests" ToolsVersion="15.0">
+  <!--Inherit basic rules-->
+  <Include Path="codeanalysis.ruleset" Action="Default" />
+
+  <!--Additional rules-->
+  <Rules AnalyzerId="StyleCop.Analyzers" RuleNamespace="StyleCop.Analyzers">
+
+    <!--XML comment analysis is disabled due to project configuration-->
+    <Rule Id="SA0001" Action="None" />
+
+    <!--Parameter must follow comma.-->
+    <Rule Id="SA1115" Action="None" />
+
+    <!--A field should not follow a method-->
+    <Rule Id="SA1201" Action="None" />
+
+    <!--Elements must be ordered by access-->
+    <Rule Id="SA1202" Action="None" />
+
+    <!--Constants must appear before fields-->
+    <Rule Id="SA1203" Action="None" />
+
+    <!--Static members should appear before non-static members-->
+    <Rule Id="SA1204" Action="None" />
+
+    <!--Field names must not contain underscore-->
+    <Rule Id="SA1310" Action="None" />
+
+    <!--Field should be private-->
+    <Rule Id="SA1401" Action="None" />
+
+    <!--Elements should be documented.-->
+    <Rule Id="SA1600" Action="None" />
+
+    <!--Partial elements should be documented.-->
+    <Rule Id="SA1601" Action="None" />
+
+    <!--Enumeration items should be documented.-->
+    <Rule Id="SA1602" Action="None" />
+
+    <!--Constructor is missing documentation for one or more of its parameters.-->
+    <Rule Id="SA1611" Action="None" />
+
+    <!--A generic C# element is missing documentation for one or more of its generic type parameters..-->
+    <Rule Id="SA1618" Action="None" />
+
+    <!--The XML documentation header for a C# constructor does not contain the appropriate summary text.-->
+    <Rule Id="SA1642" Action="None" />
+  </Rules>
+
+  <Rules AnalyzerId="Microsoft.CodeAnalysis.CSharp" RuleNamespace="Microsoft.CodeAnalysis.CSharp">
+
+      <!--Missing XML comment for publicly visible type or member-->
+    <Rule Id="CS1591" Action="None" />
+  </Rules>
+</RuleSet>
diff --git a/src/Umbraco.Core/Umbraco.Core.csproj b/src/Umbraco.Core/Umbraco.Core.csproj
index 5a7aa3ba9b..8f9282be55 100644
--- a/src/Umbraco.Core/Umbraco.Core.csproj
+++ b/src/Umbraco.Core/Umbraco.Core.csproj
@@ -7,7 +7,7 @@
         <AssemblyVersion>0.5.0</AssemblyVersion>
         <InformationalVersion>0.5.0</InformationalVersion>
         <FileVersion>0.5.0</FileVersion>
-        <Product>Umbraco CMS</Product>       
+        <Product>Umbraco CMS</Product>
     </PropertyGroup>
 
     <PropertyGroup Condition=" '$(Configuration)' == 'Release' ">
@@ -15,17 +15,17 @@
     </PropertyGroup>
 
     <ItemGroup>
-      <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.1.8" />
-      <PackageReference Include="Microsoft.Extensions.Logging" Version="3.1.8" />
-      <PackageReference Include="Microsoft.Extensions.Options" Version="3.1.8" />
-      <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
-        <PrivateAssets>all</PrivateAssets>
-        <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
-      </PackageReference>
-      <PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />
-      <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.7.0" />
-      <PackageReference Include="System.Reflection.Emit.Lightweight" Version="4.7.0" />
-      <PackageReference Include="System.Runtime.Caching" Version="4.7.0" />
+        <PackageReference Include="Microsoft.Extensions.Configuration.Abstractions" Version="3.1.8" />
+        <PackageReference Include="Microsoft.Extensions.Logging" Version="3.1.8" />
+        <PackageReference Include="Microsoft.Extensions.Options" Version="3.1.8" />
+        <PackageReference Include="StyleCop.Analyzers" Version="1.1.118">
+            <PrivateAssets>all</PrivateAssets>
+            <IncludeAssets>runtime; build; native; contentfiles; analyzers; buildtransitive</IncludeAssets>
+        </PackageReference>
+        <PackageReference Include="System.ComponentModel.Annotations" Version="4.7.0" />
+        <PackageReference Include="System.Configuration.ConfigurationManager" Version="4.7.0" />
+        <PackageReference Include="System.Reflection.Emit.Lightweight" Version="4.7.0" />
+        <PackageReference Include="System.Runtime.Caching" Version="4.7.0" />
     </ItemGroup>
 
     <ItemGroup>
@@ -36,6 +36,9 @@
         <EditorConfigFiles Include="..\..\linting\.editorconfig" Link=".editorconfig"/>
         <AdditionalFiles Include="..\..\linting\stylecop.json" />
     </ItemGroup>
+    <PropertyGroup>
+        <CodeAnalysisRuleSet>..\..\linting\codeanalysis.ruleset</CodeAnalysisRuleSet>
+    </PropertyGroup>
 
     <ItemGroup>
         <AssemblyAttribute Include="System.Runtime.CompilerServices.InternalsVisibleTo">
diff --git a/src/umbraco-netcore-only.sln b/src/umbraco-netcore-only.sln
index f9e749c59d..08c1ec42d0 100644
--- a/src/umbraco-netcore-only.sln
+++ b/src/umbraco-netcore-only.sln
@@ -5,10 +5,14 @@ VisualStudioVersion = 16.0.29209.152
 MinimumVisualStudioVersion = 10.0.40219.1
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{2849E9D4-3B4E-40A3-A309-F3CB4F0E125F}"
 	ProjectSection(SolutionItems) = preProject
+		..\linting\.editorconfig = ..\linting\.editorconfig
 		..\build\build-bootstrap.ps1 = ..\build\build-bootstrap.ps1
 		..\build\build.ps1 = ..\build\build.ps1
 		..\NuGet.Config = ..\NuGet.Config
 		SolutionInfo.cs = SolutionInfo.cs
+		..\linting\stylecop.json = ..\linting\stylecop.json
+		..\linting\codeanalysis.ruleset = ..\linting\codeanalysis.ruleset
+		..\linting\codeanalysis.tests.ruleset = ..\linting\codeanalysis.tests.ruleset
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{FD962632-184C-4005-A5F3-E705D92FC645}"
diff --git a/src/umbraco.sln b/src/umbraco.sln
index 40772b74f1..ab7bfae3ec 100644
--- a/src/umbraco.sln
+++ b/src/umbraco.sln
@@ -13,6 +13,8 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Build", "Build", "{2849E9D4
 		..\NuGet.Config = ..\NuGet.Config
 		SolutionInfo.cs = SolutionInfo.cs
 		..\linting\stylecop.json = ..\linting\stylecop.json
+		..\linting\codeanalysis.ruleset = ..\linting\codeanalysis.ruleset
+		..\linting\codeanalysis.tests.ruleset = ..\linting\codeanalysis.tests.ruleset
 	EndProjectSection
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "Docs", "Docs", "{FD962632-184C-4005-A5F3-E705D92FC645}"