Repository navigation
Add codespell support with configuration and fixes - #53
Open
yarikoptic wants to merge 5 commits into
Open
yarikoptic wants to merge 5 commits into
yarikoptic wants to merge 5 commits into
Conversation
…lings - skip verbatim SPDX license texts (assets/database/licenses/, database_keywords.json and processor/constants.go which embeds them), plus .git-meta and .*cache - ignore "te" (loop variable) and "dependenices" (verbatim typo in a real-world license fixture in pkg/license_test.go) - inline pragma for intentionally misspelled license filenames in lc.go Co-Authored-By: Claude Code 2.1.305 / Claude Opus 5.5 <noreply@anthropic.com>
- altunate -> alternate (CONTRIBUTING.md) - SDPX -> SPDX (CONTRIBUTING.md, what-we-look-at.md) - "has has" -> "has" (NOTES.md) Co-Authored-By: Claude Code 2.1.305 / Claude Opus 5.5 <noreply@anthropic.com>
Fixed typos:
- seperated -> separated (README.md, lc.go)
- souce -> source, exmaple -> example (CONTRIBUTING.md)
- matchs -> matches, extention -> extension (NOTES.md)
- ouput -> output, addtional -> additional (README.md)
- resonable -> reasonable (assets/database/README.md)
Co-Authored-By: Claude Code 2.1.305 / Claude Opus 5.5 <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
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.
Summary
Add codespell configuration, a CI workflow that runs it on pushes and PRs to
master, and fixes for the existing typos. The workflow'spermissionsare read-only, so it should be safe to add. I've added codespell to over a hundred projects, and the feedback has mostly been positive (see the improveit-dashboard).The verbatim SPDX license texts (
assets/database/licenses/,database_keywords.json, andprocessor/constants.go, which embeds them) are skipped. They are upstream texts, some of them not in English, and must stay byte-identical. All typo fixes are in docs and comments. None of them changes behavior.Details
Configuration (
.codespellrc).git,.git-meta,.*cache,go.sum,vendor,*.lock, plus the license databases abovete: loop variable inprocessor/detector_license.godependenices: verbatim typo in honk's license text, used as a test fixture inpkg/license_test.gocodespell:ignoreinlc.gofor the misspelled license filenameslisence/lisensethat the tool deliberately matchesTypo fixes
altunate→alternate,SDPX→SPDX,has has→hascodespell -w, recorded withdatalad runso it can be rerun:seperated,souce,exmaple,matchs,extention,ouput,addtional,resonableHistorical context
The git history already has about 6 commits that fixed typos by hand.
Test plan
codespellpasses with zero errors--builtin clear,rare,usage,code,names) found nothing worth changing (onlymaster,iff,ws)🤖 Generated with Claude Code and love to typos free code