|new 0.9.24||Mar 16, 2023|
|0.9.19||Feb 28, 2023|
|0.9.13||Dec 6, 2022|
|0.9.11||Nov 22, 2022|
|0.2.1||Nov 3, 2019|
#174 in Text processing
2,926 downloads per month
Used in typos-cli
Source code spell checker
Finds and corrects spelling mistakes among source code:
- Fast enough to run on monorepos
- Low false positives so you can run on PRs
Dual-licensed under MIT or Apache 2.0
- Getting Started
- Comparison with other spell checkers
Download a pre-built binary (installable via gh-install).
Or use rust to install:
cargo install typos-cli
Or use Homebrew to install:
brew install typos-cli
Or use Conda to install:
conda install typos
Most commonly, you'll either want to see what typos are available with
Or have them fixed
typos --write-changes typos -w
If there is any ambiguity (multiple possible corrections),
typos will just report it to the user and move on.
Sometimes, what looks like a typo is intentional, like with people's names, acronyms, or localized content.
To mark a word or an identifier (grouping of words) as valid, add it your
_typos.toml by declaring itself as the valid spelling:
[default.extend-identifiers] # *sigh* this just isn't worth the cost of fixing AttributeIDSupressMenu = "AttributeIDSupressMenu" [default.extend-words] # Don't correct the surname "Teh" teh = "teh"
For cases like localized content, you can disable spell checking of file contents while still checking the file name:
[type.po] extend-glob = ["*.po"] check-file = false
typos --type-list to see configured file types)
If you need some more flexibility, you can completely exclude some files from consideration:
[files] extend-exclude = ["localized/*.po"]
typos provides several building blocks for custom native integrations
--write-changeswill be written to
--diffto provide a diff
--format jsonto get jsonlines with exit code 0 on no errors, code 2 on typos, anything else is an error.
# Read file from stdin, write corrected version to stdout typos - --write-changes # Creates a diff of what would change typos dir/file --diff # Fully programmatic control typos dir/file --format json
You can see what the effective config looks like by running
typos --dump-config -
You can then see how typos is processing your project with
typos --files typos --identifiers typos --words
If you need to dig in more, you can enable debug logging with
Why was ... not corrected?
typos doesn't know about it yet
typos maintains a list of known typo corrections to keep the false positive
count low so it can safely run unassisted.
This is in contrast to most spell checking UIs people use where there is a known list of valid words. In this case, the spell checker tries to guess your intent by finding the closest-looking word. It then has a gauge for when a word isn't close enough and assumes you know best. The user has the opportunity to verify these corrections and explicitly allow or reject them.
For more on the trade offs of these approaches, see Design.
- To correct it locally, see also our False Positives documentation.
- To contribute your correction, see Contribute