Add CSpell checker to CI and fix typos #3590
Conversation
There was a problem hiding this comment.
Really important: please do not merge this yet respectively do not run the execution part (the doc changes), otherwise integrating the release PR #3527 changes into master will be a total merge hell!!
(I mentioned this kind of problem set a couple of times in the chat, actually I am getting a bit tired to always need to play the last guard resort to look for these kind of things 😳)
Apart from this base complaint this is really a great PR though! 😄
|
I think I got a little bit too enthusiastic, because I was aware of this (this is also the reason why I have split up the md/ts files and have not committed any typedoc changes). Have marked PR as draft so it also cannot be accidentally merged. |
|
Haha, then maybe just mention it and mark as "blocked" to reduce my 😱 moments! 😂 |
|
Once we merge this, I suggest the spell check job is added to the required CI jobs. |
|
I didn't know we had THAT many spelling mistakes in our docs 🤯 (so many POAP opportunities lost 😂 ). |
|
@scorbajio See #3599, I did those renames there :) I think I will actually merge that one into this PR before moving it into master (after I've finished the CI conflicts) |
* remove almost all cspell:ignore * more spell changes * cspell: fix problems * evm: fix quadCoefficient * cspell: fixes * remove disable line
jochem-brouwer
requested review from
holgerd77
and removed request for
holgerd77
|
Thanks for all the reviews 👍 😄 |
* 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>
|
Looking at this once again, and this is really monumental! 🤯 One of the big structural updates for the whole monorepo! 💯 🎉 |
…Code put() Fix, VerkleSM out, runTx()+Code Opts) (#3601) * Use shallowCopy() Caches copy() optimization also for VerkleSM to avoid Caches bundling on non-Caches default * Fix default state manager missing direct code write when used without caches * Do not initialize caches for default VM state manager * Remove copy test not making sense any more under generalized cache/no-cache conditions * Some more solid/qualified EVM dummy blockchain + interface naming to allow for exporting * Use EVMMockBlockchain(Interface) as default for the VM, adjust some tests * Move @ethereumjs/blockchain to dev dependencies in VM * Rebuild package-lock.json * Adjust/fix some client tests * Lint fix * Add Verkle SM methods as optional methods to interface, replace VerkleSM imports and castings in VM * Also align client (no real effect yet, but generally try to work more on the interfaces and not the classes directly) * Initialize runTx() default block with simpler constructor to avoid drawing all txs in * Fully switch to DEFAULT_HEADER in VM.runTx() to avoid drawing in block code * Opcode list size optimization * More optimizations * Precompile code optimizations * More optimizations (precompile index.ts file) * Some more * Some doc compatification * Add CSpell checker to CI and fix typos (#3590) * 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> * Fix spell check * Remove accidentally committed examples/test.ts file --------- Co-authored-by: Jochem Brouwer <jochembrouwer96@gmail.com> Co-authored-by: Gabriel Rocheleau <contact@rockwaterweb.com>
This PR adds
cspellto the CI. To use it locally, from the repository root, usenpm run cspell. This will spell-check all *.ts files in the packages. It will also check the markdown, but it will not check the markdowns in the docs.The output of cspell will give context and - if possible - also give word suggestions how to fix it.
If a word is clearly correct but cspell flags it, add it to the words list in
config/cspell-md.json(for markdown) orconfig/cspell-ts.json. There are two jsons, one for scripts and one for the md files.If a word is intentionally incorrect, but it should be ignored, add
// cspell:disable-lineto a script or<!--- cspell:disable-line --->to a markdown file.The CI will trigger the
npm run cspelljob, if it finds any mistakes, the CI will throw.** To review this **:
Please check the
config/cspell-md.jsonand theconfig/cspell-ts.jsonfor any words which I have marked as correct, but they are still wrong. Some words might need context on why these are added, to check: remove the file from the json, save the file, and then runnpm run cspell:tsfor scripts ornpm run cspell:mdfor markdown to see the context in which this word is found.