Skip to main content

Interface: DictionaryDefinitionSimple

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

An Empty Dictionary Definition

Extends​

Properties​

description?​

optional description: string

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

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:788

Hide​

ignoreForbiddenWords?​

optional ignoreForbiddenWords: boolean

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

Hide​

Overrides​

DictionaryDefinitionBase.ignoreForbiddenWords

name​

name: string

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

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: boolean

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

Hide​

Overrides​

DictionaryDefinitionBase.noSuggest

path?​

optional path: string

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

Hide​

repMap?​

optional repMap: ReplaceMap

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

Hide​

Overrides​

DictionaryDefinitionBase.repMap

supportNonStrictSearches?​

optional supportNonStrictSearches: boolean

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

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: DictionaryFileTypes

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

Hide​

Overrides​

DictionaryDefinitionBase.type

useCompounds?​

optional useCompounds: boolean

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

Hide​

Overrides​

DictionaryDefinitionBase.useCompounds