🐞 fix(Spell check): Spell check CI - false positives

raxhvl commented 5 months ago

Words with special character (hyphen) was added to the wordlist.txt. https://github.com/eth-protocol-fellows/protocol-studies/blob/0e9e8a876ce85ce0e49acdadd6322cc238f95bee/wordlist.txt#L289-L292

Perhaps the contributor missed the warning from instructions. Now, this corrupted wordlist and is causing Aspell to fail within spell check CI workflow.

Screenshot from 2024-04-04 16-17-29

A bug in the CI workflow ignores Aspell errors, causing checks to pass when it shouldn't have.

This PR:

[x] Fixes the bug. The CI fails if ASpell errors out for any reason.
[x] Removes the hyphenated words that corrupted wordlist.
[x] Fixes additional typos that slipped through due to this bug.
[x] Introduces an enhancement: Camel case words are now recognized. No need to add them to wordlist!
[x] Makes the warning about special characters more explicit.

Please consider merging this PR as soon as possible before more typos gets merged.

taxmeifyoucan commented 5 months ago

I am sorry about the wordlist! Merged

raxhvl commented 5 months ago

I am sorry about the wordlist! Merged

Oh no worries! The CI should have flagged it. All good now!

raxhvl commented 5 months ago

@taxmeifyoucan - There is one more fix required. Im pushing it shortly.

eth-protocol-fellows / protocol-studies

🐞 fix(Spell check): Spell check CI - false positives #146