Merge pull request #155 from atc-net/feature/dotnet8_upgrade

dotnet8 upgrade

Author: davidkallesen

.editorconfig

@@ -1,8 +1,8 @@
 # ATC coding rules - https://github.com/atc-net/atc-coding-rules
-# Version: 1.0.9
-# Updated: 24-11-2022
+# Version: 1.0.0
+# Updated: 25-09-2023
 # Location: Root
-# Distribution: DotNet7
+# Distribution: DotNet8
 # Inspired by: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/code-style-rule-options
 
 ##########################################
@@ -87,6 +87,7 @@ dotnet_separate_import_directive_groups = false
 # .NET Code Style Settings
 # https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#net-code-style-settings
 [*.{cs,csx,cake}]
+
 # "this." and "Me." qualifiers
 # https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#this-and-me
 dotnet_style_qualification_for_field = false
@@ -146,6 +147,7 @@ dotnet_style_operator_placement_when_wrapping = end_of_line
 # C# Code Style Settings
 # https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#c-code-style-settings
 [*.{cs,csx,cake}]
+
 # Implicit and explicit types
 # https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#implicit-and-explicit-types
 csharp_style_var_for_built_in_types = true                                      # IDE0007 and IDE0008
@@ -199,8 +201,8 @@ csharp_style_unused_value_assignment_preference = discard_variable
 
 # Index and range preferences
 # https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#index-and-range-preferences
-csharp_style_prefer_index_operator = true                                       # IDE0056
-csharp_style_prefer_range_operator = true                                       # IDE0057
+csharp_style_prefer_index_operator = true:suggestion                            # IDE0056
+csharp_style_prefer_range_operator = true:suggestion                            # IDE0057
 
 # Miscellaneous preferences
 # https://docs.microsoft.com/visualstudio/ide/editorconfig-language-conventions#miscellaneous-preferences
@@ -448,19 +450,25 @@ dotnet_naming_rule.parameters_rule.severity             = warning
 dotnet_diagnostic.MA0003.severity = suggestion      # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0003.md
 dotnet_diagnostic.MA0004.severity = suggestion      # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0004.md
 dotnet_diagnostic.MA0006.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0006.md
+dotnet_diagnostic.MA0011.severity = none            # Duplicate of CA1305
 dotnet_diagnostic.MA0016.severity = error           # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0016.md
 dotnet_diagnostic.MA0025.severity = suggestion      # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0025.md
 dotnet_diagnostic.MA0026.severity = suggestion      # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0026.md
 dotnet_diagnostic.MA0028.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0028.md
+dotnet_diagnostic.MA0038.severity = none            # Duplicate of CA1822
 dotnet_diagnostic.MA0048.severity = error           # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/Meziantou/MA0048.md
 
 
 # Microsoft - Code Analysis
 # https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/quality-rules/
 dotnet_diagnostic.CA1014.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/CA1014.md
 dotnet_diagnostic.CA1068.severity = error           # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/CA1068.md
+dotnet_diagnostic.CA1305.severity = error
 dotnet_diagnostic.CA1707.severity = error           # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/CA1707.md
+dotnet_diagnostic.CA1812.severity = none
+dotnet_diagnostic.CA1822.severity = suggestion
 dotnet_diagnostic.CA2007.severity = suggestion      # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/CA2007.md
+dotnet_diagnostic.IDE0005.severity = warning        # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/IDE0005.md
 dotnet_diagnostic.IDE0058.severity = none           # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/MicrosoftCodeAnalysis/IDE0058.md
 
 
@@ -485,6 +493,7 @@ dotnet_diagnostic.SA1202.severity = none            # https://github.com/atc-net
 dotnet_diagnostic.SA1204.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/StyleCop/SA1204.md
 dotnet_diagnostic.SA1413.severity = error           # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/StyleCop/SA1413.md
 dotnet_diagnostic.SA1600.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/StyleCop/SA1600.md
+dotnet_diagnostic.SA1601.severity = none
 dotnet_diagnostic.SA1602.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/StyleCop/SA1602.md
 dotnet_diagnostic.SA1604.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/StyleCop/SA1604.md
 dotnet_diagnostic.SA1623.severity = none            # https://github.com/atc-net/atc-coding-rules/blob/main/documentation/CodeAnalyzersRules/StyleCop/SA1623.md
@@ -511,6 +520,8 @@ dotnet_diagnostic.IDE0057.severity = none           # Substring can be simplifie
 
 dotnet_diagnostic.CA1054.severity = none            # URI parameters should not be strings
 dotnet_diagnostic.CA1848.severity = none            # For improved performance, use the LoggerMessage delegates instead of calling 'LoggerExtensions.LogTrace(ILogger, string, params object[])'
+dotnet_diagnostic.CA1859.severity = none            #
+dotnet_diagnostic.CA1860.severity = none            #
 dotnet_diagnostic.CA2007.severity = none            # Consider calling ConfigureAwait on the awaited task
 dotnet_diagnostic.CA2254.severity = none            # For improved performance, use the LoggerMessage delegates instead of calling 'LoggerExtensions.LogTrace(ILogger, string, params object[])'
 
@@ -520,4 +531,13 @@ dotnet_diagnostic.MA0075.severity = none            # Do not use implicit cultur
 dotnet_diagnostic.MA0076.severity = none            # Do not use implicit culture-sensitive ToString in interpolated strings
 
 dotnet_diagnostic.S1172.severity = none             # False positive
-dotnet_diagnostic.S4457.severity = none             # Split this method into two, one handling parameters check and the other handling the asynchronous code
+dotnet_diagnostic.S2589.severity = none             #
+dotnet_diagnostic.S2629.severity = none             #
+dotnet_diagnostic.S3267.severity = none             #
+dotnet_diagnostic.S3878.severity = none             #
+dotnet_diagnostic.S4457.severity = none             # Split this method into two, one handling parameters check and the other handling the asynchronous code
+dotnet_diagnostic.S6602.severity = none             #
+dotnet_diagnostic.S6605.severity = none             #
+dotnet_diagnostic.S6618.severity = none             #
+dotnet_diagnostic.S6667.severity = none             #
+dotnet_diagnostic.S6608.severity = none             #

.github/workflows/atc-coding-rules-update.yml

@@ -2,7 +2,7 @@ name: "ATC-rules-update"
 
 on:
   workflow_dispatch:
-  schedule: 
+  schedule:
   - cron: '0 20 * * 0'
 
 jobs:
@@ -24,7 +24,7 @@ jobs:
     - name: '⚙ Install ATC Coding Rules updater'
       run: dotnet tool install --global atc-coding-rules-updater
     - name: ♻️ Run ATC Coding Rules updater
-      run: atc-coding-rules-updater run --projectPath . --verbose --projectTarget DotNet6 --useTemporarySuppressions
+      run: atc-coding-rules-updater run --projectPath . --verbose --projectTarget DotNet8 --useTemporarySuppressions
     - name: 🐛 Git - show changes
       shell: bash
       run: |

.github/workflows/post-integration.yml

@@ -30,10 +30,10 @@ jobs:
         with:
           setAllVars: true
 
-      - name: ⚙️ Setup dotnet 6.0.x
+      - name: ⚙️ Setup dotnet 8.0.x
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
 
       - name: ⚙️ Set up JDK 17
         uses: actions/setup-java@v3

.github/workflows/pre-integration.yml

@@ -19,10 +19,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: ⚙️ Setup dotnet 6.0.x
+      - name: ⚙️ Setup dotnet 8.0.x
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
 
       - name: 🧹 Clean
         run: dotnet clean -c Release && dotnet nuget locals all --clear
@@ -43,10 +43,10 @@ jobs:
         with:
           fetch-depth: 0
 
-      - name: ⚙️ Setup dotnet 6.0.x
+      - name: ⚙️ Setup dotnet 8.0.x
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
 
       - name: 🔁 Restore packages
         run: dotnet restore

.github/workflows/release.yml

@@ -27,10 +27,10 @@ jobs:
         with:
           setAllVars: true
 
-      - name: ⚙️ Setup dotnet 6.0.x
+      - name: ⚙️ Setup dotnet 8.0.x
         uses: actions/setup-dotnet@v1
         with:
-          dotnet-version: '6.0.x'
+          dotnet-version: '8.0.x'
 
       - name: 🧹 Clean
         run: dotnet clean -c Release && dotnet nuget locals all --clear

Directory.Build.props

@@ -16,9 +16,9 @@
 
   <PropertyGroup Label="Compile settings">
     <Nullable>enable</Nullable>
-    <LangVersion>10.0</LangVersion>
+    <LangVersion>12.0</LangVersion>
     <ImplicitUsings>enable</ImplicitUsings>
-    <TargetFramework>net6.0</TargetFramework>
+    <TargetFramework>net8.0</TargetFramework>
     <GenerateDocumentationFile>true</GenerateDocumentationFile>
     <NoWarn>1573,1591,1712,CA1014</NoWarn>
 
@@ -43,10 +43,10 @@
   <ItemGroup Label="Code Analyzers">
     <PackageReference Include="AsyncFixer" Version="1.6.0" PrivateAssets="All" />
     <PackageReference Include="Asyncify" Version="0.9.7" PrivateAssets="All" />
-    <PackageReference Include="Meziantou.Analyzer" Version="1.0.756" PrivateAssets="All" />
+    <PackageReference Include="Meziantou.Analyzer" Version="2.0.146" PrivateAssets="All" />
     <PackageReference Include="SecurityCodeScan.VS2019" Version="5.6.7" PrivateAssets="All" />
     <PackageReference Include="StyleCop.Analyzers" Version="1.2.0-beta.435" PrivateAssets="All" />
-    <PackageReference Include="SonarAnalyzer.CSharp" Version="8.49.0.57237" PrivateAssets="All" />
+    <PackageReference Include="SonarAnalyzer.CSharp" Version="9.23.0.88079" PrivateAssets="All" />
   </ItemGroup>
 
 </Project>

README.md

@@ -7,22 +7,39 @@ This repository contains a CLI tool, which can be used to maintain `coding-rules
 * Read about [atc-coding-rules](https://github.com/atc-net/atc-coding-rules)
 * Master rule files [information](https://github.com/atc-net/atc-coding-rules/tree/main/distribution)
 
-## Breaking changes
-
-![](https://img.shields.io/static/v1?color=ff9900&style=for-the-badge&label=&message=Breaking%20changes%20From%20Version%201.x%20to%202.x)
-
-```powershell
- * Options Parameter Change: -r | --rootPath has changed to -p | --projectPath
- * CLI Tool now requires the "run" command to update rule-files
- ```
+## Table of Contents
+- [ATC-NET Coding rules updater](#atc-net-coding-rules-updater)
+  - [Table of Contents](#table-of-contents)
+  - [CLI Tool](#cli-tool)
+    - [Requirements](#requirements)
+    - [Installation](#installation)
+    - [Update](#update)
+    - [Usage](#usage)
+      - [Option --help](#option---help)
+      - [Command run](#command-run)
+      - [Command sanity-check](#command-sanity-check)
+      - [Command options-file](#command-options-file)
+    - [Example](#example)
+  - [Options file schema / example](#options-file-schema--example)
+    - [atc-coding-rules-updater.json example 1](#atc-coding-rules-updaterjson-example-1)
+    - [atc-coding-rules-updater.json example 2](#atc-coding-rules-updaterjson-example-2)
+    - [atc-coding-rules-updater.json default](#atc-coding-rules-updaterjson-default)
+  - [CLI Tool Usage from powershell](#cli-tool-usage-from-powershell)
+  - [Deep dive in what `atc-coding-rules-updater` actual does and doesn't do](#deep-dive-in-what-atc-coding-rules-updater-actual-does-and-doesnt-do)
+    - [A use case-scenario for coding rules structure setups - Scenario A](#a-use-case-scenario-for-coding-rules-structure-setups---scenario-a)
+    - [A use case-scenario for coding rules structure setups - Scenario B](#a-use-case-scenario-for-coding-rules-structure-setups---scenario-b)
+    - [For both use-case scenarios](#for-both-use-case-scenarios)
+  - [Temporary suppressions](#temporary-suppressions)
+    - [Build](#build)
+  - [How to contribute](#how-to-contribute)
 
 ## CLI Tool
 
 The Atc.CodingRules.Updater.CLI library is available through a cross platform command line application.
 
 ### Requirements
 
-* [.NET 6 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/6.0)
+* [.NET 8 SDK](https://dotnet.microsoft.com/en-us/download/dotnet/8.0)
 
 ### Installation
 

atc-coding-rules-updater.json

@@ -1,5 +1,5 @@
 {
-	"projectTarget": "DotNet6",
+	"projectTarget": "DotNet8",
 	"mappings": {
 		"src": { "paths": [ "src" ] },
 		"test": { "paths": [ "test" ] }

sample/atc-coding-rules-updater.json

@@ -1,5 +1,5 @@
 {
-  "projectTarget": "DotNet6",
+  "projectTarget": "DotNet8",
   "useLatestMinorNugetVersion": true,
   "useTemporarySuppressions": false,
   "temporarySuppressionAsExcel": false,

src/.editorconfig

@@ -1,8 +1,8 @@
 # ATC coding rules - https://github.com/atc-net/atc-coding-rules
-# Version: 1.0.9
-# Updated: 24-11-2022
+# Version: 1.0.0
+# Updated: 25-09-2023
 # Location: src
-# Distribution: DotNet7
+# Distribution: DotNet8
 # Inspired by: https://docs.microsoft.com/en-us/dotnet/fundamentals/code-analysis/code-style-rule-options
 
 ##########################################