Check your spelling with
cargo spellcheck --fix or
cargo spellcheck fix to fix all your
documentation comments in order to avoid nasty 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 specific lingo.
cargo-cpellcheck is also a valuable tool to run from git commit hooks or CI/CD
cargo spellcheck check
error: spellcheck --> src/main.rs:44 | 44 | Fun facets shalld cause some erroris. | ^^^^^^ | - shall or shall d |
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
lite litter litterer liter l liters literal liter » a custom replacement literal
cargo install --locked cargo-spellcheck
--locked flag is the preferred way of installing to get the tested set of
cargo spellcheck completions for autodetection of your current shell via
cargo spellcheck completions --shell zsh
to explicitly specify your shell type.
Commonly it's use like this from your shell's
source <(cargo spellcheck completion)
Note: There is a relevant clap issue (#3508) that makes this fail in some cases.
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!