Merge pull request #25 from waku-org/spellcheck-fix

Update Spellcheck Workflow

.github/workflows/spelling.yml

@@ -1,4 +1,3 @@
-# This is workflow for spell checking using PySpelling lib (https://pypi.org/project/pyspelling/)
 name: Spellcheck
 
 on:
@@ -11,12 +10,16 @@ on:
   workflow_dispatch:
 
 jobs:
-  build:
+  spellcheck:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v2
-      - uses: igsekor/pyspelling-any@v1.0.4
+
-        name: Spellcheck
+      - name: Install aspell
-        env:
+        run: sudo apt-get install -y aspell aspell-en
-          MATRIX: ${{ toJson(matrix) }}
+
-          run: pyspelling --matrix "$MATRIX"
+      - name: Run spellcheck
+        uses: igsekor/pyspelling-any@v1.0.4
+        with:
+          args: "-c ./spellcheck.yaml"
+

spellcheck.yaml

@@ -2,3 +2,39 @@ matrix:
 - name: markdown
   sources:
   - '**/*.md'
+  default:
+    dictionary: 
+    - en_US
+    - en_GB
+    encoding: utf-8
+    pipeline:
+      - pyspelling.filters.markdown:
+          extensions:
+            - .md
+      - pyspelling.filters.text
+    sources:
+      - '**/*.md'
+    suggest: true
+    whitelist:
+    - ALLOC
+      - IANA
+      - SHARDING
+      - WAKU
+      - Waku
+      - danielkaiser
+      - creativecommons
+      - github
+      - GITHUB
+      - https
+      - iana
+      - md
+      - rfc
+      - RFC
+      - www
+      - DHT
+      - DoS
+      - GossipSub
+      - gossipsub
+      - libp2p
+      - pubsub
+      - subnets