Add Reviewdog LanguageTool github action (#84)

CptWesley · Corniel · web-flow · commit b2ae6fd1ea73 · 2025-01-28T10:32:12.000+01:00
* Add Reviewdog LanguageTool github action

* no message

* Add intentional error

* no message

* no message

* no message

* Add misspell

* no message

* Update reviewdog-languagetool.yaml

* Update rules/Proj0001.md

* no message

* no message

* no message

* Split pipelines

* no message

* no message

* no message

* no message

* no message

* Fix all found misspell errors

* Fix LanguageTool errors

* no message

---------

Co-authored-by: Corniel Nobel &lt;corniel@gmail.com&gt;
diff --git a/.github/workflows/reviewdog-languagetool.yaml b/.github/workflows/reviewdog-languagetool.yaml
@@ -0,0 +1,21 @@
+name: Reviewdog LanguageTool
+on: [pull_request]
+jobs:
+  languagetool:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      checks: write
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/action-languagetool@v1.20.2
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          level: error
+          language: 'en-US'
+          patterns: '**/*.md **/*.MD **/*.txt **/*.TXT'
+          disabled_categories: ''
+          disabled_rules: 'MORFOLOGIK_RULE_EN_US'
diff --git a/.github/workflows/reviewdog-misspell.yaml b/.github/workflows/reviewdog-misspell.yaml
@@ -0,0 +1,26 @@
+name: Reviewdog Misspell
+on: [pull_request]
+jobs:
+  misspell:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+      checks: write
+      issues: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v4
+      - uses: reviewdog/action-misspell@v1.26.1
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          reporter: github-pr-review
+          level: error
+          locale: "US"
+          pattern: |
+            *.md
+            *.MD
+            *.txt
+            *.TXT
+          filter_mode: nofilter
+          fail_level: none
+          fail_on_error: false
diff --git a/general/sdk.md b/general/sdk.md
@@ -29,7 +29,7 @@ directory conting the [Git](https://en.wikipedia.org/wiki/Git) repo), you
 
 Most files in the directory of this SDK project will be included automatically.
 This includes configuration, text, and markdown files. It will not contain any
-`<Compile>` items unless explictly added. The SDK project is not intended to
+`<Compile>` items unless explicitly added. The SDK project is not intended to
 contain `<Compile>` items, and the binary output is hidden for that reason.
 
 All automatically included files and files added as `<AdditionalFiles>` are
diff --git a/general/sonar-integration.md b/general/sonar-integration.md
@@ -26,7 +26,7 @@ developers.
 ## Sonarcloud integration
 There is currently no *'elegant'* solution to have the warnings show up on SonarCloud,
 however, there is a workaround. By adding the `.??proj` and `.props` files as content,
-SonarCloud will recognise it's warnings and pick them up, same as any warnings in the
+SonarCloud will recognize its warnings and pick them up, same as any warnings in the
 code.
 
 For Example:
diff --git a/rules/Proj0015.md b/rules/Proj0015.md
@@ -7,7 +7,7 @@ ancestor: MSBuild
 `<PackageReference>` nodes should be ordered alphabetically
 within a single `<ItemGroup>` in order to make it more
 human readable. When ordering the references based on
-other criteria, consider grouping them in seperate
+other criteria, consider grouping them in separate
 `<ItemGroup>`s.
 
 ## Non-compliant
diff --git a/rules/Proj0016.md b/rules/Proj0016.md
@@ -7,7 +7,7 @@ ancestor: MSBuild
 `<ProjectReference>` nodes should be ordered alphabetically
 within a single `<ItemGroup>` in order to make it more
 human readable. When ordering the references based on
-other criteria, consider grouping them in seperate
+other criteria, consider grouping them in separate
 `<ItemGroup>`s.
 
 ## Non-compliant
diff --git a/rules/Proj0018.md b/rules/Proj0018.md
@@ -6,7 +6,7 @@ ancestor: MSBuild
 # Proj0018: Order using directives by type
 `<Using>` nodes should be ordered by type for consistency within a single
 `<ItemGroup>`. When ordering the imports based on other criteria, consider
-grouping them in seperate `<ItemGroup>`s.
+grouping them in separate `<ItemGroup>`s.
 
 ## Non-compliant
 ``` xml
diff --git a/rules/Proj0019.md b/rules/Proj0019.md
@@ -6,7 +6,7 @@ ancestor: MSBuild
 # Proj0019: Order using directives alphabetically
 `<Using>` nodes should be ordered alphabetically within a single `<ItemGroup>`
 in order to make it more human readable. When ordering the references based on
-other criteria, consider grouping them in seperate `<ItemGroup>`s.
+other criteria, consider grouping them in separate `<ItemGroup>`s.
 
 ## Non-compliant
 ``` xml
diff --git a/rules/Proj0021.md b/rules/Proj0021.md
@@ -6,7 +6,7 @@ ancestor: MSBuild
 # Proj0021: Build actions should have a single task
 `<ItemGroup>` build taks nodes such as `<Compile>`, `<Content>`, `<EmbeddedResource>`,
 `<None>`, and `<AdditionalFiles` should only have on task. Assigning multiple
-tasks to a single node seperated by semicolons (`;`) leads to longer lines
+tasks to a single node separated by semicolons (`;`) leads to longer lines
 that are harder to read and maintain.
 
 ## Non-compliant
diff --git a/rules/Proj0024.md b/rules/Proj0024.md
@@ -7,7 +7,7 @@ ancestor: MSBuild
 `<PackageVersion>` nodes should be ordered alphabetically
 within a single `<ItemGroup>` in order to make it more
 human readable. When ordering the versions based on
-other criteria, consider grouping them in seperate
+other criteria, consider grouping them in separate
 `<ItemGroup>`s.
 
 ## Non-compliant
diff --git a/rules/Proj0025.md b/rules/Proj0025.md
@@ -4,7 +4,7 @@ ancestor: MSBuild
 ---
 
 # Proj0025: Migrate from ruleset file to .editorconfig file
-Microsoft deprecated the use of `.ruleset`'s in favour of .editorconfig files.
+Microsoft deprecated the use of `.ruleset` in favor of `.editorconfig` files.
 In Visual Studio by clicking the file, it will automatically pop up a dialog to
 convert the ruleset.
 
diff --git a/rules/Proj0240.md b/rules/Proj0240.md
@@ -5,7 +5,7 @@ ancestor: Rules
 
 # Proj0240: Enable package validation
 To ensure the (backwards) compatibility
-of the API surface of your package, it is adviced
+of the API surface of your package, it is advised
 to enable package validation by defining the
 `<EnablePackageValidation>` node with value `true`.
 
diff --git a/rules/Proj0241.md b/rules/Proj0241.md
@@ -5,7 +5,7 @@ ancestor: Rules
 
 # Proj0241: Enable package baseline validation
 To ensure the backwards compatibility
-of the API surface of your package, it is adviced
+of the API surface of your package, it is advised
 to enable package baseline validation by defining the
 `<PackageValidationBaselineVersion>` node with the version
 of the previous stable release.
diff --git a/rules/Proj0700.md b/rules/Proj0700.md
@@ -6,7 +6,7 @@ ancestor: Rules
 # Proj0700: Avoid defining <Compile> items in SDK project
 The [.net.csproj SDK project](../general/sdk.md) is a placeholder for
 non-compiling files. Adding `<Compile>` items has no meaning, as the
-project has no (publically) accessable compilation artifacts.
+project has no (publically) accessible compilation artifacts.
 
 ## Non-compliant
 ``` xml
