ci: add cspell check

Signed-off-by: Ethan Perruzza <[email protected]>

.github/workflows/code_quality.yml

@@ -27,6 +27,11 @@ jobs:
 
         commit_titles | TERM=xterm-color .github/scripts/check-commit-titles.sh
 
+    - name: Spell check
+      run: |
+        npm install --include=dev
+        npm run spellcheck
+
   check_reuse_compliance:
     runs-on: ubuntu-latest
     steps:

cspell/acronyms.txt

@@ -0,0 +1,31 @@
+ABAC
+BAPR
+BMCV
+BMVU
+CAPI
+COVIT
+Cruda
+DAAT
+DGEX
+EPSF
+EPSG
+ERTMS
+ETCS
+ETML
+FLOI
+FRMCS
+GPRS
+IPCS
+IPCS
+ITCS
+MARECO
+MRSP
+OSRD
+QGIS
+STDCM
+TECS
+TSCS
+TVDS
+VUSS
+VUTP
+VUTR

cspell/cspell.json

@@ -0,0 +1,69 @@
+{
+  "version": "0.2",
+  "language": "en",
+  "files": [
+    "**/*.en.md",
+    "**/*.fr.md",
+    "*.md",
+  ],
+  "import": [
+    "@cspell/dict-rust/cspell-ext.json",
+    "@cspell/dict-sql/cspell-ext.json",
+    "@cspell/dict-fr-fr/cspell-ext.json",
+  ],
+  "dictionaries": [ 
+    "acronyms",
+    "names",
+    "project-words",
+    "rust",
+    "softwareTerms",
+    "sql",
+    "unwanted-words",
+  ],
+  "overrides": [
+    {
+      "filename": "**/*.en.md",
+      "dictionaries": [
+        "en_US",
+        "en-gb",
+      ]
+    },
+    {
+      "filename": "*.md",
+      "dictionaries": [
+        "en_US",
+        "en-gb",
+      ]
+    },
+    {
+      "filename": "**/*.fr.md",
+      "dictionaries": [
+        "fr-fr",
+      ]
+    },
+  ],
+  "allowCompoundWords": false,
+  "caseSensitive": false,
+  "dictionaryDefinitions": [
+    {
+      "name": "acronyms",
+      "path": "./acronyms.txt",
+      "addWords": true
+    },
+    {
+      "name": "names",
+      "path": "./names.txt",
+      "addWords": true
+    },
+    {
+      "name": "project-words",
+      "path": "./project-words.txt",
+      "addWords": true
+    },
+    {
+      "name": "unwanted-words",
+      "path": "./unwanted-words.txt",
+      "addWords": true
+    },
+  ],
+}

cspell/names.txt

@@ -0,0 +1,15 @@
+Bellebia
+Breit
+Céline
+Dessagne
+Djamal
+Durupt
+Klara
+Kutta
+Loïc
+Marchal
+Mémin
+Ménin
+Morgane
+Runge
+Senejko

cspell/project-words.txt

@@ -0,0 +1,74 @@
+allkeys
+autonumber
+autosquash
+balise # In English, the French word is used https://en.wiktionary.org/wiki/balise
+Bundesbahnen
+choo
+clignotant
+CODEOWNERS
+creds
+devroom
+dreiländer
+editoast
+eurobalise
+eurobalises
+eurocab
+euroloop
+euroradio
+exploitability
+fosdem
+hashées
+interprétabilité
+isort
+linté
+macbooks
+maxmemory
+mgsin
+modelv
+möglich
+motis
+mtlynch
+networker
+netzgrafik
+odométriques
+odometry
+Odoo
+opendata
+openrail
+osrdyne
+österreichische
+osxkeychain
+parallelizable
+pathfinding
+plpgsql
+privlvl
+privs
+pytest
+pytype
+rabbitmq
+railjson
+ralen
+redistribuable
+refacto
+relref
+remarquable # We use it in English to explain what the PR acronym is in OSRD
+réplicas
+rustc
+schweizerische
+scopé
+scoper
+sémaphore
+stringifying
+tchou
+Tdriver
+Tindication
+topo
+tractionner
+Transifex
+Twarning
+typesystem
+unsignaled
+Valkey
+VecDeque
+virtiofs
+xchg

cspell/unwanted-words.txt

@@ -0,0 +1,6 @@
+autoplay
+dont
+imagepostlinkedin
+marginauto
+opensource
+pageinfo

package.json

@@ -15,11 +15,16 @@
     "build": "hugo --gc --cleanDestinationDir --minify",
     "build:preview": "hugo --buildDrafts --buildFuture",
     "start": "hugo server",
+    "spellcheck": "cspell -c cspell/cspell.json",
     "test": "echo \"Error: no test specified\" && exit 1",
     "clean": "clean-install"
   },
   "devDependencies": {
+    "@cspell/dict-fr-fr": "^2.2.5",
+    "@cspell/dict-rust": "^4.0.11",
+    "@cspell/dict-sql": "^2.2.0",
     "autoprefixer": "^10.4.17",
+    "cspell": "^8.17.2",
     "hugo-bin-extended": "^0.121.2",
     "postcss": "^8.4.33",
     "postcss-cli": "^11.0.0"