Configure cspell

.github/workflows/ci.yml

@@ -3,6 +3,22 @@ name: CI
 on: [push, pull_request]
 
 jobs:
+  spelling:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Node
+        env:
+          DISABLE_V8_COMPILE_CACHE: "1"
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20.9"
+          cache: "yarn"
+          cache-dependency-path: "vscode"
+
+      - name: Run cspell
+        run: yarn global add cspell && cspell
   lint_ruby:
     runs-on: ubuntu-latest
     steps:

cspell.jsonc

@@ -0,0 +1,36 @@
+{
+    "version": "0.2",
+    "dictionaryDefinitions": [
+        {
+        "name": "project-words",
+        "path": "./project-words",
+        "addWords": true
+        }
+    ],
+    // cspell recognizes 'addon' as valid but we want to enforce 'add-on', but not within code
+    "words": [
+      "!addon"
+    ],
+    "ignoreRegExpList": [
+      "\\.addon",
+      "addon\\.",
+      "\\(addon\\)",
+      "@addon",
+      "_addon",
+      "addon\\w+",
+      "addon_",
+      "addon\"",
+      "addon =",
+      "$\\s+addon^",
+      "\\|addon\\|",
+      "addon$" // could have false positives but unlikely
+    ],
+    "language": "en",
+    "files": ["**/*.rb", "**/*.md", "**/*.markdown"],
+    "ignorePaths": [
+      "**/node_modules/**",
+      "vendor/**",
+      "test/fixtures/",
+    ],
+    "dictionaries": ["ruby", "en_US", "shell", "file-types", "project-words"]
+  }

dev.yml

@@ -5,6 +5,7 @@ type: ruby
 up:
   - ruby
   - bundler
+    - cspell
   - node:
       yarn: true
       version: 20.9.0

project-words

@@ -0,0 +1,91 @@
+activestorage
+arefs
+autocorrect
+autoloaded
+autorun
+behavior
+beind
+bigdecimal
+bindir
+binread
+Bizt
+Bizw
+bufnr
+byteslice
+codepoint
+codepoints
+concats
+copen
+corge
+cvar
+dont
+eglot
+eruby
+EXTGLOB
+FIXEDENCODING
+Floo
+fnmatch
+fooo
+hostedtoolcache
+importmap
+indexables
+ipairs
+Itest
+ivar
+Jaro
+Kaigi
+klass
+kwargs
+linearization
+Linearizes
+linearizing
+lockfiles
+lspconfig
+Lstart
+metaprogramming
+mkpath
+nargs
+nodoc
+noreturn
+nvim
+oneline
+overnotify
+qtlzwssomeking
+quickfixes
+quux
+quxx
+rdbg
+realpath
+redudancy
+reparsing
+requireds
+rhtml
+rindex
+rjson
+rmtree
+rubyfmt
+rubylibdir
+rubylibprefix
+setqflist
+shadowenv
+shellwords
+snode
+somethi
+spoom
+streerc
+stringio
+strscan
+subexpression
+supertypes
+suppo
+unaliased
+unindexed
+unparser
+unresolve
+vcall
+Vinicius
+Winkler
+XQRK
+yarp
+YARP
+YJIT