Skip to main content

Interface: DictionaryDefinitionInlineFlagWords

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

Extends​

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

Properties​

btrie?​

optional btrie?: string

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

Not used

Inherited from​

DictionaryDefinitionInlineBase.btrie

description?​

optional description?: string

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

Optional description of the contents / purpose of the dictionary.

Inherited from​

DictionaryDefinitionBase.description

file?​

optional file?: undefined

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

Not used

Inherited from​

DictionaryDefinitionInlineBase.file

flagWords​

flagWords: string[]

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

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

  • An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
  • An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Overrides​

DictionaryDefinitionInlineBase.flagWords

ignoreForbiddenWords?​

optional ignoreForbiddenWords?: undefined

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

Not used

Inherited from​

DictionaryDefinitionInlineBase.ignoreForbiddenWords

ignoreWords?​

optional ignoreWords?: string[]

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

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

kind?​

optional kind?: DictionaryKind

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

Inherited from​

DictionaryDefinitionInlineBase.kind

name​

name: string

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

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​

DictionaryDefinitionBase.name

noSuggest?​

optional noSuggest?: undefined

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

Use ignoreWords instead.

Inherited from​

DictionaryDefinitionInlineBase.noSuggest

path?​

optional path?: undefined

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

Not used

Inherited from​

DictionaryDefinitionInlineBase.path

repMap?​

optional repMap?: undefined

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

Inherited from​

DictionaryDefinitionInlineBase.repMap

suggestWords?​

optional suggestWords?: string[]

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

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

supportNonStrictSearches?​

optional supportNonStrictSearches?: boolean

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

Strip case and accents to allow for case insensitive searches and words without accents.

Note: this setting only applies to word lists. It has no-impact on trie dictionaries.

Default​

true

Inherited from​

DictionaryDefinitionBase.supportNonStrictSearches

type?​

optional type?: undefined

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

Not used

Inherited from​

DictionaryDefinitionInlineBase.type

useCompounds?​

optional useCompounds?: undefined

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

Not used

Inherited from​

DictionaryDefinitionInlineBase.useCompounds

words?​

optional words?: string[]

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

List of words to be considered correct.

Inherited from​

DictionaryDefinitionInlineBase.words