Source code spell checker
Find a file
Ed Page b99f32dea8 perf(dict): Bypass vars when possible
Variant support slows us down by 10-50$.  I assume most people will run
with `en` and so most of this overhead is to waste.  So instead of
merging vars with dict, let's instead get a quick win by just skipping
vars when we don't need to.  If the assumptions behind this change over
time or if there is need for speeding up a specific locale, we can
re-address this.

Before:
```
check_file/Typos/code   time:   [35.860 us 36.021 us 36.187 us]
                        thrpt:  [8.0117 MiB/s 8.0486 MiB/s 8.0846 MiB/s]
check_file/Typos/corpus time:   [26.966 ms 27.215 ms 27.521 ms]
                        thrpt:  [21.127 MiB/s 21.365 MiB/s 21.562 MiB/s]
```
After:
```
check_file/Typos/code   time:   [33.837 us 33.928 us 34.031 us]
                        thrpt:  [8.5191 MiB/s 8.5452 MiB/s 8.5680 MiB/s]
check_file/Typos/corpus time:   [17.521 ms 17.620 ms 17.730 ms]
                        thrpt:  [32.794 MiB/s 32.999 MiB/s 33.184 MiB/s]
```

This puts us inline with `--no-default-features --features dict`

Fixes #253
2021-05-19 13:55:41 -05:00
.github Upgrade to GitHub-native Dependabot 2021-04-28 22:03:08 +00:00
benches refactor(cli)!: Shift Report impls to bin 2021-05-12 19:51:41 -05:00
benchsuite perf: Multi-threaded spell checking 2020-03-21 14:22:53 -05:00
crates perf(dict): Bypass vars when possible 2021-05-19 13:55:41 -05:00
docs docs: Switch from blacklist language 2021-04-30 20:49:01 -05:00
src perf(dict): Bypass vars when possible 2021-05-19 13:55:41 -05:00
.clog.toml fix(docs): Replace mentions of scorrect with typos 2021-01-10 23:13:38 -05:00
.gitignore Initial commit 2019-01-22 15:01:33 -07:00
.ignore feat: Support english dialects 2020-08-20 19:37:37 -05:00
azure-pipelines.yml chore(ci): Clarify step names 2021-05-15 19:03:10 -05:00
Cargo.lock refactor(dict): Allow 0..n corrections in BuiltIn 2021-05-18 12:02:03 -05:00
Cargo.toml chore: Release 2021-05-13 09:58:09 -05:00
CHANGELOG.md chore: Release 2021-05-13 09:58:09 -05:00
committed.toml chore: Pass along improvements 2021-02-04 21:46:38 -06:00
CONTRIBUTING.md docs: Fix links 2019-10-25 09:58:24 -06:00
LICENSE-APACHE Initial commit 2019-01-22 15:01:33 -07:00
LICENSE-MIT fix(docs): Replace mentions of scorrect with typos 2021-01-10 23:13:38 -05:00
README.md docs: Re-organize to clarify intent 2021-04-30 20:41:57 -05:00
release.toml chore: Fix release commit message 2021-04-21 12:14:19 -05:00

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

Build Status codecov Documentation License Crates Status

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