Merge pull request #87 from messerli-informatik-ag/gardening

bash · web-flow · commit 7c97af91fa79 · 2023-07-10T07:46:43.000+02:00
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -13,15 +13,15 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@v2
-    - uses: actions/setup-dotnet@v1
+    - uses: actions/checkout@v3
+    - uses: actions/setup-dotnet@v3
     - name: Install dependencies
       run: dotnet restore
     - name: Build
       run: dotnet build --configuration Release --no-restore
     - name: Pack
       run: dotnet pack CodeStyle/CodeStyle.csproj --configuration Release --no-restore --output nupkg
     - name: Test that files are importable by MSBuild
-      run: ruby ./scripts/test_files_are_importable_by_msbuild.rb
+      run: dotnet fsi scripts/test-files-are-importable-by-msbuild.fsx
     - name: Show NuGet package content
       run: unzip -l nupkg/*.nupkg
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -13,18 +13,33 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v1
+    - uses: actions/checkout@v3
     - name: Setup mdBook
       uses: peaceiris/actions-mdbook@v1
       with:
         mdbook-version: '0.4.0'
     - name: Build Documentation
       run: mdbook build
       working-directory: ./documentation
-    - name: Deploy
-      uses: peaceiris/actions-gh-pages@v3
-      if: success() && github.ref == 'refs/heads/main'
+    - name: Upload GitHub Pages Artifact
+      uses: actions/upload-pages-artifact@v1
       with:
-        github_token: ${{secrets.GITHUB_TOKEN}}
-        publish_dir: ./documentation/book
-        commit_message: ${{github.event.head_commit.message}}
+        path: ./documentation/book
+
+  deploy_pages:
+    needs: build
+    if: github.ref_name == 'main'
+
+    permissions:
+      pages: write
+      id-token: write
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    runs-on: ubuntu-latest
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v2
diff --git a/changelog.md b/changelog.md
@@ -1,48 +1,66 @@
 # Changelog
 
-## 1.0.0-alpha.1
-Initial release
-
-## 1.0.0
-- Add support for netstandard2.0.
-- Add support for projects that target multiple frameworks.
-
-## 1.0.1
-- Hide stylecop.json in Visual Studio.
+## 2.2.0
+* File scoped namespaces are now enforced. (#81)
+* Enable warning for unused usings. (#81)
+* `SA1305: FieldNamesMustNotUseHungarianNotation` has been disabled. (#82)
+* Use warning instead of error level for spacing rules. (#83)
+* Update IDisposableAnalyzers to 4.0.2. Excerpt from [IDisposableAnalyzers Changelog]:
+  > #### 4.0.2
+  > * BUGFIX: IDISP007 when disposing static member in static context
+  > #### 4.0.1
+  > * BUGFIX: IDISP007 false warning when using Rx
+  > * BUGFIX: IDISP016 false warning when foreach
+  > * BUGFIX: Handle leaveOpen when AsyncDisposable
+  > * BUGIX: Handle top level statements.
+  > #### 4.0.0
+  > * BREAKING: For VS2022+ now.
+  > * BUGFIX: AD0001 -> Could not load file or assembly
 
-## 1.1.0
-- Update IDisposableAnalyzers from 3.2.0 to 3.3.2. Excerpt from [IDisposableAnalyzers Changelog]:
-  > #### 3.3.0
-  > - FEATURE: Initial support for AsyncDisposable
+## 2.1.3
+* Update StyleCop.Analyzers to 1.2.0-beta.435 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.376...1.2.0-beta.435))
+    * Most notably this version fixes false positives of `SA1516: Elements should be separated by blank line` in files with top-level statements.
 
-## 1.2.0
-- Disable SA1412 (StoreFilesAsUtf). This means that BOMs are no longer required in C# files.
-- Update IDisposableAnalyzers from 3.3.2 to 3.3.8:
-- Update StyleCop.Analyzers from 1.2.0-beta.113 to 1.2.0-beta.164 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.113...1.2.0-beta.164)).
-- Enable `GenerateDocumentationFile` by default. This had to be turned on manually in each project before,
-  as it is required by our StyleCop configuration.
+## 2.1.2
+* Update StyleCop.Analyzers to 1.2.0-beta.376 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.354...1.2.0-beta.376))
 
-## 1.2.1
-- Update StyleCop.Analyzers to 1.2.0-beta.205. ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.164...1.2.0-beta.205))
-- Update IDisposableAnalyzers to 3.4.1. Excerpt from [IDisposableAnalyzers Changelog]:
-  > #### 3.4.1
-  > * Publish with binaries.
-  > #### 3.4.0
-  > * FEATURE: Handle DisposableMixins.DisposeWith
-  > * BUGFIX: IDISP025 when abstract dispose method.
-  > * BUGFIX: IDISP006 when explicit implementation.
+## 2.1.1
+* Relaxed rules:
+    * [SA1119](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1119.md) (StatementMustNotUseUnnecessaryParenthesis) is now disabled.
 
-## 2.0.0-rc.1
-* Breaking: Treat all nullability warnings as errors.
-* Lints involving single line comments have been reduced to warnings to make temporary code commenting easier.
-* The hungarian notation rule has been relaxed to allow `js` and `db` since those two are common "false positives".
+* Update IDisposableAnalyzers to 3.4.15. Excerpt from [IDisposableAnalyzers Changelog]:
+  > #### 3.4.15
+  > * BUGFIX: IDISP005 with ServiceDescriptor
+  > * BUGFIX: IDISP004 when DisposeWith
+  > #### 3.4.14
+  > * BUGFIX: IDISP005 should not warn in Assert.Throws.
+  > * BUGFIX: Handle function pointer.
+  > #### 3.4.13
+  > * BUGFIX: Specialcase Gu.Reactive extension methods.
+* Update StyleCop.Analyzers to 1.2.0-beta.354 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.333...1.2.0-beta.354))
 
-## 2.0.0-rc.2
-- Update StyleCop.Analyzers to 1.2.0-beta.261. ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.205...1.2.0-beta.261))
+## 2.1.0
+* Warn when interface method has `public` accessibility modifier (`MESSERLI001`)
 
-## 2.0.0-rc.3
-- Update StyleCop.Analyzers to 1.2.0-beta.312 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.261...1.2.0-beta.312))
-- Fix compilation error when building an F# project.
+## 2.0.1
+* Update IDisposableAnalyzers to 3.4.13. Excerpt from [IDisposableAnalyzers Changelog]:
+  > #### 3.4.13
+  > * BUGFIX: Specialcase Gu.Reactive extension methods.
+  > #### 3.4.12
+  > * BUGFIX: When leaveOpen has default value
+  > #### 3.4.11
+  > * BUGFIX IDISP023 handle trivial and.
+  > * BUGFIX IDISP023 when chained constructors
+  > * BUGFIX IDISP001 when if statement.
+  > * BUGFIX IDISP004 when chained leave open.
+  > #### 3.4.10
+  > * BUGFIX: Handle using in loop
+  > #### 3.4.9
+  > * BUGFIX: IDISP023 Allow touching static reference types.
+  > * BUGFIX: AD0001: Analyzer 'IDisposableAnalyzers.LocalDeclarationAnalyzer
+* Update StyleCop.Analyzers to 1.2.0-beta.333 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.321...1.2.0-beta.333)) \
+  Notable changes/fixes:
+    * [23db6c0: Avoid reporting SA1141 (Use tuple syntax) in expression trees](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commit/af356f9b36dc4849a678c0b8c918123fa567913b)
 
 ## 2.0.0
 * Update IDisposableAnalyzers to 3.4.8. Excerpt from [IDisposableAnalyzers Changelog]:
@@ -68,69 +86,52 @@ Initial release
   > * Handle some regressions in Roslyn 3.7
 * Update StyleCop.Analyzers to 1.2.0-beta.321 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.312...1.2.0-beta.321)) \
   Notable changes/fixes:
-  * [9c5c071: Support records without braces](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.312...1.2.0-beta.321)
-  * [46d2e37: Support implicit object creation expressions in SA1129 code fix](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commit/46d2e37fed1e471446f32c88c6bdaf2530239570)
+    * [9c5c071: Support records without braces](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.312...1.2.0-beta.321)
+    * [46d2e37: Support implicit object creation expressions in SA1129 code fix](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commit/46d2e37fed1e471446f32c88c6bdaf2530239570)
 
-## 2.0.1
-* Update IDisposableAnalyzers to 3.4.13. Excerpt from [IDisposableAnalyzers Changelog]:
-  > #### 3.4.13
-  > * BUGFIX: Specialcase Gu.Reactive extension methods.
-  > #### 3.4.12
-  > * BUGFIX: When leaveOpen has default value
-  > #### 3.4.11
-  > * BUGFIX IDISP023 handle trivial and.
-  > * BUGFIX IDISP023 when chained constructors
-  > * BUGFIX IDISP001 when if statement.
-  > * BUGFIX IDISP004 when chained leave open.
-  > #### 3.4.10
-  > * BUGFIX: Handle using in loop
-  > #### 3.4.9
-  > * BUGFIX: IDISP023 Allow touching static reference types.
-  > * BUGFIX: AD0001: Analyzer 'IDisposableAnalyzers.LocalDeclarationAnalyzer
-* Update StyleCop.Analyzers to 1.2.0-beta.333 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.321...1.2.0-beta.333)) \
-  Notable changes/fixes:
-  * [23db6c0: Avoid reporting SA1141 (Use tuple syntax) in expression trees](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/commit/af356f9b36dc4849a678c0b8c918123fa567913b)
+## 2.0.0-rc.3
+* Update StyleCop.Analyzers to 1.2.0-beta.312 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.261...1.2.0-beta.312))
+* Fix compilation error when building an F# project.
 
-## 2.1.0
-* Warn when interface method has `public` accessibility modifier (`MESSERLI001`)
+## 2.0.0-rc.2
+* Update StyleCop.Analyzers to 1.2.0-beta.261. ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.205...1.2.0-beta.261))
 
-## 2.1.1
-* Relaxed rules:
-  * [SA1119](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/blob/master/documentation/SA1119.md) (StatementMustNotUseUnnecessaryParenthesis) is now disabled.
+## 2.0.0-rc.1
+* Breaking: Treat all nullability warnings as errors.
+* Lints involving single line comments have been reduced to warnings to make temporary code commenting easier.
+* The hungarian notation rule has been relaxed to allow `js` and `db` since those two are common "false positives".
 
-* Update IDisposableAnalyzers to 3.4.15. Excerpt from [IDisposableAnalyzers Changelog]:
-  > #### 3.4.15
-  > * BUGFIX: IDISP005 with ServiceDescriptor
-  > * BUGFIX: IDISP004 when DisposeWith
-  > #### 3.4.14
-  > * BUGFIX: IDISP005 should not warn in Assert.Throws.
-  > * BUGFIX: Handle function pointer.
-  > #### 3.4.13
-  > * BUGFIX: Specialcase Gu.Reactive extension methods.
-* Update StyleCop.Analyzers to 1.2.0-beta.354 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.333...1.2.0-beta.354))
+## 1.2.1
+* Update StyleCop.Analyzers to 1.2.0-beta.205. ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.164...1.2.0-beta.205))
+* Update IDisposableAnalyzers to 3.4.1. Excerpt from [IDisposableAnalyzers Changelog]:
+  > #### 3.4.1
+  > * Publish with binaries.
+  > #### 3.4.0
+  > * FEATURE: Handle DisposableMixins.DisposeWith
+  > * BUGFIX: IDISP025 when abstract dispose method.
+  > * BUGFIX: IDISP006 when explicit implementation.
 
-## 2.1.2
-* Update StyleCop.Analyzers to 1.2.0-beta.376 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.354...1.2.0-beta.376))
+## 1.2.0
+* Disable SA1412 (StoreFilesAsUtf). This means that BOMs are no longer required in C# files.
+* Update IDisposableAnalyzers from 3.3.2 to 3.3.8:
+* Update StyleCop.Analyzers from 1.2.0-beta.113 to 1.2.0-beta.164 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.113...1.2.0-beta.164)).
+* Enable `GenerateDocumentationFile` by default. This had to be turned on manually in each project before,
+  as it is required by our StyleCop configuration.
 
-## 2.1.3
-* Update StyleCop.Analyzers to 1.2.0-beta.435 ([diff](https://github.com/DotNetAnalyzers/StyleCopAnalyzers/compare/1.2.0-beta.376...1.2.0-beta.435))
-   * Most notably this version fixes false positives of `SA1516: Elements should be separated by blank line` in files with top-level statements.
+## 1.1.0
+* Update IDisposableAnalyzers from 3.2.0 to 3.3.2. Excerpt from [IDisposableAnalyzers Changelog]:
+  > #### 3.3.0
+  > - FEATURE: Initial support for AsyncDisposable
+
+## 1.0.1
+* Hide stylecop.json in Visual Studio.
+
+## 1.0.0
+* Add support for netstandard2.0.
+* Add support for projects that target multiple frameworks.
+
+## 1.0.0-alpha.1
+Initial release
 
-## 2.2.0
-* File scoped namespaces are now enforced. (#81)
-* Enable warning for unused usings. (#81)
-* `SA1305: FieldNamesMustNotUseHungarianNotation` has been disabled. (#82)
-* Use warning instead of error level for spacing rules. (#83)
-* Update IDisposableAnalyzers to 4.0.2. Excerpt from [IDisposableAnalyzers Changelog]:
-  > #### 4.0.2
-  > * BUGFIX: IDISP007 when disposing static member in static context
-  > #### 4.0.1
-  > * BUGFIX: IDISP007 false warning when using Rx
-  > * BUGFIX: IDISP016 false warning when foreach
-  > * BUGFIX: Handle leaveOpen when AsyncDisposable
-  > * BUGIX: Handle top level statements.
-  > #### 4.0.0
-  > * BREAKING: For VS2022+ now.
-  > * BUGFIX: AD0001 -> Could not load file or assembly
 
 [IDisposableAnalyzers Changelog]: https://github.com/DotNetAnalyzers/IDisposableAnalyzers/blob/master/RELEASE_NOTES.md
diff --git a/global.json b/global.json
@@ -4,6 +4,6 @@
         "rollForward": "latestFeature"
     },
     "msbuild-sdks": {
-        "Microsoft.Build.NoTargets": "3.5.6"
+        "Microsoft.Build.NoTargets": "3.7.0"
     }
 }
diff --git a/readme.md b/readme.md
@@ -6,31 +6,6 @@
 
 ## Usage
 
-### Without the CentralPackageVersions SDK
-
-Add the following package reference to your project or to your `Directory.Build.props`:
-
-```diff
-  <?xml version="1.0" encoding="utf-8"?>
-  <Project>
-      <ItemGroup>
-+         <PackageReference Include="Messerli.CodeStyle" Version="2.1.0" PrivateAssets="all" />
-      </ItemGroup>
-  </Project>
-```
-
-### With the CentralPackageVersions SDK
-
-Add `Messerli.CodeStyle` to your `Packages.props`:
-```diff
-  <?xml version="1.0" encoding="utf-8"?>
-  <Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-      <ItemGroup Label="Build dependencies">
-+         <PackageReference Update="Messerli.CodeStyle" Version="2.1.0" />
-      </ItemGroup>
-  </Project>
-```
-
 Add the following package reference to your project or to your `Directory.Build.props`:
 ```diff
   <?xml version="1.0" encoding="utf-8"?>
@@ -41,6 +16,8 @@ Add the following package reference to your project or to your `Directory.Build.
   </Project>
 ```
 
+You either have to add the version here or in `Directory.Packages.props` depending on if you're using [Central Package Management](https://learn.microsoft.com/en-us/nuget/consume-packages/Central-Package-Management).
+
 ## Warnings as Errors
 
 Some analyzer rules, such as rules involving single line comments, are configured as warnings to facilitate development.
diff --git a/scripts/test-files-are-importable-by-msbuild.fsx b/scripts/test-files-are-importable-by-msbuild.fsx
@@ -0,0 +1,44 @@
+#r "nuget: Messerli.TempDirectory,0.3.0"
+
+open System.Diagnostics
+open System.IO
+open System.IO.Compression
+open Messerli.TempDirectory
+
+let ensureSuccessExitCode(p: Process) =
+    if p.ExitCode <> 0 then
+        raise (IOException($"The process {p.StartInfo.FileName} exited with a non-zero exit code {p.ExitCode}"))
+
+let addArguments (info: ProcessStartInfo) args =
+    args |> Seq.iter info.ArgumentList.Add
+
+let runProcess filename args =
+    let formattedArgs = args |> String.concat " "
+    printfn $"+ {filename} {formattedArgs}"
+    let startInfo = ProcessStartInfo(filename)
+    addArguments startInfo args
+    use p = Process.Start(startInfo)
+    p.WaitForExit()
+    ensureSuccessExitCode p
+
+let buildNuGetPackages outputDirectory =
+    Directory.CreateDirectory(outputDirectory) |> ignore
+    runProcess "dotnet" ["pack"; "CodeStyle/CodeStyle.csproj"; $"/p:PackageOutputPath={outputDirectory}"]
+
+let findNuGetPackage packagesDirectory =
+    Directory.GetFiles(packagesDirectory, searchPattern = "*.nupkg") |> Seq.head
+
+let testFileIsImportable packagesDirectory relativePath =
+    printfn $"Testing {relativePath}"
+    runProcess "dotnet" ["msbuild"; Path.Combine(packagesDirectory, relativePath); "-preprocess"]
+
+let main =
+    use tempDirectory = TempSubdirectory.Create("code-style-tests")
+    let packagesDirectory = Path.Combine(tempDirectory.FullName, "nupkg")
+    let unpackedDirectory = Path.Combine(tempDirectory.FullName, "unpacked")
+    let importableFiles = ["build/Messerli.CodeStyle.props"]
+    buildNuGetPackages packagesDirectory
+    ZipFile.ExtractToDirectory((findNuGetPackage packagesDirectory), unpackedDirectory)
+    importableFiles |> Seq.iter (testFileIsImportable unpackedDirectory)
+
+main
diff --git a/scripts/test_files_are_importable_by_msbuild.rb b/scripts/test_files_are_importable_by_msbuild.rb

Original file line number	Diff line number	Diff line change
`@@ -4,6 +4,6 @@`
`4`	`4`	`"rollForward": "latestFeature"`
`5`	`5`	`},`
`6`	`6`	`"msbuild-sdks": {`
`7`		`- "Microsoft.Build.NoTargets": "3.5.6"`
	`7`	`+ "Microsoft.Build.NoTargets": "3.7.0"`
`8`	`8`	`}`
`9`	`9`	`}`