Interface DictionaryDefinitionInlineFlagWords

interface DictionaryDefinitionInlineFlagWords {
    description?: string;
    flagWords: string[];
    ignoreWords?: string[];
    name: string;
    noSuggest?: boolean;
    repMap?: ReplaceMap;
    suggestWords?: string[];
    type?: DictionaryFileTypes;
    useCompounds?: boolean;
    words?: string[];
}

Hierarchy

  • DictionaryDefinitionInlineBase
  • Required<Pick<InlineDictionary, "flagWords">>
    • DictionaryDefinitionInlineFlagWords

Properties

description?: string

Optional description.

flagWords: string[]
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 *, !, ;, ,, {, }, [, ], ~.
noSuggest?: boolean

Indicate that suggestions should not come from this dictionary. Words in this dictionary are considered correct, but will not be used when making spell correction suggestions.

Note: if a word is suggested by another dictionary, but found in this dictionary, it will be removed from the set of possible suggestions.

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

Type of file:

  • S - single word per line,
  • W - each line can contain one or more words separated by space,
  • C - each line is treated like code (Camel Case is allowed).

Default is S.

C is the slowest to load due to the need to split each line based upon code splitting rules.

Default

"S"
useCompounds?: boolean

Use Compounds.

words?: string[]

List of words to be considered correct.