Skip to main content

Interface: DictionaryDefinitionBase

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

Extended by​

Properties​

description?​

optional description?: string

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

Optional description of the contents / purpose of the dictionary.

ignoreForbiddenWords?​

optional ignoreForbiddenWords?: boolean

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

Some dictionaries may contain forbidden words to prevent compounding from generating words that are not valid in the language. These are often words that are used in other languages or might be generated through compounding. This setting allows flagged words to be ignored when checking the dictionary. The effect is similar to the word not being in the dictionary.

kind?​

optional kind?: DictionaryKind

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

Used to specify the type of dictionary being referenced. Values:

  • words - (default) A dictionary containing words.
  • flag-words - A dictionary containing flag words. Words found in the dictionary will be treated like flagWords.
  • ignore-words - A dictionary containing words to ignore. This is the same as setting noSuggest to true.
  • suggest-words - A dictionary containing suggested word corrections. Words found in the dictionary will be treated like suggestWords.

Since​

10.3.0

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

noSuggest?​

optional noSuggest?: boolean

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

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?​

optional repMap?: ReplaceMap

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

Replacement pairs.

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

type?​

optional type?: DictionaryFileTypes

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

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.

Note: this settings does not apply to inline dictionaries or .trie files.

Default​

"S"

useCompounds?​

optional useCompounds?: boolean

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

Use Compounds.