Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add spell-check to Anchor book #45

Merged
merged 11 commits into from
Oct 31, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions .github/workflows/test-suite.yml
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,14 @@ jobs:
env:
# Allow warnings on Nightly
RUSTFLAGS: ""
spell-check:
name: spellcheck
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
# Uses the canonical version so that the version is up to date:
# https://github.com/rojopolis/spellcheck-github-actions?tab=readme-ov-file#using-a-canonical-version
- uses: rojopolis/spellcheck-github-actions@v0
# cli-check:
# name: cli-check
# needs: [check-labels]
Expand Down
23 changes: 23 additions & 0 deletions .spellcheck.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
matrix:
- name: Markdown
sources:
- '!venv/**/*.md|**/*.md'
default_encoding: utf-8
aspell:
lang: en
dictionary:
wordlists:
- wordlist.txt
encoding: utf-8
pipeline:
- pyspelling.filters.markdown:
- pyspelling.filters.html:
comments: false
ignores:
- code
- pre
sources:
- './book/**/*.md'
- 'README.md'
- 'SECURITY.md'
- 'CONTRIBUTING.md'
33 changes: 33 additions & 0 deletions wordlist.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
MacOS
linter
Testnets
testnet
Testnet
QBFT
SSV
validator
libp
middleware
performant
github
sigp
io
sigmaprime
mdBook
spec'd
PRs
Styleguide
clippy
rustfmt
TODOs
config
struct
structs
Config
PathBuf
dir
Exercism
blockchain
Ethereum
HTTPS
repo