Interface DictionaryDefinitionInlineWords

interface DictionaryDefinitionInlineWords {
    description?: string;
    flagWords?: string[];
    ignoreWords?: string[];
    name: string;
    repMap?: ReplaceMap;
    suggestWords?: string[];
    useCompounds?: boolean;
    words: string[];
}

Hierarchy

  • DictionaryDefinitionInlineBase
  • Required<Pick<InlineDictionary, "words">>
    • DictionaryDefinitionInlineWords

Properties

description?: string

Optional description of the contents / purpose of the dictionary.

flagWords?: string[]

List of words to always be considered incorrect. Words found in flagWords override words.

Format of flagWords

  • single word entry - word
  • with suggestions - word:suggestion or word->suggestion, suggestions

Example:

"flagWords": [
"color: colour",
"incase: in case, encase",
"canot->cannot",
"cancelled->canceled"
]
ignoreWords?: string[]

List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.

name: string

This is the name of a dictionary.

Name Format:

  • Must contain at least 1 number or letter.
  • Spaces are allowed.
  • Leading and trailing space will be removed.
  • Names ARE case-sensitive.
  • Must not contain *, !, ;, ,, {, }, [, ], ~.
repMap?: ReplaceMap

Replacement pairs.

suggestWords?: string[]

A list of suggested replacements for words. Suggested words provide a way to make preferred suggestions on word replacements. To hint at a preferred change, but not to require it.

Format of suggestWords

  • Single suggestion (possible auto fix)
    • word: suggestion
    • word->suggestion
  • Multiple suggestions (not auto fixable)
    • word: first, second, third
    • word->first, second, third
useCompounds?: boolean

Use Compounds.

words: string[]

List of words to be considered correct.