Add codespell support with configuration and fixes#25
Open
yarikoptic wants to merge 4 commits into
Open
Conversation
…s automagically
=== Do not change lines below ===
{
"chain": [],
"cmd": "codespell -w",
"exit": 0,
"extra_inputs": [],
"inputs": [],
"outputs": [],
"pwd": "."
}
^^^ Do not change lines above ^^^
URLs should not be "fixed" even if they contain typos, since rewriting them breaks links. Add `ignore-regex = https?://\S+` so codespell skips anything that looks like an http(s) URL. Co-Authored-By: Claude Code 2.1.154 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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 codespell configuration, CI, and fix existing typos.
More about codespell: https://github.com/codespell-project/codespell
I personally introduced it to over a hundred of projects already mostly with positive feedback
(see the "improveit-dashboard").
CI workflow has
permissionsset only toreadso also should be safe.Changes
Configuration & Infrastructure
.codespellrcwith a minimal skip list (.git,.gitignore,.gitattributes,.codespellrc) andcheck-hidden = true.ignore-regex = https?://\S+so codespell does not "fix" URLs that contain typos (rewriting them would break links)..github/workflows/codespell.ymlrunningcodespell-project/actions-codespell@v2.2on push/PR tomain. Permissions are pinned tocontents: read.Typo Fixes
Three small, unambiguous fixes (applied via
codespell -w, recorded withdatalad run):README.md:Instralling->Installing(section heading)bin/postal:verison->version(×2, in a status message and a comment)Verification
codespellexits cleanly (0 errors) on the current tree.Commits on this branch
d72ab7aAdd GitHub Actions workflow for codespell on mainfae5f99Add rudimentary codespell config86cf2ea[DATALAD RUNCMD] chore: run codespell throughout fixing few left typos automagically3bc59e0codespell: protect URLs via ignore-regexGenerated with the assistance of Claude Code.