Skip to main content

Interface: DictionaryDefinitionCustom

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

For Defining Custom dictionaries. They are generally scoped to a user, workspace, or folder. When addWords is true, indicates that the spell checker can add words to the file.

Note: only plain text files with one word per line are supported at this moment.

Extends​

Properties​

addWords​

addWords: boolean

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

When true, let's the spell checker know that words can be added to this dictionary.

description?​

optional description: string

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

Optional description of the contents / purpose of the dictionary.

Inherited from​

DictionaryDefinitionPreferred.description

ignoreForbiddenWords?​

optional ignoreForbiddenWords: boolean

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

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.

Inherited from​

DictionaryDefinitionPreferred.ignoreForbiddenWords

name​

name: string

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

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​

DictionaryDefinitionPreferred.name

noSuggest?​

optional noSuggest: boolean

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

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.

Inherited from​

DictionaryDefinitionPreferred.noSuggest

path​

path: string

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

Path to custom dictionary text file.

Overrides​

DictionaryDefinitionPreferred.path

repMap?​

optional repMap: ReplaceMap

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

Replacement pairs.

Inherited from​

DictionaryDefinitionPreferred.repMap

scope?​

optional scope: CustomDictionaryScope | CustomDictionaryScope[]

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

Defines the scope for when words will be added to the dictionary.

Scope values: user, workspace, folder.

supportNonStrictSearches?​

optional supportNonStrictSearches: boolean

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

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​

DictionaryDefinitionPreferred.supportNonStrictSearches

type?​

optional type: DictionaryFileTypes

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

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"

Inherited from​

DictionaryDefinitionPreferred.type

useCompounds?​

optional useCompounds: boolean

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

Use Compounds.

Inherited from​

DictionaryDefinitionPreferred.useCompounds