Skip to main content

Interface: BaseSetting

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

Extends​

Extended by​

Properties​

allowCompoundWords?​

optional allowCompoundWords?: boolean

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

True to enable compound word checking.

Default​

false

caseSensitive?​

optional caseSensitive?: boolean

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

Determines if words must match case and accent rules.

See Case Sensitivity for more details.

  • false - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect.
  • true - Case and accents are enforced.

Default​

false

description?​

optional description?: string

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

Optional description of configuration.

dictionaries?​

optional dictionaries?: string[]

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

Optional list of dictionaries to use. Each entry should match the name of the dictionary.

To remove a dictionary from the list, add ! before the name.

For example, !typescript will turn off the dictionary with the name typescript.

See the Dictionaries and Custom Dictionaries for more details.

dictionaryDefinitions?​

optional dictionaryDefinitions?: DictionaryDefinition[]

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

Define additional available dictionaries.

For example, you can use the following to add a custom dictionary:

"dictionaryDefinitions": [
  { "name": "custom-words", "path": "./custom-words.txt"}
],
"dictionaries": ["custom-words"]

enabled?​

optional enabled?: boolean

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

Is the spell checker enabled.

Default​

true

flagWords?​

optional flagWords?: string[]

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

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​

InlineDictionary.flagWords

id?​

optional id?: string

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

Optional identifier.

ignoreRegExpList?​

optional ignoreRegExpList?: RegExpPatternList

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

List of regular expression patterns or pattern names to exclude from spell checking.

Example: ["href"] - to exclude html href pattern.

Regular expressions use JavaScript regular expression syntax.

Example: to ignore ALL-CAPS words

JSON

"ignoreRegExpList": ["/\\b[A-Z]+\\b/g"]

YAML

ignoreRegExpList:
  - >-
   /\b[A-Z]+\b/g

By default, several patterns are excluded. See Configuration for more details.

While you can create your own patterns, you can also leverage several patterns that are built-in to CSpell.

ignoreWords?​

optional ignoreWords?: string[]

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

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​

InlineDictionary.ignoreWords

includeRegExpList?​

optional includeRegExpList?: RegExpPatternList

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

List of regular expression patterns or defined pattern names to match for spell checking.

If this property is defined, only text matching the included patterns will be checked.

While you can create your own patterns, you can also leverage several patterns that are built-in to CSpell.

name?​

optional name?: string

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

Optional name of configuration.

noSuggestDictionaries?​

optional noSuggestDictionaries?: string[]

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

Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries 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 one of these dictionaries, it will be removed from the set of possible suggestions.

parser?​

optional parser?: string

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

Experimental

Parser to use for the file content

Since​

6.2.0

Inherited from​

ExperimentalBaseSettings.parser

patterns?​

optional patterns?: RegExpPatternDefinition[]

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

Defines a list of patterns that can be used with the ignoreRegExpList and includeRegExpList options.

For example:

"ignoreRegExpList": ["comments"],
"patterns": [
  {
    "name": "comment-single-line",
    "pattern": "/#.*​/g"
  },
  {
    "name": "comment-multi-line",
    "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g"
  },
  // You can also combine multiple named patterns into one single named pattern
  {
    "name": "comments",
    "pattern": ["comment-single-line", "comment-multi-line"]
  }
]

substitutionDefinitions?​

optional substitutionDefinitions?: SubstitutionDefinitions

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

The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.

Since​

9.7.0

substitutions?​

optional substitutions?: Substitutions

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

The set of substitutions to apply to a document before spell checking.

Since​

9.7.0

suggestWords?​

optional suggestWords?: string[]

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

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​

InlineDictionary.suggestWords

unknownWords?​

optional unknownWords?: UnknownWordsChoices

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

Controls how unknown words are handled.

  • report-all - Report all unknown words (default behavior)
  • report-simple - Report unknown words that have simple spelling errors, typos, and flagged words.
  • report-common-typos - Report unknown words that are common typos and flagged words.
  • report-flagged - Report unknown words that are flagged.

Default​

"report-all"

Since​

9.1.0

Inherited from​

UnknownWordsConfiguration.unknownWords

useIntlWordSegmentation?​

optional useIntlWordSegmentation?: boolean

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

Enables enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc. The locale used for the segmentation is based on the language setting.

Since​

10.2.0

words?​

optional words?: string[]

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

List of words to be considered correct.

Inherited from​

InlineDictionary.words