Skip to content

Add codespell support with configuration and fixes#23

Open
yarikoptic wants to merge 4 commits intotsmdt:mainfrom
yarikoptic:enh-codespell
Open

Add codespell support with configuration and fixes#23
yarikoptic wants to merge 4 commits intotsmdt:mainfrom
yarikoptic:enh-codespell

Conversation

@yarikoptic
Copy link
Copy Markdown

Add codespell configuration and fix existing typos.

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 in pyproject.toml with skip patterns for .git*, .npm, .cache
  • Created GitHub Actions workflow to check spelling on push to main and PRs
  • Added .npm and .cache to .gitignore (local cache directories that shouldn't be tracked)

Domain-Specific Whitelist

Added legitimate terms that codespell flags as typos:

  • te - ISO 639-1 language code for Telugu
  • fo - ISO 639-1 language code for Faroese

Typo Fixes

Non-ambiguous typos fixed automatically via codespell -w (2 fixes in 2 files):

  • Disply -> Display (whisply/app.py, comment)
  • Extened -> Extended (whisply/little_helper.py, comment)

Both fixes are in comments only - no functional changes.

Historical Context

This project has had 10 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

Fixed typos:
- Disply -> Display (whisply/app.py:126, comment)
- Extened -> Extended (whisply/little_helper.py:360, comment)

=== Do not change lines below ===
{
 "chain": [],
 "cmd": "uvx codespell -w",
 "exit": 0,
 "extra_inputs": [],
 "inputs": [],
 "outputs": [],
 "pwd": "."
}
^^^ Do not change lines above ^^^
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant