Add codespell support with configuration and fixes #1058
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- halp: variable name for help parameter - welp: intentional test data key name
- tye: person's name (Tye Wang) in changelog
Fixed typos: - procotol -> protocol (invoke/config.py:119) - pre-emptively -> preemptively (invoke/config.py:363) - whch -> which (invoke/runners.py:1373) - pre-empting -> preempting (sites/docs/concepts/watchers.rst:12) - impove -> improve (sites/www/changelog.rst:60) - Pre-emptively -> Preemptively (sites/www/changelog.rst:333) - refrences -> references (tests/config.py:1077) - stil -> still (tests/config.py:1097) - explicity -> explicitly (tests/program.py:279)
.npm is a local npm cache directory that should not be tracked
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add codespell configuration and fix existing typos.
More about codespell: https://github.com/codespell-project/codespell
I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.
CI workflow has 'permissions' set only to 'read' so also should be safe.
Changes
Configuration & Infrastructure
.codespellrcconfiguration with comprehensive skip patternsmainbranch.git*- version control*.pdf,*.svg,*.css- binary and generated files.npm,.cache- local cache directories*/vendor/*,*/build/*- vendored code and build artifactsDomain-Specific Whitelist
Added legitimate terms that codespell flags as typos:
halp- variable name for help parameter (used throughout program.py)welp- intentional test data key name (used in test fixtures)tye- person's name (Tye Wang) in changelogI recalled that I once looked at doing my codespell'ing but never got to it ... now -- here we go! ;)
Typo Fixes
9 typos fixed in 6 files (all in comments and documentation strings):
procotol→protocol(invoke/config.py:119)pre-emptively→preemptively(invoke/config.py:363)whch→which(invoke/runners.py:1373)pre-empting→preempting(sites/docs/concepts/watchers.rst:12)impove→improve(sites/www/changelog.rst:60)Pre-emptively→Preemptively(sites/www/changelog.rst:333)refrences→references(tests/config.py:1077)stil→still(tests/config.py:1097)explicity→explicitly(tests/program.py:279)All fixes are in comments and documentation strings, with no functional code changes.
Additional Improvement
.npmto.gitignore(local npm cache directory that should not be tracked)Historical Context
This project has had 15 prior commits fixing typos manually, demonstrating the value of automated spell-checking.
Testing
✅ Codespell passes with zero errors after all fixes
🤖 Generated with Claude Code