crate-ci / typos Goto Github PK

View Code? Open in Web Editor NEW

2.4K 11.0 93.0 17.17 MB

Source code spell checker

License: Apache License 2.0

Rust 99.92% Shell 0.08% Dockerfile 0.01% Python 0.01% Julia 0.01% PHP 0.01% C++ 0.01%

spell-checker rust cli code-quality

typos's Introduction

typos

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

Documentation

Install

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

Or use Pacman to install:

sudo pacman -S typos

Getting Started

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.

False-positives

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-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 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

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

Integrations

Custom

typos provides several building blocks for custom native integrations

- reads from stdin, --write-changes will be written to stdout
--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

Debugging

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

FAQ

Why was ... not corrected?

Does the file show up in typos --files? If not, check your config with typos --dump-config -. The [files] table controls how we walk files. If you are using files.extend-exclude, are you running into #593? If you are using files.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 in typos --identifiers or the word show up in typos --words? If not, it might be subject to one of typos' heuristics for detecting non-words (like hashes) or unambiguous words (like words after a \ escape).

If it is showing up, likely 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

typos's People

Contributors

Stargazers

Watchers

Forkers

epage isgasho doytsujin onlykumarabhishek mrandreastoth hamdor mendess nmathewson sts0mrg0 cbeltran-tk flakebi danielt998 tiby312 halkeye foriequal0 jplatte dkasak wpgnss zeroxonelk anoadragon453 uyarn ayazhafiz clo4 evanrichter mayhemheroes steffahn bioerrorlog sergiocollado dtrodrigues nathanbaulch alekspickle cbachhuber dupgit notmyfault milieu ncfavier bnjbvr embarkstudios manelmontilla y-yagi xiaoxiang781216 damianbarabonkovqc blacksmoke16 phip1611 fuyufjh calumy dpc lukasgasp ben1009 szepeviktor hofbi dluc not-my-profile mvorisek nikstur leodog896 dosisod adrise harryzcy sebasnabas jiralite 22388o yonasbsd kyu08 crown0815 jbergstroem afranke brianteeman eudoxa rdxworks-actions smerle33 luozhuzhang joao934934 silvrwolfboy alatiera delgan isabella232 tomviner dushyantgoswami tomasreyes sof3 noahp hougesen qsantos haya14busa dyc3 sandutsar zxilly risc0 cybernetics huuff jayvdb

typos's Issues

Detect invalid file types

Ignore binary files

Copy the flags from ripgrep: https://github.com/BurntSushi/ripgrep/blob/master/src/app.rs#L745

Exposed as https://github.com/BurntSushi/ripgrep/blob/master/src/args.rs#L902

Speed up identifier splitting

split_ident allocates into a Vec rather than lazily returning values as an iterator.

Colored output support

This would be relatively easy while improving the scannability of the results.

Define an exit code policy

See https://docs.rs/exit-code/1.0.0/exit_code/

Including broken pipe

Codes of interest

USAGE_ERROR
CONFIG_ERROR
FAILURE for runtime errors?
DATA_ERROR for typos?

Layered config

For large projects, it can be helpful to support layered configs.

Set exit code on typos being found

Audit API

The API has gone through some churn. We should audit it before 1.0 to make sure its something we want.

Speed up detection of binary files

Currently we load the entire file in memory and search for a null byte through all of it.

See #29 for other implementations for how to speed it up

Add codespell to comparison

https://github.com/codespell-project/codespell

Calculate line number / line offset only when typo is found?

Right now we proactively parse out lines and then parse within a line. What if instead we found out our line number by counting the new lines afterwards? This puts the cost on the typo case, which should be rare, rather than on every case when parsing

Support file types embedded in file types?

With #14, we're going to have special handing of different file types but one file isn't always a single type

markdown files that have code fences
- treat markdown as non-code (no identifier support), `` as generic code, and code-fences as the specified language
rust comments have markdown which have code fences
mako files are a mixture of python and whatever the generated type will be.

Provide a message about skipped binary files

I'm thinking this should be one of the programmatic messages sent to stdout rather than using a logging crate.

Correctly detect words when c-escapes are used

foo\nbar will look like foo and nbar without special handling.

Interactive mode?

See https://github.com/myint/scspell/blob/master/scspell/__init__.py#L363 for how scspell does it.

Custom ignores?

Some times files should just be ignore for spelling but work for all others

Render corrections in non-ASCII code correctly

We list the byte offset and not the column
We point to the byte offset, and not the column, in the line

Support correcting the file

Document comparison with related tools

Handke UK vs US english

Perf: remove allocation when case correcting by switching to KString

KStringCow has the following states:

Box<str>
'static str
's str
inlined string

If we add a From to it, we can possibly detect being able to use the inline string and write straight to it, avoiding the allocation when case correcting.

In addition, we'd be dropping from 4 machine words to 3 machine words iirc.