feat: add reusable spellcheck workflow (ipdxco#119)

* feat: added spellcheck workflow for checking spelling

* chore: remove unnecessary permissions from spellcheck

* chore: ignore .mod and .sum files in spellcheck

* chore: show rendered .cspell.json

* chore: trim spellcheck env vars

* chore: report on typos only

* chore: ignore adin and botto

* fix: do not move .cspell.json

* chore: update ignored words list

* chore: update list of ignored words in spellcheck

* chore: add helper cspell fix script

* chore: update cspell yaml config paths

* fix: env substitution in spellcheck

* chore: fix yaml to json conversion

* fix: the spellcheck fixer script

* chore: update the cspell version

* chore: release v1.0.28

Author: galargh

.github/workflows/reusable-spellcheck.yml

@@ -0,0 +1,118 @@
+name: Check Spelling
+
+on:
+  workflow_call:
+
+jobs:
+  spellcheck:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Extend the GitHub context
+        id: github
+        env:
+          BASE_SHA: ${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha }}
+        run: |
+          if [[ -n "$BASE_SHA" ]]; then
+            echo "base_sha=$BASE_SHA" | tee -a $GITHUB_OUTPUT
+            git fetch origin "$BASE_SHA"
+            git diff --name-only "$BASE_SHA" |
+              jq -Rnc '[inputs]' |
+              xargs -I {} -0 echo "changed_files={}" |
+              tee -a $GITHUB_OUTPUT
+          fi
+
+      - id: config
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const fs = require("fs");
+
+            const jsonConfigPaths = [
+              ".cspell.json",
+              "cspell.json",
+              "cspell.config.json",
+            ];
+            const yamlConfigPaths = [
+              ".cspell.yaml",
+              ".cspell.yml",
+              "cspell.yaml",
+              "cspell.yml",
+              "cspell.config.yaml",
+              "cspell.config.yml",
+            ];
+
+            for (const configPath of jsonConfigPaths) {
+              if (fs.existsSync(configPath)) {
+                console.log(`Found config file at ${configPath}`);
+                core.setOutput("path", configPath);
+                core.setOutput("type", "json");
+                return;
+              }
+            }
+
+            for (const configPath of yamlConfigPaths) {
+              if (fs.existsSync(configPath)) {
+                console.log(`Found config file at ${configPath}`);
+                core.setOutput("path", configPath);
+                core.setOutput("type", "yaml");
+                return;
+              }
+            }
+
+      - if: steps.config.outputs.path == ''
+        run: echo '{}' > '.cspell.json'
+
+      - if: steps.config.outputs.type == 'json' && steps.config.outputs.path != '.cspell.json'
+        env:
+          CONFIG_PATH: ${{ steps.config.outputs.path }}
+        run: mv "$CONFIG_PATH" '.cspell.json'
+
+      - if: steps.config.outputs.type == 'yaml'
+        env:
+          CONFIG_PATH: ${{ steps.config.outputs.path }}
+        run: |
+          yq -o=json '.' "$CONFIG_PATH" > '.cspell.json'
+          rm "$CONFIG_PATH"
+
+      - uses: actions/github-script@v7
+        env:
+          IGNORE_WORDS: |
+            Adin
+          IGNORE_PATHS: |
+            **/*.mod
+            **/*.sum
+        with:
+          script: |
+            const fs = require("fs");
+
+            const config = JSON.parse(fs.readFileSync(".cspell.json"));
+
+            config.ignoreWords = config.ignoreWords ?? [];
+            for (const word of process.env.IGNORE_WORDS.trim().split("\n")) {
+              config.ignoreWords.push(word);
+            }
+
+            config.ignorePaths = config.ignorePaths ?? [];
+            for (const path of process.env.IGNORE_PATHS.trim().split("\n")) {
+              config.ignorePaths.push(path);
+            }
+
+            fs.writeFileSync(".cspell.json", JSON.stringify(config, null, 2));
+
+      - run: jq . .cspell.json
+
+      - uses: streetsidesoftware/cspell-action@157048954070986ce4315d0813573a2d8faee361 # v7.1.1
+        with:
+          incremental_files_only: ${{
+              steps.github.outputs.base_sha && !(
+                contains(fromJSON(steps.github.outputs.changed_files), '.github/workflows/spellcheck.yml') ||
+                (
+                  steps.config.outputs.path != '' &&
+                  contains(fromJSON(steps.github.outputs.changed_files), steps.config.outputs.path)
+                )
+              ) && 'true' || 'false'
+            }}
+          config: '.cspell.json'
+          report: typos

CHANGELOG.md

@@ -6,6 +6,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## Unreleased
 
+## [1.0.28] - 2025-07-16
+### Added
+- new `spellcheck` workflow template that uses `cspell` to check spelling
+
 ## [1.0.27] - 2025-06-15
 ### Fixed
 - fixed the latest version check in the `releaser` workflow

scripts/cspell-fix.js

@@ -0,0 +1,52 @@
+#!/usr/bin/env node
+
+const { readFileSync, writeFileSync } = require('fs');
+const { execSync } = require('child_process');
+const { fileURLToPath } = require('url');
+
+const stdout = execSync('cspell lint --reporter @cspell/cspell-json-reporter --report typos --no-exit-code .');
+
+const { issues } = JSON.parse(stdout.toString());
+
+const seen = new Map();
+
+for (const issue of issues) {
+    if (!issue.hasSimpleSuggestions || !issue.hasPreferredSuggestions) {
+        console.debug(`Issue ${issue.text} has no simple, preferred suggestions`);
+        continue;
+    }
+
+    const filePath = fileURLToPath(issue.uri);
+    const text = issue.text;
+
+    if (!seen.has(filePath)) {
+        seen.set(filePath, new Set());
+    }
+
+    if (seen.get(filePath).has(text)) {
+        console.debug(`Skipping ${text} in ${filePath}`);
+        continue;
+    }
+
+    seen.get(filePath).add(text);
+
+    let suggestion;
+    for (const s of issue.suggestionsEx) {
+        if (s.isPreferred) {
+            suggestion = s;
+            break;
+        }
+    }
+
+    if (suggestion === undefined) {
+        console.warn(`No preferred suggestion for ${issue.text}`);
+        continue;
+    }
+
+    const word = suggestion.wordAdjustedToMatchCase ?? suggestion.word;
+
+    const content = readFileSync(filePath, 'utf8');
+    writeFileSync(filePath, content.replaceAll(text, word));
+
+    console.debug(`Replaced ${text} with ${word} in ${filePath}`);
+}

templates/.github/workflows/spellcheck.yml

@@ -0,0 +1,19 @@
+name: Spellcheck
+
+on:
+  pull_request:
+  push:
+    branches: ${{{ .github.protected_branches + [.github.default_branch] | unique }}}
+  workflow_dispatch:
+  merge_group:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name }}-${{ github.event_name == 'push' && github.sha || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  go-check:
+    uses: ipdxco/unified-github-workflows/.github/workflows/reusable-spellcheck.yml@${{{ .config.versions.uci // (.source.tag | sub("\\.[^\\.]+\\.[^\\.\\-\\+]+(?=\\-|\\+|$)"; "")) }}}