Skip to content

Commit

Permalink
Add CSpell checker to CI and fix typos (#3590)
Browse files Browse the repository at this point in the history
* monorepo: add cspell, add ALL unknown words to valid words

* cspell: split unknown words in ts/md

* filter out wrong words in cspell-ts.json

* cspell ignore hex values

* fix typos in all packages

* cspell: use cache

* cspell: update commands

* cspell: update md/ts words

* Typo fixes for README/CHANGELOG files

* cspell: ensure all relevant monorepo md files are checked

* ci: add cspell job

* cspell: update command

* temp add bogus to markdown

* remove bogus spell

* update ci name

* fix remaining typos + add words to cspell dict

* Update packages/client/CHANGELOG.md

* Update packages/util/CHANGELOG.md

* address review

* Remove almost all `cspell:ignore` (#3599)

* remove almost all cspell:ignore

* more spell changes

* cspell: fix problems

* evm: fix quadCoefficient

* cspell: fixes

* remove disable line

---------

Co-authored-by: Gabriel Rocheleau <contact@rockwaterweb.com>
  • Loading branch information
jochem-brouwer and gabrocheleau authored Aug 17, 2024
1 parent 0aa7445 commit 4a8761a
Show file tree
Hide file tree
Showing 202 changed files with 2,619 additions and 700 deletions.
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

0 comments on commit 4a8761a

Please sign in to comment.