chore: add incremental spellcheck

This commit is contained in:
Jazz Turner-Baggs 2025-02-25 23:11:48 -08:00
parent 25e3f5a09a
commit f61c8993d1
No known key found for this signature in database
3 changed files with 68 additions and 0 deletions

View File

@ -0,0 +1,28 @@
name: Spellcheck(Incremental)
on:
pull_request:
branches:
- '**'
workflow_dispatch:
jobs:
spelling:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- name: Get all changed markdown files
uses: tj-actions/changed-files@v45
id: changed_files
with:
files: |
**.md
- name: Run Spellcheck
id: spellcheck
uses: rojopolis/spellcheck-github-actions@v0
with:
task_name: Markdown
source_files: ${{ steps.changed_files.outputs.all_changed_files }}
config_path: .spellcheck.yml

17
.spellcheck.yml Normal file
View File

@ -0,0 +1,17 @@
matrix:
- name: Markdown
sources:
- '**/*.md'
expect_match: false # false -> supress errors if no markdown files were edited
aspell:
lang: en
dictionary:
wordlists:
- .wordlist.txt
encoding: utf-8
pipeline:
- pyspelling.filters.markdown
- pyspelling.filters.text
default_encoding: utf-8
suggest: true

23
.wordlist.txt Normal file
View File

@ -0,0 +1,23 @@
ALLOC
IANA
SHARDING
WAKU
Waku
danielkaiser
creativecommons
github
GITHUB
https
iana
md
rfc
RFC
www
DHT
DoS
GossipSub
gossipsub
libp2p
pubsub
subnets
ZXCV