ADD TO: basic QA / add spellcheck / WIP

Author: jrfnl

.cspell.yml

@@ -0,0 +1,32 @@
+$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
+version: '0.2'
+language: en-GB
+
+dictionaryDefinitions:
+  - name: project-words
+    path: './.phpcs.dict'
+    addWords: true
+
+dictionaries:
+  - project-words
+
+ignorePaths:
+  - 'node_modules/**'
+  - '/.phpcs.dict'
+
+patterns:
+  - name: markdown_code_block
+    pattern: |
+      /
+          ^(\s*`{3,})[a-z]+   # match the ``` with a language modifier
+          [\s\S]*?            # the block of code
+          ^\1                 # end of the block
+      /gmx
+  - name: markdown_inline_code
+    pattern: /(\s*`)\S{3,}`/gmx
+
+languageSettings:
+  - languageId: markdown
+    ignoreRegExpList:
+      - markdown_code_block
+      - markdown_inline_code

.github/workflows/basic-qa.yml

@@ -24,6 +24,21 @@ jobs:
     with:
       strict: true
 
+  spellcheck:
+    name: Spellcheck
+
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Install markdown-spellcheck
+        run: npm install -g cspell
+
+      - name: Spellcheck
+        run: cspell --show-suggestions --show-context "**/*.md"
+
   linkcheck:
     name: "Check links"
     runs-on: ubuntu-latest

.phpcs.dict

@@ -0,0 +1,10 @@
+PHP_CodeSniffer
+phpcs
+phpcbf
+SquizLabs
+Squiz
+Joomla
+csslint
+gjslint
+gitblame
+PHPUnit