QOL improvements

Author: neoscie

.github/workflows/create-release.yml

@@ -3,15 +3,6 @@ name: Create Release
 on:
   workflow_dispatch:
     inputs:
-      version_type:
-        type: choice
-        description: Semantic Version Type
-        options:
-          - automatic
-          - patch
-          - minor
-          - major
-
       pre_release:
         type: choice
         description: Stage
@@ -20,6 +11,15 @@ on:
           - rc
           - beta
           - alpha
+          
+      version_type:
+        type: choice
+        description: Semantic Version Type
+        options:
+          - automatic
+          - patch
+          - minor
+          - major
 
 jobs:
   release-it:

.release-it.json

@@ -14,7 +14,7 @@
       "filename": "CHANGELOG.md",
       "addVersionUrl": true,
       "addUnreleased": true,
-      "strictLatest": true
+      "strictLatest": false
     }
   },
   "hooks": {

CHANGELOG.md

@@ -11,7 +11,7 @@ and adheres to a project-specific [Versioning](/README.md).
 
 ### Changed
 
-- Stopped changing all rules to error first and instead use the default rulesets of the Analyzers as the base ru
+- Stopped changing all rules to error first and instead use the default rulesets of the Analyzers as the base rules
 - Migrate from \*.ruleset files to \*.globalconfig files
 - Migrate from \*.targets to \*. props files
 - Simplified and decluttered README file

Neolution.CodeAnalysis.TestsRuleset.nuspec

@@ -18,7 +18,8 @@
   </metadata>
   <files>
     <file src="build\Neolution.CodeAnalysis.TestsRuleset.props" target="build\Neolution.CodeAnalysis.TestsRuleset.props" />
-    <file src="build\Neolution.Tests.globalconfig" target="build\Neolution.Tests.globalconfig" />
+    <file src="build\Neolution.CodeAnalysis.globalconfig" target="build\Neolution.CodeAnalysis.globalconfig" />
+    <file src="build\Neolution.CodeAnalysis.TestsRuleset.globalconfig" target="build\Neolution.CodeAnalysis.TestsRuleset.globalconfig" />
     <file src="build\stylecop.json" target="build\stylecop.json" />
     <file src="README.md" target="docs\" />
   </files>

Neolution.CodeAnalysis.nuspec

@@ -18,7 +18,7 @@
   </metadata>
   <files>
     <file src="build\Neolution.CodeAnalysis.props" target="build\Neolution.CodeAnalysis.props" />
-    <file src="build\Neolution.globalconfig" target="build\Neolution.globalconfig" />
+    <file src="build\Neolution.CodeAnalysis.globalconfig" target="build\Neolution.CodeAnalysis.globalconfig" />
     <file src="build\stylecop.json" target="build\stylecop.json" />
     <file src="README.md" target="docs\" />
   </files>

build/Neolution.CodeAnalysis.TestsRuleset.globalconfig

@@ -0,0 +1,42 @@
+# Top level entry required to mark this as a global AnalyzerConfig file
+# NOTE: Do not create section headers for configuration entries
+is_global = true
+
+# For conflicting rules, the higher level has higher priority 
+global_level = 101
+
+#############################################
+########## Rules specific to tests ##########
+#############################################
+
+# CA1707: Identifiers should not contain underscores
+; We use underscores in test method names to make them easier to read.
+dotnet_diagnostic.CA1707.severity = none
+
+# CA1031: Do not catch general exception types
+; Since we can raise any Exception we like In Tests we should also be able to catch any Exception we like.
+dotnet_diagnostic.CA1031.severity = none
+
+# CA2000: Dispose objects before losing scope
+; Tests are never run continuously in a production environment. Resources are freed as soon as the Test run ends, so there is no need to worry about the pitfalls of not freeing resources.
+dotnet_diagnostic.CA2000.severity = none
+
+# CA2007: Consider calling ConfigureAwait on the awaited task
+; This warning is intended for libraries, where the code may be executed in arbitrary environments and where code shouldn't make assumptions about the environment or how the caller of the method may be invoking or waiting on it
+dotnet_diagnostic.CA2007.severity = none
+
+# S112: General exceptions should never be thrown
+; In Tests we should be able to raise any Exception we like.
+dotnet_diagnostic.S112.severity = none
+
+# S131: "switch/Select" statements should contain a "default/Case Else" clauses
+; There is no need for defensive programming in Tests
+dotnet_diagnostic.S131.severity = none
+
+# S126: "if ... else if" constructs should end with "else" clauses
+; There is no need for defensive programming in Tests
+dotnet_diagnostic.S126.severity = none
+
+# S4581: "new Guid()" should not be used
+; When creating mocks/substitutes this can be irrelevant, so it should not break the build
+dotnet_diagnostic.S4581.severity = suggestion

build/Neolution.CodeAnalysis.TestsRuleset.props

@@ -10,7 +10,8 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <GlobalAnalyzerConfigFiles Include="$(MSBuildThisFileDirectory)Neolution.Tests.globalconfig" />
+    <GlobalAnalyzerConfigFiles Include="$(MSBuildThisFileDirectory)Neolution.CodeAnalysis.globalconfig" Link=".globalconfig" />
+    <GlobalAnalyzerConfigFiles Include="$(MSBuildThisFileDirectory)Neolution.CodeAnalysis.TestsRuleset.globalconfig" Link=".tests.globalconfig" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Link="stylecop.json" />
   </ItemGroup>
 

build/Neolution.globalconfig build/Neolution.CodeAnalysis.globalconfigbuild/Neolution.globalconfig renamed to build/Neolution.CodeAnalysis.globalconfig

@@ -2,6 +2,9 @@
 # NOTE: Do not create section headers for configuration entries
 is_global = true
 
+# For conflicting rules, the higher level has higher priority 
+global_level = 100
+
 # Literals should not be passed as localized parameters
 ; Localization is not needed in every project and for every message. This rule disallows string literals everywhere e.g. for log messages, content that does not need to be translated etc.
 dotnet_diagnostic.S4055.severity = none
@@ -226,6 +229,11 @@ dotnet_diagnostic.CA2007.severity = warning
 ; Exceptions can be configured in stylecop.json
 dotnet_diagnostic.SA1412.severity = warning
 
+# S113: Files should contain an empty newline at the end
+; Some tools (e.g. Git Diff) work better when files end with an empty line.
+dotnet_diagnostic.S113.severity = warning
+dotnet_diagnostic.SA1518.severity = none
+
 # S107: Methods should not have too many parameters
 dotnet_diagnostic.S107.severity = warning
 
@@ -274,9 +282,6 @@ dotnet_diagnostic.S110.severity = warning
 # S1109: A close curly brace should be located at the beginning of a line
 dotnet_diagnostic.S1109.severity = warning
 
-# S113: Files should contain an empty newline at the end
-dotnet_diagnostic.S113.severity = warning
-
 # S1144: Unused private types or members should be removed
 dotnet_diagnostic.S1144.severity = warning
 

build/Neolution.CodeAnalysis.props

@@ -10,7 +10,7 @@
   </PropertyGroup>
 
   <ItemGroup>
-    <GlobalAnalyzerConfigFiles Include="$(MSBuildThisFileDirectory)Neolution.globalconfig" />
+    <GlobalAnalyzerConfigFiles Include="$(MSBuildThisFileDirectory)Neolution.CodeAnalysis.globalconfig" Link=".globalconfig" />
     <AdditionalFiles Include="$(MSBuildThisFileDirectory)stylecop.json" Link="stylecop.json" />
   </ItemGroup>