Spell Checker #8495
Draft
Spell Checker #8495
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
Add crate-ci/typos spell checker to the project for automatic spell checking: - Add _typos.toml configuration in .github/ (next to golangci config) - Exclude generated protobuf files (*.pb.go, *.proto, etc.) - Add typos job to GitHub Actions linters workflow - Add lint-typos and lint-typos-changed targets to Makefile - lint-typos-changed checks only files changed from main (fast for local dev) - Integrate lint-typos-changed into main lint target for faster local runs - Document inline ignore directives and --file-list usage in config The spell checker will run in CI on all files, while local make lint will only check changed files for better performance.
Added exceptions for intentional "misspellings" and false positives: - Preemptable (used instead of Preemptible for caller types) - ba, Ue, nd, abd (test data and hash strings) - AVAILABILTY (backwards-compatible environment variable) - Heartbeart/heartbeart (proto-generated field names - need proto fix first) - SVG file exclusion (hex color codes trigger false positives) - testdata directory exclusion - json.gz file exclusion These exceptions prevent the typo linter from flagging legitimate code patterns and test data while still catching real spelling errors. 🤖 Generated with [Claude Code](https://claude.com/claude-code)
chaptersix
commented
Oct 16, 2025
chaptersix
commented
Oct 16, 2025
chaptersix
commented
Oct 16, 2025
| @@ -0,0 +1,63 @@ | |||
| # Configuration for typos spell checker | |||
There was a problem hiding this comment.
generated by getting an agent to attempt spell corrections and propose exclusions.
|
|
chaptersix
commented
Oct 16, 2025
| @if command -v $(TYPOS) >/dev/null 2>&1; then \ | ||
| $(TYPOS) --config .github/_typos.toml; \ | ||
| else \ | ||
| printf $(RED) "WARNING: typos is not installed. Install it from https://github.com/crate-ci/typos or run: cargo install typos-cli"; \ |
There was a problem hiding this comment.
opted to warn instead of installing. Open to changing this if there's a good pattern to follow for installation
chaptersix
commented
Oct 16, 2025
Comment on lines
+21
to
+25
| AVAILABILTY = "AVAILABILTY" | ||
| # Proto-generated field names that have typos in the proto definition | ||
| # These should be fixed in the proto file first, then regenerated | ||
| Heartbeart = "Heartbeart" | ||
| heartbeart = "heartbeart" |
There was a problem hiding this comment.
I'll double check these
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.
What changed?
typoscli tool to the linters in the Makfile and CIWhy?
Reduce the amount of misspellings while not being overly burdensome.
How did you test it?
Potential risks
Too much time and effort being used on adding exclusion.