search

tbroadley / spellchecker-cli

A command-line tool for spellchecking files.
MIT License
119 stars 16 forks source link

Add library of common dictionaries #85

Closed tbroadley closed 2 years ago

tbroadley commented 2 years ago

Suggested in #84.

spellchecker-cli could have a suite of default dictionary files for projects based on different kinds of boilerplates (Next.js starter template, create-react-app boilerplate, etc). Then people could pass the path to the dictionary when invoking spellchecker:

spellchecker --dictionaries node_modules/spellchecker-cli/dictionaries/next-js.txt --files ...

It's verbose, but I think it's a good place to start. We could add some syntactic sugar on top, so that it isn't necessary to type out node_modules/spellchecker-cli/dictionaries.

Also, I don't know how people who have installed spellchecker-cli globally would know the path to these dictionaries. The syntactic sugar I mentioned above could help with this situation. In any case, I believe that people primarily install the package as a dev dependency.

tbroadley commented 2 years ago

One definite pain point for spellchecker-cli developers is that these should be kept up to date. And the process for generating them isn't super straightforward.