chore: Setup cSpell CI (#998)

* chore: Add cSpell CI setup * fix: Additional typos and suppressions
w3c · Oct 22, 2020 · 938e82e · 938e82e
1 parent 8933440
commit 938e82e
Show file tree

Hide file tree

Showing 7 changed files with 105 additions and 8 deletions.
diff --git a/.cspell.json b/.cspell.json
@@ -1,35 +1,54 @@
 {
     "version": "0.1",
     "words": [
+        "ˈspɛk",
+        "aboba",
         "alignof",
+        "anant",
         "apikey",
         "badterms",
         "bdsw",
         "Beihang",
+        "bergkvist",
+        "biblio",
+        "bibo",
         "blinenums",
         "blocklist",
+        "caniuse",
         "capi",
         "charmod",
         "Cmembership",
         "constexpr",
         "Cprocess",
         "cssvalidation",
+        "ctor",
         "customised",
-        "dahut",
         "DAHUT",
+        "dahut",
+        "dcterms",
         "decltype",
+        "deniak",
+        "denicola",
         "docdate",
         "doctypes",
+        "Domenic",
         "editorsid",
+        "ednote",
         "elif",
         "ERCIM",
         "esac",
+        "figno",
+        "foaf",
         "FPIG",
+        "FPLC",
         "FPWD",
         "FPWG",
+        "Glazkov",
         "gzipped",
         "hellip",
         "hilite",
+        "hljs",
+        "howto",
         "ifdef",
         "ifndef",
         "ignote",
@@ -38,72 +57,111 @@
         "imsc",
         "insafe",
         "isnt",
+        "k",
         "Keio",
+        "kesteren",
+        "kongress",
         "ldquo",
         "linenums",
         "linkchecker",
         "linkhref",
         "Localise",
+        "mdash",
+        "media",
         "mediacapture",
         "memsub",
         "metaviewport",
         "middot",
         "munge",
+        "narayanan",
         "newurl",
         "nodate",
+        "noexistence",
         "nonlocal",
         "Normalise",
+        "npmjs",
         "Nresult",
         "nullptr",
         "OBSL",
         "ocument",
+        "Ohai",
         "ontents",
+        "parallelised",
         "patentpolicy",
+        "prevrecuri",
+        "prevversionuri",
         "Pubrules",
         "rdquo",
         "recognising",
         "rectrack",
+        "reprojection",
         "Resc",
+        "retargeted",
+        "retargeting",
         "RSCND",
         "sbyte",
         "secno",
         "secnos",
         "sels",
+        "sensical",
         "shortlink",
         "shortname",
         "shortnames",
         "sotd",
+        "sp",
         "sparql",
         "specberus",
         "SPSD",
         "stackalloc",
+        "stream",
         "strictfp",
         "subm",
+        "submlogo",
         "supersedable",
+        "tocxref",
         "ttml",
         "uage",
         "uarr",
         "ulong",
         "unneutral",
+        "unrecognize",
         "ushort",
         "vali",
-        "valide",
         "Valide",
+        "valide",
         "valuenow",
+        "vcard",
+        "vulns",
         "wantarray",
+        "WCAG",
         "wcag",
-        "wgnote",
+        "webauthn",
+        "WEBIDL",
+        "WEBRTC",
         "WG's",
-        "whut"
+        "wgnote",
+        "whacko",
+        "whut",
+        "widl",
+        "YYYYMMDD"
     ],
     "dictionaries": [
         "html",
         "js",
         "css",
+        "npm",
         "en-gb"
     ],
     "ignorePaths": [
+        "**/*.eot",
+        "**/*.ttf",
+        "**/*.woff",
+        "**/*.svg",
+        ".nyc_output/**",
+        "coverage/**",
+        "test/**",
+        "package-lock.json",
         "node_modules/**"
     ],
     "allowCompoundWords": true
-}
+}
diff --git a/.github/workflows/cspell-problem-matcher.json b/.github/workflows/cspell-problem-matcher.json
@@ -0,0 +1,16 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "cspell",
+      "pattern": [
+        {
+          "regexp": "^(.*):(\\d+):(\\d+)\\s+\\-\\s+(.*)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4
+        }
+      ]
+    }
+  ]
+}
diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml
@@ -0,0 +1,22 @@
+name: Spellcheck
+
+on: [push, pull_request]
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v2
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v1
+
+      - name: Install npm dependencies
+        run: npm install
+
+      - name: cSpell
+        run: |
+          echo "::add-matcher::.github/workflows/cspell-problem-matcher.json"
+          npm run spelling
diff --git a/README.md b/README.md
@@ -122,7 +122,7 @@ This method takes an object with the following fields:
 * `file`: A file system path to the content to check.
 * `document`: A DOM `Document` object to be checked.
 * `profile`: A profile object which defines the validation. Required. See below.
-* `events`: An event sink which supports the same interface as Node.js's `EventEmitter`. Required. See
+* `events`: An event sink which supports the same interface as the Node.js `EventEmitter`. Required. See
   below for the events that get generated.
 
 ### `extractMetadata(options)`

diff --git a/lib/rules.json b/lib/rules.json
@@ -1335,7 +1335,7 @@
                             "boilerplateTRDoc": true,
                             "datesFormat": true,
                             "WGLink": true,
-                            "publish": "W3C Recommendation <span class=\"rfc2119\">must</span> include one of the four paragraphs below in the \"Status Of This Document\" depending on the type of Recommendations:<blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation.</blockquote>Recommandation with proposed changes:<blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation. It includes <a href=\"https://www.w3.org/2020/Process-20200915/#proposed-correction\">proposed corrections</a></blockquote>Recommendation with new features: <blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation. It includes <a href=\"https://www.w3.org/2020/Process-20200915/#proposed-addition\">proposed addition</a>, introducing new features since the Previous Recommendation.</blockquote>Recommendation with proposed changes and new features: <blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation. It includes <a href=\"https://www.w3.org/2020/Process-20200915/#proposed-changes\">proposed changes</a>, introducing substantive changes and new features since the Previous Recommendation.</blockquote><p> <span style=\"font-style: italic\">Include one of these source codes:</span><br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation.&lt;/p&gt;</code> <br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation. This document was published by the @@ Working Group as a Recommendation. It includes &lt;a href=\"https://www.w3.org/2020/Process-20200915/#proposed-correction\"&gt;proposed corrections&lt;/a&gt;.&lt;/p&gt;</code> <br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation. This document was published by the @@ Working Group as a Recommendation. It includes &lt;a href=\"https://www.w3.org/2020/Process-20200915/#proposed-addition\"&gt;proposed addition&lt;/a&gt;, introducing new features since the Previous Recommendation.&lt;/p&gt;</code> <br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation. This document was published by the @@ Working Group as a Recommendation. It includes &lt;a href=\"https://www.w3.org/2020/Process-20200915/#proposed-changes\"&gt;proposed changes&lt;/a&gt;, introducing substantive changes and new features since the Previous Recommendation.&lt;/p&gt;</code></p>",
+                            "publish": "W3C Recommendation <span class=\"rfc2119\">must</span> include one of the four paragraphs below in the \"Status Of This Document\" depending on the type of Recommendations:<blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation.</blockquote>Recommendation with proposed changes:<blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation. It includes <a href=\"https://www.w3.org/2020/Process-20200915/#proposed-correction\">proposed corrections</a></blockquote>Recommendation with new features: <blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation. It includes <a href=\"https://www.w3.org/2020/Process-20200915/#proposed-addition\">proposed addition</a>, introducing new features since the Previous Recommendation.</blockquote>Recommendation with proposed changes and new features: <blockquote class=\"boilerplate\">This document was published by the @@ Working Group as a Recommendation. It includes <a href=\"https://www.w3.org/2020/Process-20200915/#proposed-changes\">proposed changes</a>, introducing substantive changes and new features since the Previous Recommendation.</blockquote><p> <span style=\"font-style: italic\">Include one of these source codes:</span><br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation.&lt;/p&gt;</code> <br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation. This document was published by the @@ Working Group as a Recommendation. It includes &lt;a href=\"https://www.w3.org/2020/Process-20200915/#proposed-correction\"&gt;proposed corrections&lt;/a&gt;.&lt;/p&gt;</code> <br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation. This document was published by the @@ Working Group as a Recommendation. It includes &lt;a href=\"https://www.w3.org/2020/Process-20200915/#proposed-addition\"&gt;proposed addition&lt;/a&gt;, introducing new features since the Previous Recommendation.&lt;/p&gt;</code> <br> <code>&lt;p&gt;This document was published by the @@ Working Group as a Recommendation. This document was published by the @@ Working Group as a Recommendation. It includes &lt;a href=\"https://www.w3.org/2020/Process-20200915/#proposed-changes\"&gt;proposed changes&lt;/a&gt;, introducing substantive changes and new features since the Previous Recommendation.&lt;/p&gt;</code></p>",
                             "mailingListName": "It <span class=\"rfc2119\">must</span> include a link to a GitHub repository issues list (of the form <code>https://github.com/&lt;USER_OR_ORG&gt;/&lt;REPO_NAME&gt;/issues[/&hellip;]</code>).",
                             "recRelation": "It <span class=\"rfc2119\">must</span> indicate its relationship to previous related Recommendations (e.g., an indication that a Recommendation supersedes, obsoletes, or subsumes another, or that a Recommendation is an editorial revision) and <span class=\"rfc2119\">must</span> link to the most recent Recommendation (if any) having the same major revision number. The document thus links to two important resources: the previous edition of the Recommendation via the status section, and the previous draft (the Proposed Recommendation) via the \"Previous version\" link.",
                             "customParagraph": true,

diff --git a/package.json b/package.json
@@ -43,6 +43,7 @@
     "cspell": "cspell **/*.css **/*.js",
     "lint": "eslint app.js lib/ public/ test/ tools/",
     "hint": "jshint app.js lib/ public/ test/ tools/",
+    "spelling": "cspell \"**/*.*\"",
     "test": "mocha --timeout 10000",
     "jsdoc": "jsdoc --configure jsdoc.json -r app.js lib/ public/ test/ tools/",
     "coverage": "nyc npm test",

diff --git a/views/index.handlebars b/views/index.handlebars
@@ -126,7 +126,7 @@
 </div>
 
 <div class="alert alert-info" role="alert">
-  Graphical UI's not your thing? Check out the
+  Graphical UIs not your thing? Check out the
   <a href="https://github.com/w3c/specberus/blob/master/README.md#5-rest-api">REST interface</a>
   against the
   <a href="{{BASE_URI}}api/">endpoint of this instance (<code>{{BASE_URI}}api/</code>)</a>.