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 CSpell checker to CI and fix typos #3590

Merged
merged 23 commits into from
Aug 17, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
23 commits
Select commit Hold shift + click to select a range
9f8f893
monorepo: add cspell, add ALL unknown words to valid words
jochem-brouwer Aug 14, 2024
1eac2dd
cspell: split unknown words in ts/md
jochem-brouwer Aug 14, 2024
657751c
filter out wrong words in cspell-ts.json
jochem-brouwer Aug 14, 2024
b70ae4d
cspell ignore hex values
jochem-brouwer Aug 14, 2024
eb53ed5
fix typos in all packages
jochem-brouwer Aug 14, 2024
2917b95
cspell: use cache
jochem-brouwer Aug 14, 2024
54cb02f
cspell: update commands
jochem-brouwer Aug 14, 2024
5c279c8
cspell: update md/ts words
jochem-brouwer Aug 14, 2024
13d76ca
Typo fixes for README/CHANGELOG files
jochem-brouwer Aug 14, 2024
46fce67
cspell: ensure all relevant monorepo md files are checked
jochem-brouwer Aug 14, 2024
69f30ef
ci: add cspell job
jochem-brouwer Aug 14, 2024
0516265
cspell: update command
jochem-brouwer Aug 14, 2024
675031c
temp add bogus to markdown
jochem-brouwer Aug 14, 2024
8a16bfd
remove bogus spell
jochem-brouwer Aug 14, 2024
fd98684
update ci name
jochem-brouwer Aug 14, 2024
dc1011b
Merge branch 'master' into cspell
jochem-brouwer Aug 14, 2024
fc678e9
Merge branch 'master' into cspell
jochem-brouwer Aug 16, 2024
0cf70d1
fix remaining typos + add words to cspell dict
jochem-brouwer Aug 16, 2024
f14df4b
Update packages/client/CHANGELOG.md
gabrocheleau Aug 16, 2024
c06c642
Update packages/util/CHANGELOG.md
gabrocheleau Aug 16, 2024
dd1f2ff
address review
jochem-brouwer Aug 16, 2024
5167780
Remove almost all `cspell:ignore` (#3599)
jochem-brouwer Aug 17, 2024
6a9c38a
Merge branch 'master' into cspell
jochem-brouwer Aug 17, 2024
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
25 changes: 25 additions & 0 deletions .github/workflows/cspell.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: Spell check (cspell)
on:
push:
branches: [master, develop]
tags: ['*']
pull_request:
types: [opened, reopened, synchronize]
workflow_dispatch:

concurrency:
group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
cancel-in-progress: true

jobs:
run-spellcheck-cspell:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4

- uses: actions/setup-node@v4
with:
node-version: 18
cache: 'npm'

- run: npm run cspell
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -115,3 +115,6 @@ stats.html

## Vitest
__snapshots__

# CSpell
.cspellcache
318 changes: 318 additions & 0 deletions config/cspell-md.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,318 @@
{
"language": "en-US",
"ignoreRegExpList": ["/0x[0-9A-Fa-f]+/"],
"words": [
"Dencun",
"Hardfork",
"acolytec",
"hardfork",
"Holesky",
"MCOPY",
"SELFDESTRUCT",
"BLOBBASEFEE",
"keccak",
"Verkle",
"devnet",
"devp2p",
"hardforks",
"renamings",
"chainsafe",
"secp256k1",
"eips",
"extradata",
"devnets",
"tada",
"statemanager",
"ethash",
"NOTURN",
"subclassing",
"Randao",
"PREVRANDAO",
"Ghorbanian",
"merkle",
"backports",
"behaviour",
"Ethash",
"Chainstart",
"Promisification",
"promisified",
"chainstart",
"callbackify",
"vpulim",
"chaindata",
"leveldb",
"Gitter",
"ethjs",
"ruleset",
"polkadot",
"stabilizations",
"holesky",
"newpayload",
"bootnodes",
"bootnode",
"vmexecution",
"sszify",
"libp2p",
"forkchoice",
"blockhash",
"Dockerfiles",
"blockfetcher",
"txpool",
"subchain",
"enode",
"unpadded",
"Ints",
"reverseblockfetcher",
"forkhash",
"Logvinov",
"Taunas",
"helprpc",
"loglevel",
"Logfile",
"prefund",
"Yolov",
"Calaveras",
"Vinay",
"Pulim",
"Rlpx",
"rlpx",
"hiveview",
"Prysm",
"prysm",
"prysmctl",
"datadir",
"jwtsecret",
"rustup",
"DATADIR",
"maxpeers",
"syncmode",
"nodiscover",
"sealhash",
"Nethermind",
"Merkle",
"ethpandaops",
"Teku",
"prefunded",
"etherbase",
"findneighbour",
"testnetworks",
"testnests",
"DATAFEE",
"MULTIPEER",
"syncpeer",
"Beaconsync",
"datadirs",
"NETWORKID",
"ELCLIENT",
"beaconsync",
"testvectors",
"Snapsync",
"snapsync",
"beaconchain",
"VZWK",
"Rwlk",
"USVGK",
"Kmhd",
"EAAAEAIAAAAAAAAAI",
"Ahtu",
"NBHJMH",
"Nwgi",
"multiaddrs",
"teku",
"nethermind",
"besu",
"Forkid",
"initcode",
"erigon",
"Lvmc",
"DATAHASH",
"BLOBHASH",
"timebased",
"Renamings",
"Authcall",
"Tyneway",
"SLOAD",
"SSTORE",
"calaveras",
"yolov",
"BASEFEE",
"EIPs",
"Forkhash",
"Forkhashes",
"AUTHCALL",
"Kademlia",
"forkid",
"scure",
"paulmillr",
"Neighbours",
"neighbour",
"ecies",
"RLPX",
"BOOTNODES",
"Kbucket",
"datagram",
"UDPPORT",
"TCPPORT",
"ECIES",
"Neighbour",
"findneighbours",
"pydevp",
"mkcache",
"ethashjs",
"validblock",
"rustbn",
"Preimage",
"verkle",
"Preimages",
"modexp",
"roninjin",
"kchojn",
"ripemd",
"Jochem",
"JUMPDEST",
"MLOAD",
"MSTORE",
"KECCAK",
"TLOAD",
"TSTORE",
"Initcode",
"bnadd",
"bnmul",
"fulltext",
"eventemitter",
"Codesize",
"BLOCKHASH",
"selfdestruct",
"jochem",
"brouwer",
"alcuadrado",
"Checkpointing",
"checkpointing",
"MODEXP",
"RIPEMD",
"Rebalance",
"Sina",
"Promisified",
"ecmul",
"Stateroot",
"hotfixing",
"EXTCODEHASH",
"mattdean",
"digicatapult",
"rmeissner",
"jwasinger",
"Agusx",
"Holger",
"danjm",
"whymarrh",
"seesemichaelj",
"axic",
"totalgas",
"RETURNDATA",
"STATICCALL",
"sstore",
"CALLCODE",
"Mgas",
"wemeetagain",
"Schtroumpf",
"holgerd",
"rbtree",
"sdsl",
"vitalik",
"Vitalik",
"Kaustinen",
"faustbrian",
"bmark",
"samlior",
"checkpointed",
"retwrite",
"maindb",
"memdown",
"Rocheleau",
"Vitalik's",
"LMDB",
"lmdb",
"flamegraph",
"thislog",
"thatlog",
"otherlog",
"sublog",
"myscript",
"behaviours",
"unhashed",
"xghi",
"gregthegreek",
"danksharding",
"ecsign",
"Unpadded",
"talentlessguy",
"Nomic",
"unpad",
"Keccak",
"prebuilds",
"keccakjs",
"retesteth",
"testdata",
"Statetest",
"jsontrace",
"nomemory",
"statetest",
"pyethereum",
"evmlab",
"holiman",
"flamegraphs",
"testpath",
"TESTPATH",
"RETESTETH",
"thirdparty",
"hdkey",
"jackalope",
"Libray",
"explcit",
"ricmoo",
"scryptsy",
"randombytes",
"ICAP",
"cryptocoinjs",
"xpub",
"xpriv",
"Thirdparty",
"icap",
"ethereumhdkey",
"dklen",
"hmac",
"Beregszaszi",
"mfornet",
"blockfill",
"Heydiho",
"bazel",
"tlsv",
"lcli",
"extip",
"unauditability",
"ized",
"`scanf`",
"tomonari",
"dryajov",
"dgram",
"krzkaczor",
"libotony",
"xvfb",
"alextsg",
"Merkling",
"ledgerhq",
"accountprivate",
"accountimport",
"echash",
"pubkey",
"unpublish",
"poap",
"nycrc",
"gitpkg",
"multiaddress",
"triggerable",
"MCLBLS",
"heartedly",
"beaconroot"
]
}
Loading
Loading