cargo-spellcheck

Check your spelling with

hunspell

nlprule

Use Cases

Run

cargo spellcheck --fix

cargo spellcheck fix

See automation.md for instructions on how to use

cargo-spellcheck

Check For Spelling and/or Grammar Mistakes

cargo spellcheck check

error: spellcheck
   --> src/main.rs:44
    |
 44 | Fun facets shalld cause some erroris.
    |            ^^^^^^
    | - shall or shall d
    |

Apply Suggestions Interactively

cargo spellcheck fix

error: spellcheck(Hunspell)
    --> /media/supersonic1t/projects/cargo-spellcheck/src/literalset.rs:291
     |
 291 |  Returns literl within the Err variant if not adjacent
     |          ^^^^^^

(13/14) Apply this suggestion [y,n,q,a,d,j,e,?]?
   lite
   litter
   litterer
   liter l
   liters
   literal
   liter
 » a custom replacement literal

Implemented Features + Roadmap

• [x] Parse doc comments from arbitrary files
• [x] Decent error printing
• [x]

  cargo-spellcheck check

• [x] Spell checking using

  hunspell

• [x] Merge multiline doc comments
• [x] Handle multiline and fragmented mistakes (i.e. for grammar) #25
• [x] Grammar check using

  nlprule

• [x] Follow module declarations rather than blindly recurse
• [x] Be

  commonmark

  /

  markdown

  aware
  • [ ] Handle doc-tests with
    `

    rust

    as virtual files #43
  • [ ] Verify all types of links #44
• [x] Check

  README.md

  files #37
• [x] Improve interactive user interface with

  crossterm

• [x] Ellipsize overly long statements with

  ...

  #42
• [ ] Learn topic lingo and filter false-positive-suggestions #41
• [x] Handle cargo workspaces #38
• [x] Re-flow doc comments #39
• [x] Collect dev comments as well #115

hunspell

nlprules

languagetool

Configuration

Source

There are various ways to specify the configuration. The prioritization is as follows:

Explicit specification:

1. Command line flags

   --cfg=...

   .

2. Cargo.toml

   metadata

   [package.metadata.spellcheck]
   config = "somewhere/cfg.toml"
   

which will fail if specified and not existent on the filesystem.

If neither of those ways of specification is present, continue with the implicit.

1. Cargo.toml

   metadata in the current working directory

   CWD

   .
2. Check the first arguments location if present, else the current working directory for

   .config/spellcheck.toml

   .
3. Fallback to per user configuration files:
   • Linux:

     /home/alice/.config/cargo_spellcheck/config.toml

   • Windows:

     C:\Users\Alice\AppData\Roaming\cargo_spellcheck\config.toml

   • macOS:

     /Users/Alice/Library/Preferences/cargo_spellcheck/config.toml

4. Use the default, builtin configuration (see

   config

   sub-command).

Since this is rather complex, add

-vv

info

Format

# Project settings where a Cargo.toml exists and is passed
# ${CARGO_MANIFEST_DIR}/.config/spellcheck.toml

Also take into account developer comments
dev_comments = false
Skip the README.md file as defined in the cargo manifest
skip_readme = false
[Hunspell]
lang and name of .dic file
lang = "en_US"
OS specific additives
Linux: [ /usr/share/myspell ]
Windows: []
macOS [ /home/alice/Libraries/hunspell, /Libraries/hunspell ]
Additional search paths, which take presedence over the default
os specific search dirs, searched in order, defaults last
search_dirs = []
Adds additional dictionaries, can be specified as
absolute paths or relative in the search dirs (in this order).
Relative paths are resolved relative to the configuration file
which is used.
Refer to man 5 hunspell
or https://www.systutorials.com/docs/linux/man/4-hunspell/#lbAE
on how to define a custom dictionary file.
extra_dictionaries = []
If set to true, the OS specific default search paths
are skipped and only explicitly specified ones are used.
skip_os_lookups = false
Use the builtin dictionaries if none were found in
in the configured lookup paths.
Usually combined with skip_os_lookups=true
to enforce the builtin usage for consistent
results across distributions and CI runs.
Setting this will still use the dictionaries
specified in extra_dictionaries = [..]
for topic specific lingo.
use_builtin = true
[Hunspell.quirks]
Transforms words that are provided by the tokenizer
into word fragments based on the capture groups which are to
be checked.
If no capture groups are present, the matched word is whitelisted.
transform_regex = ["^'([^\s])'$", "^[0-9]+x$"]
Accepts alphabeta variants if the checker provides a replacement suggestion
of alpha-beta.
allow_concatenation = true
And the counterpart, which accepts words with dashes, when the suggestion has
recommendations without the dashes. This is less common.
allow_dashed = false
[NlpRules]
Allows the user to override the default included
exports of LanguageTool, with other custom
languages
override_rules = "/path/to/rules_binencoded.bin"
override_tokenizer = "/path/to/tokenizer_binencoded.bin"
[Reflow]
Reflows doc comments to adhere to adhere to a given maximum line width limit.
max_line_length = 80

To increase verbosity add

-v

Installation

cargo install --locked cargo-spellcheck

The

--locked

Checkers

Available checker support

Hunspell

Requires a C++ compiler to compile the hunspell CXX source files which are part of

hunspell-sys

Fedora 30+

dnf install -y clang

Ubuntu 19.10+

apt install -y clang

Mac OS X

brew install llvm

The environment variable

LLVM_CONFIG_PATH

llvm-config

export LLVM_CONFIG_PATH=/usr/local/opt/llvm/bin/llvm-config

NlpRules

When compiled with the default featureset which includes

nlprules

LGPLv2.1

rules

tokenizer

LanguageTool

LGPLv2.1

nlprule

🎈 Contribute!

Contributions are very welcome!

Generally the preferred way of doing so, is to comment in an issue that you would like to tackle the implementation/fix.

This is usually followed by an initial PR where the implementation is then discussed and iteratively refined. No need to get it all correct the first time!