ci: migrate to cspell for spell checking (thegeeklab#1099)

xoxys · web-flow · commit e93b092680b6 · 2025-11-05T10:18:53.000+01:00
diff --git a/.cspell.json b/.cspell.json
@@ -0,0 +1,53 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "dictionaries": ["en_us", "softwareTerms", "companies", "bash", "html", "css", "typescript"],
+  "words": [
+    "geekdoc",
+    "katex",
+    "flexsearch",
+    "pygments",
+    "Geekdocs",
+    "goldmark",
+    "THEMEDIR",
+    "gohugo",
+    "canonify",
+    "codecopy",
+    "lstore",
+    "lntable",
+    "lastmod",
+    "Preproc",
+    "lntd",
+    "Emph",
+    "anchorwrap",
+    "languagecode",
+    "relref",
+    "linenos",
+    "admonitionblock",
+    "uuidv4",
+    "cfworker",
+    "readmore",
+    "editpage",
+    "codecontainer",
+    "necolas",
+    "Shpak",
+    "Kaussow"
+  ],
+  "ignorePaths": [
+    ".woodpecker",
+    ".cspell.json",
+    ".git",
+    ".gitignore",
+    ".vscode",
+    "*.svg",
+    "renovate.json",
+    "package.json",
+    "config.yaml",
+    "webpack.config.js",
+    "theme.toml",
+    "svgsprite.config.json",
+    "i18n/*"
+  ],
+
+  "ignoreRegExpList": ["&\\S+;", "{{.+}}"]
+}
diff --git a/.dictionary b/.dictionary
diff --git a/.github/settings.yml b/.github/settings.yml
@@ -52,7 +52,7 @@ branches:
       required_status_checks:
         strict: false
         contexts:
-          - ci/woodpecker/pr/test
+          - ci/woodpecker/pr/static
           - ci/woodpecker/pr/build-package
           - ci/woodpecker/pr/docs
       enforce_admins: false
diff --git a/.woodpecker/build-package.yml b/.woodpecker/build-package.yml
@@ -49,4 +49,4 @@ steps:
       - event: [tag]
 
 depends_on:
-  - test
+  - static
diff --git a/.woodpecker/docs.yml b/.woodpecker/docs.yml
@@ -6,18 +6,6 @@ when:
       - ${CI_REPO_DEFAULT_BRANCH}
 
 steps:
-  - name: markdownlint
-    image: quay.io/thegeeklab/markdownlint-cli
-    commands:
-      - markdownlint 'exampleSite/content/**/*.md' 'README.md' 'CONTRIBUTING.md'
-
-  - name: spellcheck
-    image: quay.io/thegeeklab/alpine-tools
-    commands:
-      - spellchecker --files 'exampleSite/content/**/*.md' 'README.md' -d .dictionary -p spell indefinite-article syntax-urls frontmatter --frontmatter-keys title
-    environment:
-      FORCE_COLOR: "true"
-
   - name: assets
     image: docker.io/library/node:lts
     commands:
diff --git a/.woodpecker/notify.yml b/.woodpecker/notify.yml
diff --git a/.woodpecker/static.yaml b/.woodpecker/static.yaml
@@ -8,15 +8,37 @@ when:
 steps:
   - name: eslint
     image: docker.io/library/node:lts
+    depends_on: []
     commands:
       - npm install --quiet --no-progress
       - npm run lint:js
     environment:
       FORCE_COLOR: "true"
 
+  - name: markdownlint
+    image: quay.io/thegeeklab/markdownlint-cli
+    depends_on: []
+    commands:
+      - markdownlint 'exampleSite/content/**/*.md' 'README.md' 'CONTRIBUTING.md'
+
+  - name: spellcheck
+    image: ghcr.io/streetsidesoftware/cspell
+    depends_on: []
+    commands:
+      - cspell-cli lint . --gitignore --color
+
+  - name: link-validation
+    image: docker.io/lycheeverse/lychee
+    depends_on: []
+    commands:
+      - lychee --no-progress --format detailed exampleSite/content/ README.md
+    environment:
+      GITHUB_TOKEN:
+        from_secret: github_token_ro
+
   - name: assets
     image: docker.io/library/node:lts
-    depends_on: [eslint]
+    depends_on: [eslint, markdownlint, spellcheck, link-validation]
     commands:
       - npm install --quiet --no-progress
       - npm run build
@@ -39,15 +61,6 @@ steps:
     environment:
       FORCE_COLOR: "true"
 
-  - name: link-validation
-    image: docker.io/lycheeverse/lychee
-    depends_on: [testbuild]
-    commands:
-      - lychee --no-progress --format detailed exampleSite/content/ README.md
-    environment:
-      GITHUB_TOKEN:
-        from_secret: github_token_ro
-
   - name: page-validation
     image: quay.io/thegeeklab/lhci:0.15
     depends_on: [testbuild]
diff --git a/exampleSite/config/_default/params.yaml b/exampleSite/config/_default/params.yaml
@@ -1,4 +1,6 @@
 ---
+# cspell:ignore socialmedia2
+
 description: >
   Geekdoc is a simple Hugo theme for documentations. It is intentionally designed as a fast and lean theme
   and may not fit the requirements of complex projects. If a more feature-complete theme is required
diff --git a/exampleSite/content/en/asciidoc/admonitions.adoc b/exampleSite/content/en/asciidoc/admonitions.adoc
@@ -2,6 +2,8 @@
 title = "Admonitions"
 +++
 
+// cspell:ignore toclevels
+
 :toc:
 :toclevels: 2
 
diff --git a/exampleSite/content/en/features/icon-sets.md b/exampleSite/content/en/features/icon-sets.md
@@ -1,5 +1,6 @@
 ---
 title: Icon Sets
+# cSpell:ignore svgsprit.es
 ---
 
 {{< toc >}}
diff --git a/exampleSite/content/en/features/multilingual/_index.md b/exampleSite/content/en/features/multilingual/_index.md
@@ -1,5 +1,6 @@
 ---
 title: Multilingual
+# cSpell:ignore Veröffentlichung
 ---
 
 {{< toc >}}
diff --git a/exampleSite/content/en/features/theming/_index.md b/exampleSite/content/en/features/theming/_index.md
@@ -1,5 +1,6 @@
 ---
 title: Theming
+# cspell:ignore msapplication
 ---
 
 {{< toc >}}
diff --git a/exampleSite/content/en/shortcodes/audio/_index.md b/exampleSite/content/en/shortcodes/audio/_index.md
@@ -6,6 +6,7 @@ resources:
     title: Diamonds Trap
     params:
       credits: "[Jakob Eglmeier on openmusic.academy CC0-1.0](https://openmusic.academy/media-library/b9do2E2ZwVCfppyBf2yuej)"
+# cspell:ignore Jakob Eglmeier openmusic
 ---
 
 The audio shortcode allows you to embed audio files.
diff --git a/exampleSite/content/en/shortcodes/images/_index.md b/exampleSite/content/en/shortcodes/images/_index.md
@@ -41,6 +41,7 @@ resources:
     title: Forest (8)
     params:
       credits: "SVG Repo"
+# cspell:ignore Mantri
 ---
 
 If you need more flexibility for your embedded images, you could use the `img` shortcode. It is using Hugo's
diff --git a/exampleSite/content/en/shortcodes/katex.md b/exampleSite/content/en/shortcodes/katex.md
@@ -1,5 +1,6 @@
 ---
 title: KaTeX
+# cspell:ignore infty
 ---
 
 [KaTeX](https://katex.org/) shortcode let you render math typesetting in markdown document.
diff --git a/exampleSite/content/en/usage/configuration.md b/exampleSite/content/en/usage/configuration.md
@@ -1,6 +1,7 @@
 ---
 title: Configuration
 weight: -10
+# cspell:ignore expirydate linktitle publishdate
 ---
 
 {{< toc >}}
diff --git a/exampleSite/content/en/usage/getting-started.md b/exampleSite/content/en/usage/getting-started.md
@@ -1,6 +1,7 @@
 ---
 title: Getting Started
 weight: -20
+# cspell:ignore demosite testlink gohugoio
 ---
 
 This page tells you how to get started with the Geekdoc theme, including installation and basic configuration.
diff --git a/src/js/colorTheme.js b/src/js/colorTheme.js
@@ -46,7 +46,7 @@ function applyTheme(init = true) {
   }
 
   if (!init) {
-    // Reload required to re-initialise e.g. Mermaid with the new theme
+    // Reload required to re-initialize e.g. Mermaid with the new theme
     // and re-parse the Mermaid code blocks.
     location.reload()
   }
diff --git a/src/js/search.js b/src/js/search.js
@@ -146,7 +146,7 @@ function search(input, results, searchConfig) {
 /**
  * Creates links to given fields and either returns them in an array or attaches them to a target element
  * @param {Object} fields Page to which the link should point to
- * @param {HTMLElement} target Element to which the links should be attatched
+ * @param {HTMLElement} target Element to which the links should be attached
  * @returns {Array} If target is not specified, returns an array of built links
  */
 function createLinks(pages, target, showDesc) {
