Add codespell support: expand config, fix typos - #787
Closed
yarikoptic wants to merge 7 commits into
Closed
Conversation
Skip: - Frozen v2.1 committee specification deliverables (sarif-2.1/prose/*.htm, *.json, *.docx, *.pdf, *.zip) - Generated v2.2 draft deliverables in sarif-2.2/prose/share/ (regenerated from sarif-2.2/prose/edit/src) - Binary formats (*.pdf, *.docx, *.zip) and *.css Ignore-regex: URLs (link targets must stay verbatim; e.g. avoids "fixing" `synopsys.com` in citation URLs). Ignore-words-list: - pres: variable name in toccata.py, short for "present" - synopsys: company name referenced in acknowledgements - ned: Ned Freed - IETF person referenced in normative references Co-Authored-By: Claude Code 2.1.215 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Typos with multiple candidate corrections that codespell -w won't touch; resolved by reading surrounding context in meeting minutes: - throught -> through (220526_SARIF_TC_59.md:106, 260507_SARIF_TC_108:123) - "leads through the reports", "walked all through the precision PR" - fot -> for (230119_SARIF_TC_72.md:113) - "design recommendations for the TC" - disuss -> discuss (240111_SARIF_TC_83.md:130) - "All discuss the suggested name change" - thorugh -> through (250410_SARIF_TC_98.md:179) - "Walks all through the change set of 685" - Nome -> None (240711_SARIF_TC_89.md:120) - empty section for "Review outcomes of subgroup discussions" (codespell suggested "Gnome", which is wrong here) Also protect `<sup>nd</sup>` (as in "2nd Edition") in the normative references with an inline `<!-- codespell:ignore nd -->` pragma so a future genuine `nd` typo would still be caught elsewhere. Co-Authored-By: Claude Code 2.1.215 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
.git-meta/ is a local scratch dir (git-excluded, not committed) that holds transient commit/PR message drafts. Codespell picks it up on local runs and reports "typos" in the commit-message drafts. Suppress that noise. Co-Authored-By: Claude Code 2.1.215 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Single-suggestion typos across meeting minutes, source markdown, and
a helper script. Fixed:
- Assitant -> Assistant
- Invidual -> Individual
- Malcom -> Malcolm (David Malcolm - actual name)
- Mircosoft -> Microsoft
- Uniocde -> Unicode
- Vulnerabiliy -> Vulnerability
- Whats -> What's
- acount -> account
- activies -> activities
- additioanl -> additional
- advertized -> advertised
- aplication -> application
- candiate -> candidate
- cannnot -> cannot
- capabilties -> capabilities
- colateral -> collateral
- committe -> committee
- coresponding -> corresponding
- dependant -> dependent
- desing -> design
- enabe -> enable
- enforcable -> enforceable
- essentailly -> essentially
- gerenated -> generated
- isue -> issue
- larg -> large
- mebers -> members
- mechanismn -> mechanism
- minumum -> minimum
- occurences -> occurrences
- paralle -> parallel
- prefered -> preferred
- re-used -> reused
- sematically -> semantically
- specifc -> specific
- suppresions -> suppressions
- swithcing -> switching
- traveral -> traversal
- unanimuous -> unanimous
- vie -> via
- withough -> without
Co-Authored-By: Claude Code 2.1.215 / Claude Opus 4.7 (1M context) <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 ^^^
Fixing "Invidual" -> "Individual" widened that field by two chars, pushing the trailing "- Attendee" column two spaces to the right of the other attendee rows. Restore the original column alignment. Co-Authored-By: Claude Code 2.1.215 / Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Contributor
|
Closing without action. Reasoning: The PR looks like spam, we rejected such spellcheck "attacks" before, and the PR has no useful scope. |
Author
|
if you consider carrying out typos useful, then indeed attempt to fix them could be considered SPAM. I wonder what other contributions would fall under the same umbrella? |
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.
Introduces automated spell-checking with codespell and fixes the typos it found.
The rudimentary config and CI workflow already on
mainare extended here with skip patterns for frozen/generated deliverables, a URL-preserving regex, a small whitelist of domain terms, and then all remaining hits are fixed. Repository history includes ~48 prior commits mentioning "typo"/"spell", so an automated check should pay for itself quickly.CI workflow's
permissionsremainscontents: read— safe to enable.I have introduced codespell to over a hundred of projects already, mostly with positive feedback.
Summary
.codespellrc): skip frozen v2.1 deliverables (sarif-2.1/prose/*.htm,*.json), generated v2.2 draft (sarif-2.2/prose/share/*), binary formats, and local.git-meta/; ignore URLs via regex; whitelistpres,synopsys,ned.codespell -w(41 unique typos across 29 files) — recorded as a[DATALAD RUNCMD]commit for reproducibility.minutes-template.txtafterInvidual→Individualwidened it.<!-- codespell:ignore nd -->on the line containing2<sup>nd</sup>in the normative references, so a future genuinendtypo would still be caught elsewhere.Codespell now passes with zero errors.
Details
Files not touched (excluded via
skip)sarif-2.1/prose/*.htm,*.json,*.docx,*.pdf,*.zipsarif-2.2/prose/share/*sarif-2.2/prose/edit/src/*.md— fixes belong upstream inedit/src.*.pdf,*.docx,*.zip,*.css.git-metaWhitelist (
ignore-words-list)pressarif-2.2/prose/edit/bin/toccata.py, short for "present" (contrasts withpast).synopsysacknowledgements.md. Also appears in citation URLs (which are covered by the URL regex).nedAmbiguous typos fixed manually
meeting_minutes/220526_SARIF_TC_59.md:106throughtthroughmeeting_minutes/230119_SARIF_TC_72.md:113fotformeeting_minutes/240111_SARIF_TC_83.md:130disussdiscussmeeting_minutes/250410_SARIF_TC_98.md:179thorughthroughmeeting_minutes/240711_SARIF_TC_89.md:120NomeNoneGnome, wrong here).meeting_minutes/260507_SARIF_TC_108:123throughtthroughNon-ambiguous typos (single suggestion, applied via
codespell -w)Assitant → Assistant,Invidual → Individual,Malcom → Malcolm(David Malcolm, actual name),Mircosoft → Microsoft,Uniocde → Unicode,Vulnerabiliy → Vulnerability,Whats → What's,acount → account,activies → activities,additioanl → additional,advertized → advertised,aplication → application,candiate → candidate,cannnot → cannot,capabilties → capabilities,colateral → collateral,committe → committee,coresponding → corresponding,dependant → dependent,desing → design,enabe → enable,enforcable → enforceable,essentailly → essentially,gerenated → generated,isue → issue,larg → large,mebers → members,mechanismn → mechanism,minumum → minimum,occurences → occurrences,paralle → parallel,prefered → preferred,re-used → reused,sematically → semantically,specifc → specific,suppresions → suppressions,swithcing → switching,traveral → traversal,unanimuous → unanimous,vie → via,withough → without.Notable fixes in editable source (not just meeting minutes)
sarif-2.2/prose/edit/src/converters.md:sematically→semanticallysarif-2.2/prose/edit/src/file-format-17-runautomationdetails-object.md:withough→withoutsarif-2.2/prose/edit/src/file-format-19-toolcomponent-object.md:minumum→minimumsarif-2.2/prose/edit/src/file-format-27-result-object.md:enabe→enablesarif-2.2/prose/edit/bin/toccata.py:gerenated→generated(comment)sarif-2.2/prose/README.md:coresponding→corresponding(2x)Future.md:prefered→preferredCONTRIBUTING.md:re-used→reusedTest plan
codespellpasses with zero errors on the branch tip🤖 Generated with Claude Code and love to typo-free code