drahnr / cargo-spellcheck

Checks all your documentation for spelling and grammar mistakes with hunspell and a nlprule based checker for grammar
Apache License 2.0
326 stars 33 forks source link

Check `description` field in `Cargo.toml` for typos #233

Closed lopopolo closed 3 years ago

lopopolo commented 3 years ago

Is your feature request related to a particular use-case?

I published a crate to crates.io with a typo in the description field in Cargo.toml.

Describe the solution you'd like to implement/see implemented

Perform spellchecking on the description field in Cargo.toml.

Describe alternatives you've considered

code review, post-publish review.

Additional context

drahnr commented 3 years ago

There is only a small chunk of code missing to make this functional, adding another match arm to handle ChevkEntity::ManifestDesctiption in https://github.com/drahnr/cargo-spellcheck/blob/748b4f0bcec477695eb7ade98a01f03634efe277/src/traverse/mod.rs#L555

I'd be very happy to review a PR for this 😊

lopopolo commented 3 years ago

Thanks for the pointer @drahnr.

I put up a WIP PR here: