feat: spellingscontrole

.github/workflows/spellcheck.yml

@@ -0,0 +1,13 @@
+name: 'Check spelling'
+on: # rebuild any PRs and main branch changes
+  pull_request:
+  push:
+
+jobs:
+  spellcheck: # run the action
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Install dictionaries
+        run: npm install @cspell/dict-nl-nl
+      - uses: streetsidesoftware/cspell-action@v2

.gitignore

@@ -0,0 +1 @@
+node_modules/

README.md

@@ -55,6 +55,22 @@ Lokaal kan vervolgens de documentatie site gebouwd en getest worden met:
 poetry run mkdocs serve
 ```
 
+### Spellingscontrole
+
+Dit project maakt gebruik van [CSpell](https://cspell.org/), een framework voor spellingscontrole dat goed rekening kan houden met code en andere gangbare platte-tekst formaten.
+Het [nl-nl Dictionary](https://github.com/streetsidesoftware/cspell-dicts/tree/main/dictionaries/nl_NL) is gebaseerd op het eerdere werk in Hunspell.
+Dit woordenboek is niet standaard aanwezig en moet expliciet geinstalleerd worden als je CSpell op je eigen computer wilt uitvoeren.
+Spellingscontrole vindt ook online plaats door middel van een GitHub Action.
+
+Lokaal installeren van CSpell en uitvoeren van de spellingscontrole:
+
+```
+npm install -g cspell@latest
+npm install -g @cspell/dict-nl-nl
+cspell link add @cspell/dict-nl-nl
+cspell "**"
+```
+
 ## Roadmap
 
 Voor de [roadmap](https://github.com/orgs/ospo-nl/projects/1) gebruiken we GitHub Projects.
@@ -66,8 +82,8 @@ Dit project is opgezet als een open source project. Iedereen is welkom om bijdra
 ook vrij en geeft ook vrijheid om afgeleide werken te maken. Wij zijn inclusief en maken geen onderscheid in etniciteit,
 sekse of andere persoonlijke voorkeuren; bijdragen worden geacht zich daar aan te houden.
 
-### Licentie 
-Dit project is gelicentieerd onder de **[Creative Commons Attribution 4.0 International
+### Licentie
+Dit project is gelicenseerd onder de **[Creative Commons Attribution 4.0 International
 License](https://github.com/ospo-nl/.github/blob/main/LICENSE)**.
 
 ### Bijdragen

cspell.config.yaml

@@ -0,0 +1,20 @@
+---
+$schema: https://raw.githubusercontent.com/streetsidesoftware/cspell/main/cspell.schema.json
+version: "0.2"
+language: en
+import:
+  - "@cspell/dict-nl-nl/cspell-ext.json"
+dictionaryDefinitions:
+  - name: ospo-nl-dict
+    path: "./ospo-nl-dict.txt"
+    addWords: true
+dictionaries:
+  - ospo-nl-dict
+  - "nl-nl"
+ignorePaths:
+  - "node_modules"
+  # Ignore GIMP files
+  - "**/*.xcf"
+  # Ignore License files that should not be touched
+  - "LICENSE"
+  - "LICENSES/*"

ospo-nl-dict.txt

@@ -0,0 +1,6 @@
+# custom words dictionary for cspell
+OSPO
+mkdocs
+sourcen
+maintainen
+signoff

package.json

@@ -0,0 +1,15 @@
+{
+  "name": "ospo-nl-kennisbank",
+  "version": "0.1.0",
+  "description": "Open Source Program Office NL kennisbank initiative",
+  "repository": "[email protected]:ospo-nl/kennisbank.git",
+  "author": "Marc van Andel <[email protected]>",
+  "license": "CC-BY-4.0",
+  "scripts": {
+    "cspell": "npx cspell '**/*.md'"
+  },
+  "devDependencies": {
+    "@cspell/dict-nl-nl": "^2.2.8",
+    "cspell": "^6.31.1"
+  }
+}