Skip to main content

Interface: DictionaryDefinitionInlineWords

Defined in: cspell-types/dist/index.d.mts:624

Extends​

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

Properties​

description?​

optional description: string

Defined in: cspell-types/dist/index.d.mts:549

Optional description of the contents / purpose of the dictionary.

Inherited from​

DictionaryDefinitionInlineBase.description

flagWords?​

optional flagWords: string[]

Defined in: cspell-types/dist/index.d.mts:510

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"
]

Inherited from​

DictionaryDefinitionInlineBase.flagWords

ignoreWords?​

optional ignoreWords: string[]

Defined in: cspell-types/dist/index.d.mts:515

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

Inherited from​

DictionaryDefinitionInlineBase.ignoreWords

name​

name: string

Defined in: cspell-types/dist/index.d.mts:545

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 *, !, ;, ,, {, }, [, ], ~.

Inherited from​

DictionaryDefinitionInlineBase.name

repMap?​

optional repMap: ReplaceMap

Defined in: cspell-types/dist/index.d.mts:551

Replacement pairs.

Inherited from​

DictionaryDefinitionInlineBase.repMap

suggestWords?​

optional suggestWords: string[]

Defined in: cspell-types/dist/index.d.mts:529

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

Inherited from​

DictionaryDefinitionInlineBase.suggestWords

useCompounds?​

optional useCompounds: boolean

Defined in: cspell-types/dist/index.d.mts:553

Use Compounds.

Inherited from​

DictionaryDefinitionInlineBase.useCompounds

words​

words: string[]

Defined in: cspell-types/dist/index.d.mts:625

List of words to be considered correct.

Overrides​

DictionaryDefinitionInlineBase.words