cargo-spellcheck

Check your spelling with hunspell and/or languagetool.

Use Cases

Run cargo spellcheck --fix or cargo spellcheck fix to fix all your documentation comments in order to avoid narsty types all over the place.

Meant as a helper simplifying review as well as possibly improving CI after a learning phase for custom/topic specifc lingo.

Check For Spelling and/or Grammar Mistakes

zsh cargo spellcheck check

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

Apply Suggestions Interactively

zsh cargo spellcheck fix --interactive

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

Continuous Integration / CI

cargo spellcheck can be configured with -m <code> to return a non-zero return code if mistakes are found instead of 0.

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
• [ ] Properly handle grammar mistakes spanning accross multiple lines
• [x] Grammar check using languagetool http API
• [x] Follow module declarations rather than blindly recurse
• [x] Be markdown aware
  • [ ] Handle doctests with ```rust as virtual files #43
  • [ ] Verify all types of links #44
• [ ] Check README.md files #37
• [ ] Check mdbook book.toml file trees #62
• [x] cargo-spellcheck fix --interactive
• [x] Improve interactive user interface with crossterm
• [ ] Ellipsize overly long statements with ... #42
• [ ] Learn topic lingo and filter false-positive-suggestions when fix --interactive is passed #41
• [x] Handle cargo workspaces #38
• [ ] Re-wrap doc comments #39
• [ ] Word split validation #40
• [ ] cargo-spellcheck fix #45

hunspell and languagetool are currently the two supported featuresets.

Configuration

```toml

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

[LanguageTool] url = "127.0.0.1:8010"

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

searchdirs = [] extradictonaries = [] ```

Installation

cargo install cargo-spellcheck

To increase verbosity use CARGO_SPELLCHECK=cargo_spellcheck=trace to see internal details or add -v (multiple) to increase verbosity.

Windows currently suffers from an issue of the inability to build hunspell (the C lib) easily on windows or specify where it exists, see #14 for details, there is an upcoming upstream fix in hunspell-sys/#2.

Hunspell

Requires the native library

```sh

Fedora 30+

dnf install -y hunspell-devel clang

Ubuntu 19.10+

apt install -y libhunspell-dev clang

Mac OS X

brew install hunspell llvm ```

and building should succeed just fine.

LanguageTool

Run a instance of the LanguageTool server i.e. as container.