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 - 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
hunspell
and languagetool
are currently the two supported featuresets.
Configuration
# Project settings where a Cargo.toml exists and is passed
# ${CARGO_MANIFEST_DIR}/.config/spellcheck.toml
# Fallback to per use 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
[]
= "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 ]
# 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.
= []
[]
# 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.
= ["^'([^\\s])'$", "^[0-9]+x$"]
# Accepts `alphabeta` variants if the checker provides a replacement suggestion
# of `alpha-beta`.
= true
# And the counterpart, which accepts words with dashes, when the suggestion has
# recommendations without the dashes. This is less common.
= false
To increase verbosity 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 an instance of the LanguageTool server i.e. as container.