From e27a500a157db0cc3a32d784f4e6af811d38a310 Mon Sep 17 00:00:00 2001
From: Ethan Perruzza <ethan.perruzza@gmail.com>
Date: Fri, 24 Jan 2025 11:23:29 +0100
Subject: [PATCH] fixup! ci: add cspell check

Signed-off-by: Ethan Perruzza <ethan.perruzza@gmail.com>
---
 cspell/acronyms.txt       |  31 +++++++
 cspell/cspell.json        |  32 +++++---
 cspell/names.txt          |  16 ++--
 cspell/project-words.txt  | 164 +++++++++++++++-----------------------
 cspell/unwanted-words.txt |   5 +-
 5 files changed, 129 insertions(+), 119 deletions(-)
 create mode 100644 cspell/acronyms.txt

diff --git a/cspell/acronyms.txt b/cspell/acronyms.txt
new file mode 100644
index 000000000..d0309c928
--- /dev/null
+++ b/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
diff --git a/cspell/cspell.json b/cspell/cspell.json
index 5a3e26751..3bea83259 100644
--- a/cspell/cspell.json
+++ b/cspell/cspell.json
@@ -4,6 +4,7 @@
   "files": [
     "**/*.en.md",
     "**/*.fr.md",
+    "*.md",
   ],
   "import": [
     "@cspell/dict-rust/cspell-ext.json",
@@ -11,12 +12,13 @@
     "@cspell/dict-fr-fr/cspell-ext.json",
   ],
   "dictionaries": [ 
-    "sql",
-    "rust",
-    "project-words",
-    "unwanted-words",
+    "acronyms",
     "names",
+    "project-words",
+    "rust",
     "softwareTerms",
+    "sql",
+    "unwanted-words",
   ],
   "overrides": [
     {
@@ -26,6 +28,13 @@
         "en-gb",
       ]
     },
+    {
+      "filename": "*.md",
+      "dictionaries": [
+        "en_US",
+        "en-gb",
+      ]
+    },
     {
       "filename": "**/*.fr.md",
       "dictionaries": [
@@ -36,6 +45,16 @@
   "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",
@@ -46,10 +65,5 @@
       "path": "./unwanted-words.txt",
       "addWords": true
     },
-    {
-      "name": "names",
-      "path": "./names.txt",
-      "addWords": true
-    },
   ],
 }
diff --git a/cspell/names.txt b/cspell/names.txt
index 3383fdd1d..070a31dff 100644
--- a/cspell/names.txt
+++ b/cspell/names.txt
@@ -1,14 +1,14 @@
-Klara
+Bellebia
 Breit
-Senejko's
 Céline
-Morgane
-Loïc
 Dessagne
-Bellebia
 Djamal
-Ménin
-Senejko
-Marchal
 Durupt
+Klara
+Kutta
+Loïc
+Marchal
 Mémin
+Ménin
+Morgane
+Senejko
diff --git a/cspell/project-words.txt b/cspell/project-words.txt
index aaa6c33c1..3bd3aa9f8 100644
--- a/cspell/project-words.txt
+++ b/cspell/project-words.txt
@@ -1,111 +1,75 @@
-OSRD
-VecDeque
-Odoo
-Motis
-möglich
-Remarquable
-opensource
-TVDS
-autonumber
-mgsin
-Isort
-pytype
-stringifying
-mtlynch
-pytest
-parallelizable
-macbooks
-virtiofs
-osxkeychain
-creds
-relref
-balise
-odometry
-Tdriver
-Tindication
-FLOI
-Twarning
-maxmemory
 allkeys
-exploitability
-EPSG
+autonumber
 autosquash
-MRSP
-Dreiländer
-DGEX
-QGIS
-Kutta's
-Kutta
-Runge
-plpgsql
-ABAC
-Sémaphore
-Clignotant
-MARECO
-STDCM
-editoast
-osrdyne
-ERTMS
-Netzgrafik
-Valkey
-ETCS
-rabbitmq
-CODEOWNERS
-tchou
+balise # In English, the French word is used https://en.wiktionary.org/wiki/balise
+Bundesbahnen
 choo
-pathfinding
-topo
-ralen
-BAPR
-xchg
-networker
-openrail
-railjson
-Cruda
-typesystem
-rustc
-privs
-modelv
-privlvl
-unsignaled
-interprétabilité
-GPRS
-FRMCS
-ETML
-EPSF
-DAAT
-COVIT
-VUTR
-VUSS
-CAPI
-BMCV
-IPCS
-ITCS
-TECS
-TSCS
-VUTP
-IPCS
-BMVU
-opendata
-fosdem
+clignotant
+CODEOWNERS
+creds
 devroom
-Österreichische
-Bundesbahnen
-Schweizerische
-Bundesbahnen
-eurobalises
+dreiländer
+editoast
 eurobalise
+eurobalises
+eurocab
 euroloop
-Euroradio
+euroradio
+exploitability
+fosdem
+hashées
+interprétabilité
+isort
+linté
+macbooks
+maxmemory
+mgsin
+modelv
+möglich
+motis
+mtlynch
+networker
+netzgrafik
 odométriques
-eurocab
+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 the English part to exlplain what tge PR acronym is in OSRD
 réplicas
+Runge
+rustc
+schweizerische
 scopé
 scoper
-hashées
-linté
-Transifex
-refacto
-fabriquants
-redistribuable
+sémaphore
+stringifying
+tchou
+Tdriver
+Tindication
+topo
 tractionner
+Transifex
+Twarning
+typesystem
+unsignaled
+Valkey
+VecDeque
+virtiofs
+xchg
diff --git a/cspell/unwanted-words.txt b/cspell/unwanted-words.txt
index 20a234dad..0b96a7b72 100644
--- a/cspell/unwanted-words.txt
+++ b/cspell/unwanted-words.txt
@@ -1,5 +1,6 @@
+autoplay
+dont
 imagepostlinkedin
 marginauto
+opensource
 pageinfo
-dont
-autoplay