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 typos all over your source tree.
Meant as a helper simplifying review as well as improving CI checks after a learning phase for custom/topic specifc lingo.
Check For Spelling and/or Grammar Mistakes
Apply Suggestions Interactively
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
- Parse doc comments from arbitrary files
- Decent error printing
-
cargo-spellcheck check
- Spell checking using
hunspell
- Merge multiline doc comments
- Handle multiline and fragmented mistakes (i.e. for grammar) #25
- Grammar check using
languagetool
http API - Follow module declarations rather than blindly recurse
- Be
commonmark
aware - Check
README.md
files #37 - Check mdbook
book.toml
file trees #62 - Improve interactive user interface with
crossterm
- Ellipsize overly long statements with
...
#42 - Learn topic lingo and filter false-positive-suggestions #41
- Handle cargo workspaces #38
- Re-wrap doc comments #39
- Word split validation #40
hunspell
and languagetool
are currently the two supported featuresets.
Configuration
# 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
[]
= "127.0.0.1:8010"
[]
# lang and name of `.dic` file
= "en_US"
# OS specific additives
# Linux: [ /usr/share/myspell ]
# Windows: []
# macOS [ /home/alice/Libraries/hunspell, /Libraries/hunspell ]
= []
= []
To increase verbosity use CARGO_SPELLCHECK=cargo_spellcheck=trace
to see internal details or
add -v
(multiple) to increase verbosity.
Installation
cargo install cargo-spellcheck
Checkers
Available checker support
Hunspell
Requires a C++ compiler to compile the hunspell CXX source files which are part of hunspell-sys
Fedora 30+
Ubuntu 19.10+
Mac OS X
brew install llvm
The environment variable LLVM_CONFIG_PATH
needs to point to llvm-config
, to do so:
LanguageTool
Run a instance of the LanguageTool server i.e. as container.