github action cspell

Add a github action to check spelling of all files. Include a config and
a list of project-words (words to be ignored by spell-checking) under
`.cspell`.

Author: ClaCodes

.cspell/cspell.config.yaml

@@ -0,0 +1,10 @@
+---
+version: '0.2'
+dictionaryDefinitions:
+  - name: project-words
+    path: './project-words.txt'
+    addWords: true
+dictionaries:
+  - project-words
+ignorePaths:
+  - '/project-words.txt'

.cspell/project-words.txt

@@ -0,0 +1,2 @@
+gitlint
+shellcheck

.github/actions/cspell/action.yml

@@ -0,0 +1,13 @@
+---
+name: 'cspell'
+description:
+  'Checks spelling of all files in repo'
+runs:
+  using: 'composite'
+  steps:
+    - run: sudo npm install -g cspell@latest
+      shell: bash
+    - run: echo "::add-matcher::.github/matchers/cspell.json"
+      shell: bash
+    - run: ./scripts/cspell.sh
+      shell: bash

.github/matchers/cspell.json

@@ -0,0 +1,16 @@
+{
+  "problemMatcher": [
+    {
+      "owner": "shellcheck",
+      "pattern": [
+        {
+          "regexp": "^(.+):(\\d+):(\\d+) - (.+)$",
+          "file": 1,
+          "line": 2,
+          "column": 3,
+          "message": 4
+        }
+      ]
+    }
+  ]
+}

.github/workflows/main.yml

@@ -34,3 +34,8 @@ jobs:
     steps:
       - uses: actions/checkout@v4
       - uses: ./.github/actions/jq_format
+  cspell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: ./.github/actions/cspell

.gitignore

@@ -0,0 +1,2 @@
+# Needed for cspell
+.git

scripts/cspell.sh

@@ -0,0 +1,3 @@
+#!/usr/bin/env bash
+set -e
+cspell -c ./.cspell/cspell.config.yaml --no-progress --no-summary --show-suggestions --no-cache --dot --gitignore "**"