textlint-rule / textlint-rule-spellchecker

textlint rule to check spellings with native spellchecker
8 stars 2 forks source link

Allow passing ignored words/patterns #46

Closed jrencz closed 6 years ago

jrencz commented 7 years ago

I'm considering using this rule as a complementary to eslint-plugin-spellcheck and I wonder if it's possible to define skipped words exception list.

Use case: The project may have its own set of words that have domain-related meaning and I don't want them to be considered errors although they don't fit the general dictionary.

How about introducing configuration similar to what ESLint plugin has: skipWords and skipIfMatch (names may off course be different)

What I'd like to achieve is to make it possible to maintain one and only one set of words that are excluded.

nodaguti commented 7 years ago

Thank you for your feedback.

I was initially thinking that it would be better to delegate the 'skipWords' functionality to the spellchecker side as I've mentioned in the "Notes" section of ReadME, i.e., asking users to register their own list to a spellchecker's ignorance list, but I'm now convinced that there is some use cases where you want to share your configuration.

I'm going to start working on this shortly. Thank you again.

nodaguti commented 6 years ago

@jrencz I'm really sorry for being inactive for quite a long time.

If you are still around and interested in using this rule, I'd be glad to announce that I've released v2.2.0 which has skip words, regular expressions and TxtAST node types features.

Thanks again for your suggestions and hope you will be happy with this release!