Skip to content

Add codespell support with configuration and fixes#830

Closed
yarikoptic wants to merge 5 commits intochaoss:mainfrom
yarikoptic:enh-codespell
Closed

Add codespell support with configuration and fixes#830
yarikoptic wants to merge 5 commits intochaoss:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

Add codespell configuration and fix existing typos. You might ask why to fix typos in old NEWS? I would say -- why to cherish them there?

More about codespell: https://github.com/codespell-project/codespell

I personally introduced it to dozens if not hundreds of projects already and so far only positive feedback.

CI workflow has 'permissions' set only to 'read' so also should be safe.

Changes

Configuration & Infrastructure

  • Added [tool.codespell] section to pyproject.toml
  • Created GitHub Actions workflow (.github/workflows/codespell.yml) to check spelling on push and PRs
  • Configured to skip: .cache, .npm, *.pdf, *.svg, *.css, *.lock, *.min.*, docs/ar/js/* (vendored aframedc.js), kubernetes/* (org config with company names like Absolut, Conexant, Grammer, Synopsys, Infor)

Domain-Specific Whitelist

  • hace — Spanish time expressions in historical changelogs ("hace 52 minutos", "hace 3 días")

Typo Fixes

Ambiguous typos fixed manually (8 fixes with context review):

  • brachesbranches (NEWS, releases/0.3.0.md) — git worktree context
  • typoestypos (releases/old/NEWS) — "Fixed the typos of docker/README.md"
  • ConverConvert (releases/old/NEWS) — "Convert INFO messages to DEBUG"
  • frmofrom (releases/old/NEWS) — "Remove ocean-unique-id from schema"
  • unsecureinsecure (releases/old/NEWS) — standard English term
  • frofor (releases/old/NEWS.old) — "add panel for Kibana 6"
  • confussionsconfusions (releases/old/NEWS.old) — "avoid confusions"
  • ReaddRe-add (releases/old/NEWS.old) — "Re-add support to execute..."

Non-ambiguous typos fixed automatically (71 fixes in 25 files):
Common fixes include: recommmendationsrecommendations, mantainedmaintained, everytimeevery time, viceversavice-versa, incremantalincremental, adressesaddresses, RedifineRedefine, identitesidentities, implemetationimplementation, and many more across NEWS and release notes.

Historical Context

This project has had 15 prior commits fixing typos manually, demonstrating the value of automated spell-checking.

Testing

✅ Codespell passes with zero errors after all fixes


🤖 Generated with Claude Code and love to typos free code

yarikoptic and others added 5 commits March 11, 2026 12:35
- Skip .cache, .npm (cache directories)
- Skip docs/ar/js/* (vendored aframedc.js library)
- Skip kubernetes/* (org config with company names: Absolut, Conexant, etc.)
- Ignore 'hace' (Spanish time expressions in historical changelogs)

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
- braches -> branches (NEWS, releases/0.3.0.md) - git worktree context
- typoes -> typos (releases/old/NEWS:733) - "Fixed the typos of docker/README.md"
- Conver -> Convert (releases/old/NEWS:1423) - "Convert INFO messages to DEBUG"
- frmo -> from (releases/old/NEWS:1530) - "Remove ocean-unique-id from schema"
- unsecure -> insecure (releases/old/NEWS:831) - standard English term
- fro -> for (releases/old/NEWS.old:411) - "add panel for Kibana 6"
- confussions -> confusions (releases/old/NEWS.old:2130) - "avoid confusions"
- Readd -> Re-add (releases/old/NEWS.old:2444) - "Re-add support to execute..."

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 4.6 <noreply@anthropic.com>
Fixed typos across NEWS, releases/, community_components.md, and docs/:
- recommmendations -> recommendations
- unifing -> unifying
- incremantal -> incremental
- reponse -> response
- everytime -> every time
- mantained -> maintained
- viceversa -> vice-versa
- adresses -> addresses
- wass -> was
- indentities -> identities
- appropiate -> appropriate
- analyizes -> analyzes
- mananging -> managing
- compability -> compatibility
- dependecies -> dependencies
- depencency -> dependency
- paramaters -> parameters
- documentaion -> documentation
- Redifine -> Redefine
- and many more across 27 files

Co-Authored-By: Claude Code 2.1.63 / Claude Opus 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 ^^^
@sduenas sduenas closed this Mar 13, 2026
@sduenas sduenas added the wontfix This will not be worked on label Mar 13, 2026
@sduenas
Copy link
Copy Markdown
Member

sduenas commented Mar 13, 2026

Thanks but we aren't interested on adding this workflow to the repository.

@yarikoptic
Copy link
Copy Markdown
Author

Do you want me to submit just typo fixes without workflow?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

wontfix This will not be worked on

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants