retext-spell-file v0.0.3

retext-spell-file

retext-spell with .respell personal dictionary file support.

This package provides the exact same interface and functionality as retext-spell with one small but useful modification.

1. retext-spell takes a personal option, which is a string of lines, in which each line is an entry in an Hunspell personal dictionary (a.k.a. word list).

2. retext-spell-file also takes a personal option. But if that personal option is falsy, it will search up the directory hierarchy for a file named .respell and read its (UTF-8) contents into a value that is passed to retext-spell in the personal option.

Installation

Follow the retext-spell installation instructions but replace retext-spell with retext-spell-file.

Usage

1. Refer to the retext-spell usage instructions but replace retext-spell with retext-spell-file.
2. Leave options.personal undefined.
3. Add a file named .respell to the top level of your project.
4. Add one correctly spelled word per line to .respell.

For more information:

• See hunspell(5) for the personal dictionary format.
• See our .respell for an example.

License

Blue Oak Model License 1.0.0 © Sean Leather