Skip to content

chore(deps,tooling,ci): replace pyspelling with codespell in tox #1715

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 8 commits into from
Jun 6, 2025

Conversation

danceratopz
Copy link
Member

🗒️ Description

Use codespell instead of pyspelling in the spellcheck tox environment.

Benefits over pyspelling:

  1. Catches more errors; checks filenames.
  2. Doesn't require a word list (whitelist.txt).
  3. Automated fixes: Single-suggestion spelling errors can be fixed with --write-changes
  4. Fast execution: No external dependencies like aspell required

whitelist.txt is kept for now, it's still used by the VS Code cspell extension.

🔗 Related Issues

Fixes #811

✅ Checklist

  • All: Set appropriate labels for the changes.
  • All: Considered squashing commits to improve commit history.
  • All: Added an entry to CHANGELOG.md.
  • All: Considered updating the online docs in the ./docs/ directory.

@danceratopz danceratopz added scope:ci Scope: Continuous Integration type:chore Type: Chore scope:tooling Scope: Python tools (uv, ruff, tox,...) scope:deps Scope: Updates package dependencies labels Jun 5, 2025
Copy link
Member

@marioevz marioevz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks!

@marioevz marioevz merged commit 8c3cbd7 into main Jun 6, 2025
26 checks passed
@marioevz marioevz deleted the chore/add-codespell branch June 6, 2025 07:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope:ci Scope: Continuous Integration scope:deps Scope: Updates package dependencies scope:tooling Scope: Python tools (uv, ruff, tox,...) type:chore Type: Chore
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chore: replace flake8, flake8-spellcheck, isort and black with ruff and codespell
2 participants