cargo-spellcheck

WIP Check your spelling. WIP

Usecase

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. cargo spellcheck has a return code 1 if any unknown words are found, and 0 on success.

Error display follows cargo error printing style:

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

Features

[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] Grammar check using languagetool http API
[x] False positive reduction
[x] Be markdown aware
[ ] Include doctests ( ```rust code wrapped sections)
[x] Handle module documentation comments
[ ] Add README.md files
[x] Follow module declarations rather than blindly recurse
[ ] Handle cargo workspaces
[ ] cargo-spellcheck fix
[ ] cargo-spellcheck fix --interactive
[ ] Re-wrap doc comments
[ ] Word split validation

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.

Hunspell

Requires the native library

sh dnf install -y hunspell-devel

and building should succeed just fine.

LanguageTool

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