Add spellcheck to CI (ethereum#382)

* Add spellcheck to CI

Co-authored-by: Paul Harris <[email protected]>

.github/workflows/spellcheck.yml

@@ -0,0 +1,11 @@
+name: Spellcheck
+on: [push, pull_request, workflow_dispatch]
+
+jobs:
+  build:
+    name: Spellcheck
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@master
+    - uses: rojopolis/[email protected]
+      name: Spellcheck

apis/beacon/blocks/blinded_blocks.v2.yaml

@@ -12,7 +12,7 @@ post:
     `BeaconBlock`, and a successful response (20X) only indicates that the broadcast has been
     successful. The beacon node is expected to integrate the new block into its state, and
     therefore validate the block internally, however blocks which fail the validation are still
-    broadcast but a different status code is returned (202). Pre-Bellatrix, this endpoint will accept 
+    broadcast but a different status code is returned (202). Before Bellatrix, this endpoint will accept 
     a `SignedBeaconBlock`. The broadcast behaviour may be adjusted via the `broadcast_validation`
     query parameter.
   parameters:

apis/beacon/blocks/blinded_blocks.yaml

@@ -12,7 +12,7 @@ post:
     `BeaconBlock`, and a successful response (20X) only indicates that the broadcast has been
     successful. The beacon node is expected to integrate the new block into its state, and
     therefore validate the block internally, however blocks which fail the validation are still
-    broadcast but a different status code is returned (202). Pre-Bellatrix, this endpoint will accept 
+    broadcast but a different status code is returned (202). Before Bellatrix, this endpoint will accept 
     a `SignedBeaconBlock`.
   parameters:
     - in: header

apis/beacon/pool/bls_to_execution_changes.yaml

@@ -36,9 +36,9 @@ post:
             $ref: '../../../beacon-node-oapi.yaml#/components/schemas/SignedBLSToExecutionChange'
   responses:
     "200":
-      description: "Bls to execution changes were all stored to the pool and broadcast on the appropriate subnet."
+      description: "BLS to execution changes were all stored to the pool and broadcast on the appropriate subnet."
     "400":
-      description: "Errors in one or more bls to execution changes"
+      description: "Errors in one or more BLS to execution changes"
       content:
         application/json:
           schema:

apis/validator/blinded_block.yaml

@@ -12,7 +12,7 @@ get:
     Metadata in the response indicates the type of block produced, and the supported types of block
     will be added to as forks progress.
     
-    Pre-Bellatrix, this endpoint will return a `BeaconBlock`.
+    Before Bellatrix, this endpoint will return a `BeaconBlock`.
   parameters:
     - name: slot
       in: path

spellcheck.yaml

@@ -0,0 +1,67 @@
+matrix:
+  - name: markdown
+    sources:
+      - '**/*.md|!node_modules/**'
+    aspell:
+      lang: en
+      d: en_US
+      ignore-case: true
+      run-together: true
+      run-together-min: 2
+      run-together-limit: 256
+    dictionary:
+      wordlists:
+        - wordlist.txt
+      encoding: utf-8
+    pipeline:
+    - pyspelling.filters.markdown:
+    - pyspelling.filters.html:
+        comments: false
+        ignores:
+        - code
+        - pre
+  - name: schemas
+    sources:
+      - 'beacon-node-oapi.yaml'
+      - 'params/**/*.yaml'
+      - 'types/**/*.yaml'
+      - 'apis/**/*.yaml'
+    aspell:
+      lang: en
+      d: en_US
+      ignore-case: true
+      run-together: true
+      run-together-min: 2
+      run-together-limit: 256
+    dictionary:
+      wordlists:
+        - wordlist.txt
+      encoding: utf-8
+    pipeline:
+    - pyspelling.filters.url:
+    - pyspelling.filters.context:
+        context_visible_first: true
+        delimiters:
+          - open: ''
+            content: 0x[a-fA-F0-9]+
+            close: ''
+    - pyspelling.filters.context:
+        context_visible_first: true
+        delimiters:
+          - open: 'operationId:.*'
+            close: '$'
+    - pyspelling.filters.context:
+        context_visible_first: true
+        delimiters:
+          - open: 'example:.*'
+            close: '$'
+    - pyspelling.filters.context:
+        context_visible_first: true
+        delimiters:
+          - open: 'title:.*'
+            close: '$'
+    - pyspelling.filters.context:
+        context_visible_first: true
+        delimiters:
+          - open: 'data:.*'
+            close: '$'

types/altair/block.yaml

@@ -14,11 +14,11 @@ Altair:
       parent_root:
         allOf:
           - $ref: '../primitive.yaml#/Root'
-          - description: "The signing merkle root of the parent `BeaconBlock`."
+          - description: "The signing Merkle root of the parent `BeaconBlock`."
       state_root:
         allOf:
           - $ref: '../primitive.yaml#/Root'
-          - description: "The tree hash merkle root of the `BeaconState` for the `BeaconBlock`."
+          - description: "The tree hash Merkle root of the `BeaconState` for the `BeaconBlock`."
 
   BeaconBlockBody:
     type: object

types/bellatrix/state.yaml

@@ -45,7 +45,7 @@ Bellatrix:
           $ref: '../validator.yaml#/Validator'
       balances:
         type: array
-        description: "Validator balances in gwei. Variable length list, maximum 1099511627776 items"
+        description: "Validator balances in Gwei. Variable length list, maximum 1099511627776 items"
         items:
           $ref: '../primitive.yaml#/Uint64'
       randao_mixes:

types/p2p.yaml

@@ -10,7 +10,7 @@ NetworkIdentity:
       items:
         allOf:
           - $ref: "./p2p.yaml#/Multiaddr"
-          - description: "Node's addresses on which eth2 rpc requests are served. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)"
+          - description: "Node's addresses on which eth2 RPC requests are served. [Read more](https://docs.libp2p.io/reference/glossary/#multiaddr)"
     discovery_addresses:
       type: array
       items:

wordlist.txt

@@ -0,0 +1,37 @@
+eth
+cli
+oapi
+redocly
+JSON
+BN
+https
+NodeJs
+npmjs
+npm
+TBD
+Teku
+VC
+UI
+dev
+BLS
+SSZ
+RANDAO
+EIP
+el
+DVT
+MEV
+PayloadAttributesV
+Gwei
+prev
+ENR
+enr
+attnets
+trunc
+Merkle
+RPC
+kzg
+KZGCommitment
+KZGProof
+KZGProofs
+KZGCommitmentInclusionProof
+LMD