Add cSpell to NUKE build pipeline

.github/workflows/spellcheck.yml

@@ -0,0 +1,27 @@
+name: Documentation Checks
+
+on:
+  push:
+    branches:
+      - develop
+    paths:
+      # This ensures the check will only be run when something changes in the docs content
+      - "docs/**/*" # or whatever the path to the markdown / docs files happens to be
+  pull_request:
+    branches:
+      - develop
+    paths:
+      - "docs/**/*"
+jobs:
+  spellcheck:
+    name: "Docs: Spellcheck"
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+        name: Check out the code
+      - uses: actions/setup-node@v1
+        name: Setup node
+        with:
+          node-version: "16"
+      - name: Run NUKE spell check
+        run: ./build.sh Spellcheck

.gitignore

@@ -7,7 +7,7 @@
 *.sln.docstates
 *.sln.ide
 .vs/
-
+.vscode/
 
 project.lock.json
 *.nuget.props

.nuke/build.schema.json

@@ -84,6 +84,7 @@
               "Pack",
               "Push",
               "Restore",
+              "Spellcheck",
               "TestFrameworks",
               "UnitTests"
             ]
@@ -107,6 +108,7 @@
               "Pack",
               "Push",
               "Restore",
+              "Spellcheck",
               "TestFrameworks",
               "UnitTests"
             ]

Build/Build.cs

@@ -8,11 +8,13 @@
 using Nuke.Common.Tooling;
 using Nuke.Common.Tools.DotNet;
 using Nuke.Common.Tools.GitVersion;
+using Nuke.Common.Tools.Npm;
 using Nuke.Common.Tools.ReportGenerator;
 using Nuke.Common.Tools.Xunit;
 using static Nuke.Common.IO.FileSystemTasks;
 using static Nuke.Common.IO.PathConstruction;
 using static Nuke.Common.Tools.DotNet.DotNetTasks;
+using static Nuke.Common.Tools.Npm.NpmTasks;
 using static Nuke.Common.Tools.ReportGenerator.ReportGeneratorTasks;
 using static Nuke.Common.Tools.Xunit.XunitTasks;
 
@@ -47,6 +49,9 @@ class Build : NukeBuild
     [PackageExecutable("nspec", "NSpecRunner.exe", Version = "3.1.0")]
     Tool NSpec3;
 
+    [PathExecutable("bash")]
+    Tool Bash;
+
     AbsolutePath ArtifactsDirectory => RootDirectory / "Artifacts";
 
     AbsolutePath TestResultsDirectory => RootDirectory / "TestResults";
@@ -246,5 +251,21 @@ class Build : NukeBuild
                     (v, path) => v.SetTargetPath(path)));
         });
 
+    Target Spellcheck => _ => _
+        .OnlyWhenDynamic(() => !IsLocalBuild)
+        .Executes(() =>
+        {
+            InstallCSpell();
+
+            var cSpellFile = RootDirectory / "cSpell.json";
+            var docsDirectory = RootDirectory / "docs";
+            Bash($"-c \"cspell --config {cSpellFile} '{docsDirectory}/**/*.md' --no-progress\"");
+        });
+
+    private void InstallCSpell()
+    {
+        Npm("install -g cspell");
+    }
+
     bool IsTag => BranchSpec != null && BranchSpec.Contains("refs/tags", StringComparison.InvariantCultureIgnoreCase);
 }

cSpell.json

@@ -0,0 +1,81 @@
+{
+    "version": "0.2",
+    "language": "en",
+    "words": [
+        "browsable",
+        "Doomen",
+        "formattable",
+        "Guids",
+        "LINQ",
+        "parameterless",
+        "refactorings",
+        "struct"
+    ],
+    "ignoreWords": [
+        "Gallio"
+    ],
+    "patterns": [
+        {
+            "name": "Markdown links",
+            "pattern": "\\((.*)\\)",
+            "description": ""
+        },
+        {
+            "name": "Markdown code blocks",
+            "pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx",
+            "description": "Taken from the cSpell example at https://cspell.org/configuration/patterns/#verbose-regular-expressions"
+        },
+        {
+            "name": "Inline code blocks",
+            "pattern": "\\`([^\\`\\r\\n]+?)\\`",
+            "description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex"
+        },
+        {
+            "name": "Link contents",
+            "pattern": "\\<a(.*)\\>",
+            "description": ""
+        },
+        {
+            "name": "Snippet references",
+            "pattern": "-- snippet:(.*)",
+            "description": ""
+        },
+        {
+            "name": "Snippet references 2",
+            "pattern": "\\<\\[sample:(.*)",
+            "description": "another kind of snippet reference"
+        },
+        {
+            "name": "Multi-line code blocks",
+            "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm"
+        },
+        {
+            "name": "HTML Tags",
+            "pattern": "<[^>]*>",
+            "description": "Reference: https://stackoverflow.com/questions/11229831/regular-expression-to-remove-html-tags-from-a-string"
+        },
+        {
+            "name": "Frontmatter",
+            "pattern": "/^([-]{3}|[+]{3}|[.]{3})$[\\s\\S]+^([-]{3}|[+]{3}|[.]{3})$/gm"
+        },
+        {
+            "name": "Liquid Includes",
+            "pattern": "\\{%(.*) %\\}"
+        }
+    ],
+    "ignoreRegExpList": [
+        "Markdown links",
+        "Markdown code blocks",
+        "Inline code blocks",
+        "Link contents",
+        "Snippet references",
+        "Snippet references 2",
+        "Multi-line code blocks",
+        "HTML Tags",
+        "Frontmatter",
+        "Liquid Includes"
+    ],
+    "ignorePaths": [
+        "docs/_pages/releases.md"
+    ]
+}

docs/README.md

@@ -8,7 +8,7 @@ The Fluent Assertions [landing page](https://fluentassertions.com) is using Jeky
 
 * Ruby 3.1. 
     * An easy way to install is to use `choco install ruby`.
-    * Or use the **Ruby+Devkit installer** from [RubyInstaller for Windows](https://rubyinstaller.org/downloads/archives/).
+    * Or use the **`Ruby+Devkit` installer** from [RubyInstaller for Windows](https://rubyinstaller.org/downloads/archives/).
     * Note that you may have to reopen your command shell to get the `ruby --version` command to work,
 * The `bundler` 
     * Run `gem install bundler` to install it. If you receive SSL-related errors while running gem install, try running `refreshenv` first.