Repository files navigation

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 underMIT orApache 2.0

• Installation
• Getting Started
  • False Positives
  • Integrations
    • GitHub Action
    • pre-commit
    • Custom
  • Debugging
• Reference
• FAQ
• Comparison with other spell checkers
• Projects using typos
• Benchmarks
• Design
• Contribute
• CHANGELOG

Download a pre-built binary(installable viagh-install).

Or use rust to install:

$cargo install typos-cli

Or useHomebrew to install:

$brew install typos-cli

Or useConda to install:

$conda install typos

Or usePacman to install:

$sudo pacman -S typos

Most commonly, you'll either want to see what typos are available with

$typos

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 to your_typos.toml by declaring itself as the valid spelling:

[default]extend-ignore-identifiers-re = [# *sigh* this just isn't worth the cost of fixing"AttributeID.*Supress.*",][default.extend-identifiers]# *sigh* this just isn't worth the cost of fixingAttributeIDSupressMenu ="AttributeIDSupressMenu"[default.extend-words]# Don't correct the surname "Teh"teh ="teh"

For more ways to ignore or extend the dictionary with examples, see theconfig reference.

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

(runtypos --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"]

• GitHub Actions
• pre-commit
• 🐊Putout Processor
• Visual Studio Code
• typos-lsp (Language Server Protocol server)

typos provides several building blocks for custom native integrations

• - reads fromstdin,--write-changes will be written tostdout
• --diff to provide a diff
• --format json to get jsonlines with exit code 0 on no errors, code 2 on typos, anything else is an error.

Examples:

$# 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-v

Does the file show up intypos --files?If not, check your config withtypos --dump-config -.The[files] table controls how we walk files.If you are usingfiles.extend-exclude,are you running into#593?If you are usingfiles.ignore-vcs = true,is the file in your.gitignore but git tracks it anyways?Prefer allowing the file explicitly (see#909).

Does the identifier show up intypos --identifiers or the word show up intypos --words?If not, it might be subject to one of typos' heuristics fordetecting non-words (like hashes) orunambiguous words (like words after a\ escape).

If it is showing up, likelytypos doesn't know about it yet.

typos maintains a list of known typo corrections to keep the false positivecount low so it can safely run unassisted.

This is in contrast to most spell checking UIs people use where there is aknown list of valid words. In this case, the spell checker tries to guess yourintent by finding the closest-looking word. It then has a gauge for when aword isn't close enough and assumes you know best. The user has theopportunity to verify these corrections and explicitly allow or reject them.

For more on the trade offs of these approaches, seeDesign.

• To correct it locally, see also ourFalse Positives documentation.
• To contribute your correction, seeContribute