Add codespell CI with configuration and fix existing typos - #214
Open
yarikoptic wants to merge 4 commits into
Open
yarikoptic wants to merge 4 commits into
yarikoptic wants to merge 4 commits into
Conversation
- Skip */spec/sites/* (external ruby-doc.org HTML fixtures — not our content) - Skip .git-meta (workflow scratch folder for commit/PR messages) - Add 'nd' to ignore-words-list (ordinal suffix in regex like (st|nd|rd|th)) - Fix actions/checkout@v6 → @v4 to match project's existing CI convention Co-Authored-By: Claude Code 2.1.272 / Claude Sonnet 4.6 <noreply@anthropic.com>
- offical -> official (INSTALLATION.md)
- incudes -> includes (README.md anchor #incudes -> #includes)
- containg -> containing (config/sitediff.example.yaml)
- Intialize -> Initialize (lib/sitediff/api.rb)
Co-Authored-By: Claude Code 2.1.272 / Claude Sonnet 4.6 <noreply@anthropic.com>
=== Do not change lines below ===
{
"chain": [],
"cmd": "uvx codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
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
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 automated spell-checking via codespell and fix 4 existing typos found by it.
Summary
.codespellrc— configuration skipping external test fixtures (*/spec/sites/*— ruby-doc.org HTML files), generated/lock files, and CSS; whitelistsnd(ordinal suffix in regex like(st|nd|rd|th)).github/workflows/codespell.yml— CI check on push and PRs tomasteroffical→official(INSTALLATION.md),incudes→includes(README.md anchor),containg→containing(config/sitediff.example.yaml),Intialize→Initialize(lib/sitediff/api.rb)This project has had prior manual typo-fix commits ("Fix typo's in README", "fix typo in readme", "Fix typo in commandline formatting") — this automates catching them going forward.
More about codespell: https://github.com/codespell-project/codespell
I personally introduced it to over a hundred projects already, mostly with positive feedback
(see the "improveit-dashboard").
CI workflow has
permissionsset only toreadso it should be safe.Test plan
codespellpasses with zero errors🤖 Generated with Claude Code and love for typo-free code