nspell
Hunspell-like spell-checker in plain-vanilla JavaScript.
nspell contains most of the essential core of Hunspell.
It does not contain a tokeniser but leaves many details up to implementors.
The main difference, conceptually, is that Hunspell is based on the user and
their preferences, whereas nspell is based on explicitly passed in options,
thus producing the same results regardless of OS, file system, or environment.
Contents
Install
npm:
npm install nspell
You probably also want to install some dictionaries:
npm install dictionary-en
Use
var dictionary = require('dictionary-en')
var nspell = require('nspell')
dictionary(ondictionary)
function ondictionary(err, dict) {
if (err) {
throw err
}
var spell = nspell(dict)
console.log(spell.correct('colour'))
console.log(spell.suggest('colour'))
console.log(spell.correct('color'))
console.log(spell.correct('npm'))
spell.add('npm')
console.log(spell.correct('npm'))
}
API
NSpell(dictionary)
Create a new spell checker.
Passing an affix document is required, through any of the below mentioned
signatures.
nspell is useless without at least one dic passed: make sure to pass one
either in the constructor or to nspell#dictionary.
Signatures
NSpell(dictionary)NSpell(aff[, dic])NSpell(dictionaries)
Parameters
dictionary (Object)
— Object with aff (required) and dic (optional) propertiesaff (Buffer or string)
— Affix document to use. Must be in UTF-8 when bufferdic (Buffer or string)
— Dictionary document to use. Must be in UTF-8 when bufferdictionaries (Array.<Dictionary>)
— List of dictionary objects. The first must have an aff key,
other aff keys are ignored
Returns
New instance of NSpell.
NSpell#correct(word)
Check if word is correctly spelled.
Example
spell.correct('color')
spell.correct('html')
spell.correct('abreviation')
Parameters
word (string) — Word to check for correct spelling
Returns
boolean — Whether word is correctly spelled.
NSpell#suggest(word)
Suggest correctly spelled words close to word.
Example
spell.suggest('colour')
spell.suggest('color')
spell.suggest('html')
spell.suggest('alot')
Parameters
word (string) — Word to suggest spelling corrections for
Returns
Array.<string> — List with zero or more suggestions.
NSpell#spell(word)
Get spelling information for word.
Example
spell.spell('colour')
spell.spell('color')
Parameters
word (string) — Word to check
Returns
Object, with the following properties:
correct (boolean)
— Whether word is correctly spelledforbidden (boolean)
— Whether word is actually correct, but forbidden from showing up as such
(often by the users wish)warn (boolean)
— Whether word is correct, but should trigger a warning
(rarely used in dictionaries)
NSpell#add(word[, model])
Add word to known words.
If no model is given, the word will be marked as correct in the future, and will
show up in spelling suggestions.
If a model is given, word will be handled the same as model.
Example
spell.correct('npm')
spell.suggest('nnpm')
spell.add('npm')
spell.correct('npm')
spell.suggest('nnpm')
Parameters
word (string) — Word to addmodel (string, optional) — Known word to model word after
Returns
NSpell — Operated on instance.
NSpell#remove(word)
Remove word from the known words.
Example
spell.correct('color')
spell.remove('color')
spell.correct('color')
Parameters
word (string) — Word to add
Returns
NSpell — Operated on instance.
NSpell#wordCharacters()
Get extra word characters defined by the loaded affix file.
Most affix files don’t set these, but for example the en dictionary sets
0123456789.
Example
spell.wordCharacters()
Returns
string? — Defined word characters, if any.
NSpell#dictionary(dic)
Add an extra dictionary to the spellchecker.
Example
spell.dictionary(
['5', 'npm', 'nullish', 'rebase', 'SHA', 'stringification'].join('\n')
)
Parameters
dic (Buffer or string)
— Dictionary document to use; must be in UTF-8 when buffer
Returns
NSpell — Operated on instance.
Note
The given dic must be designed to work with the already loaded affix.
It’s not possible to add dictionary files from different languages together
(use two NSpell instances for that).
NSpell#personal(dic)
Add a personal dictionary.
Example
spell.personal(['foo', 'bar/color', '*baz'].join('\n'))
Parameters
dic (Buffer or string)
— Dictionary document to use; must be in UTF-8 when buffer
Returns
NSpell — Operated on instance.
Note
Lines starting with a * mark a word as forbidden, which results in them being
seen as incorrect, and prevents them from showing up in suggestions.
Splitting a line in two with a slash, adds the left side and models it after the
already known right word.
Dictionaries
nspell supports many parts of Hunspell-style dictionaries.
Essentially, the concept of a dictionary consists of one “affix” document, and
one or more “dictionary” documents.
The documents are tightly linked, so it’s not possible to use a Dutch affix with
an English dictionary document.
Below is a short introduction, see hunspell(5) for more
information.
Affix documents
Affix documents define the language, keyboard, flags, and much more.
For example, a paraphrased Dutch affix document looks as follows:
SET UTF-8
KEY qwertyuiop|asdfghjkl|zxcvbnm|qawsedrftgyhujikolp|azsxdcfvgbhnjmk|aze|qsd|lm|wx|aqz|qws|
WORDCHARS '’0123456789ij.-\/
REP 487
REP e en
REP ji ij
REP u oe
# …
SFX An Y 11
SFX An 0 de d
SFX An 0 fe f
SFX An 0 ge g
# …
Not every option is supported in nspell.
See Affix options for a list of all options and which ones are
supported.
Dictionary documents
Dictionary documents contain words and flags applying to those words.
For example:
3
foo
bar/a
baz/ab
The above document contains three words, as the count on the first line shows.
Further lines each start with a word.
Some lines contain flags, as denoted by the slashes.
What those flags do, and the size of flags, is defined by affix documents.
Personal dictionary documents
Personal dictionaries are not intertwined with affix document.
They define new words and words to forbid.
For example:
foo
bar/baz
*qux
In the above example, foo is added as a known word; bar is added as well,
but modelled after the existing word baz; finally, qux is marked as a
forbidden word.
Affix options
The following affix options are known to Hunspell.
The checked ones are supported by nspell.
General
Suggestion
Compounding
Affix creation
Other
License
MIT © Titus Wormer
评论