-
Notifications
You must be signed in to change notification settings - Fork 175
Open
Description
The problem
Currently, there is no automated way to catch spelling mistakes in documentation files (*.md), code comments, docstrings, and UI widget names. Typos reduce readability, look unprofessional, and cause confusion—especially for non-native English speakers.
Recent example: Issue #2371 identified several spelling errors (incase, everytime, wont, posess, seperator) that could have been caught automatically before committing.
Requested Solution
Add codespell to the existing pre-commit configuration (.pre-commit-config.yaml) to catch spelling errors locally before commits are made.
Example pre-commit hook:
- repo: https://github.com/codespell-project/codespell
rev: v2.2.6
hooks:
- id: codespell
args: [--ignore-words-list, "borg,vorta,deduplicated,uncompress"]
exclude: "^(.*\\.ts|.*\\.lock)$"Benefits:
- Catches typos before code is pushed
- No CI changes needed—uses existing pre-commit infrastructure
- Runs automatically for contributors who use
pre-commit install - Lightweight and fast
Alternatives
- CI-based spell-checking — Adds CI complexity and slower feedback loop
- Manual review — Current approach; error-prone and time-consuming
- Use
typosinstead ofcodespell— Lower false-positive rate but less mature pre-commit support
Additional context
- Vorta already uses pre-commit hooks (ruff, trailing whitespace, etc.)
- A custom ignore-words list can exclude project-specific terms
- Translation files (
.ts) should be excluded to avoid false positives on non-English strings
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
No labels