Additional files in spellcheck.toml - changelogs

[daxpedda]

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

I would like to add checking CHANGELOG.md for spelling errors in the CI too.

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

Add a new configuration key to spellcheck.toml to include additional files.

Describe alternatives you've considered

Currently the alternative is to pass a path to cargo spellcheck CHANGELOG.md directly. This is undesirable, because contributors who are developing locally now have to remember this. Adding it to spellcheck.toml makes it automatic.

[drahnr]

This would require a changelog parser i.e. like https://crates.io/crates/parse-changelog , other than that I don't think there are any further obstacles to implement it.

I'd be happy to guide you through the implementation of that feature.

[daxpedda]

This would require a changelog parser i.e. like https://crates.io/crates/parse-changelog

I'm a bit confused, I thought cargo spellcheck can already parse markdown files. In fact, using cargo spellcheck CHANGELOG.md works perfectly fine. Am I missing something?

[drahnr]

You're correct for hunspell, the existing common mark parser will work ok as is from what I can tell.

Using a parser for the changelog that is aware of the overall structure of a changelog will help with NlpRules false-positive reduction, I have no proof for this but if there is structured, we should use it to limit the amount of data fed to the checkers.

[daxpedda]

Personally for me that's overkill, considering that I didn't even encounter false-positives and have been using it on README.mds quiet successfully so far too with hunspell.

If I do find time, I will look into contributing myself here!

[drahnr]

Adding a default quirk for various date formats might indeed be sufficient.