This is a basic spell-checking wrapper (for spellchecker/hunspell) that can check the spelling of plain text. It is used as the basis for markdown-it-spellcheck, markdown-spellcheck-cli and html-spellcheck-cli.
It gives you callbacks that you can use to track any spelling errors or warnings. You can also add words to the custom dictionary, and set up a filter function to allow some pre-processing. You'll need to provide the code for those callbacks; the use-case envisaged is that your test suite checks spellings and can fail a build if errors are found.
A command-line spell-checker, core-text-spellcheck-cli, is available and provides a real-world example of using this wrapper library. A basic example that demonstrates filtering can be found in example.js. The "hello, world" code is as follows.
const fs = require('fs')
const spellCheck = require('core-text-spellcheck')({
errors: (errors) => {
console.log(`Errors: ${errors.join(', ')}`)
},
warnings: (warnings) => {
console.log(`Warnings: ${warnings.join(', ')}`)
}
// log: null,
// validWords: [],
// warnWords: [],
// filter: null
})
spellCheck(fs.readFileSync('example.txt').toString())Callback taking a single parameter: an array of errant words that are being flagged as errors.
(It's recommended that when errors are encountered, they would make the overall spell-check fail.)
Callback taking a single parameter: an array of errant words that are being flagged as warnings.
(You might want to flag some things as warnings if they might be valid in certain situations, such as incorrect spellings that may be used as proper nouns in some cases.)
Callback taking a single parameter: a debug/log message to output.
You can set this to null too, which allows you to easily make this setting mirror a "debug" option in your spell-checking program (as is done in core-text-spellcheck-cli).
Default value: null
An array containing words that are to be treated as valid.
They will be added to the Hunspell custom dictionary. On most platforms, this is not persistent, but on macOS it is (in ~/Library/Spelling/[language-code]).
There's a GitHub issue on spellchecker relating to this.
Default value: []
An array containing words that are to be treated as valid, but will trigger a warning when used.
This is not persistent on any platform.
Default value: []
A callback that is used to process some text before it's passed to the spellchecker.
Consult example.js and example.txt for an example of how a filter can be used.
Default value: null
- Check out the code.
npm install
npm test—runs the tests (which also happens on pre-commit).npm run example—runs the example script (it is expected that this returns an error, as it should correctly find a misspelling).