Interface: ExtendableSettings

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

In the below JSDoc comment, we helpfully specify an example configuration for the end-user to reference. And this example will get captured by the automatic documentation generator.

However, specifying the glob pattern inside of a JSDoc is tricky, because the glob contains the same symbol as the end-of-JSDoc symbol. To work around this, we insert a zero-width space in between the "*" and the "/" symbols.

Extends

• Settings

Extended by

• FileSettings

Properties

allowCompoundWords?

optional allowCompoundWords: boolean

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

True to enable compound word checking.

Default

false

Inherited from

Settings.allowCompoundWords

---

caseSensitive?

optional caseSensitive: boolean

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

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

Inherited from

Settings.caseSensitive

---

description?

optional description: string

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

Optional description of configuration.

Inherited from

Settings.description

---

dictionaries?

optional dictionaries: string[]

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

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.

Inherited from

Settings.dictionaries

---

dictionaryDefinitions?

optional dictionaryDefinitions: DictionaryDefinition[]

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

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

Inherited from

Settings.dictionaryDefinitions

---

enabled?

optional enabled: boolean

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

Is the spell checker enabled.

Default

true

Inherited from

Settings.enabled

---

enabledFileTypes?

optional enabledFileTypes: Record<string, boolean>

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

Enable / Disable checking file types (languageIds).

This setting replaces: Settings.enabledLanguageIds and Settings.enableFiletypes.

A Value of:

• true - enable checking for the file type
• false - disable checking for the file type

A file type of * is a wildcard that enables all file types.

Example: enable all file types

File Type	Enabled	Comment
*	true	Enable all file types.
json	false	Disable checking for json files.

Title

Enabled File Types to Check

Since

8.8.1

Inherited from

Settings.enabledFileTypes

---

enabledLanguageIds?

optional enabledLanguageIds: string[]

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

Specify a list of file types to spell check. It is better to use Settings.enabledFileTypes to Enable / Disable checking files types.

Title

Enabled Language Ids

Unique Items

true

Inherited from

Settings.enabledLanguageIds

---

enableFiletypes?

optional enableFiletypes: string[]

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

Enable / Disable checking file types (languageIds).

These are in additional to the file types specified by Settings.enabledLanguageIds. To disable a language, prefix with ! as in !json,

Example: individual file types

jsonc       // enable checking for jsonc
!json       // disable checking for json
kotlin      // enable checking for kotlin

Example: enable all file types

*           // enable checking for all file types
!json       // except for json

Title

Enable File Types

Scope

resource

Unique Items

true

Inherited from

Settings.enableFiletypes

---

flagWords?

optional flagWords: string[]

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

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

Settings.flagWords

---

id?

optional id: string

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

Optional identifier.

Inherited from

Settings.id

---

ignoreRandomStrings?

optional ignoreRandomStrings: boolean

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

Ignore sequences of characters that look like random strings.

Default

true

Inherited from

Settings.ignoreRandomStrings

---

ignoreRegExpList?

optional ignoreRegExpList: RegExpPatternList

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

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.

Inherited from

Settings.ignoreRegExpList

---

ignoreWords?

optional ignoreWords: string[]

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

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

Settings.ignoreWords

---

includeRegExpList?

optional includeRegExpList: RegExpPatternList

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

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.

Inherited from

Settings.includeRegExpList

---

language?

optional language: string

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

Current active spelling language. This specifies the language locale to use in choosing the general dictionary.

For example:

• "en-GB" for British English.
• "en,nl" to enable both English and Dutch.

Default

"en"

Inherited from

Settings.language

---

languageId?

optional languageId: MatchingFileType

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

Forces the spell checker to assume a give language id. Used mainly as an Override.

Inherited from

Settings.languageId

---

languageSettings?

optional languageSettings: LanguageSetting[]

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

Additional settings for individual languages.

See Language Settings for more details.

Inherited from

Settings.languageSettings

---

loadDefaultConfiguration?

optional loadDefaultConfiguration: boolean

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

By default, the bundled dictionary configurations are loaded. Explicitly setting this to false will prevent ALL default configuration from being loaded.

Default

true

Inherited from

Settings.loadDefaultConfiguration

---

maxDuplicateProblems?

optional maxDuplicateProblems: number

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

The maximum number of times the same word can be flagged as an error in a file.

Default

5

Inherited from

Settings.maxDuplicateProblems

---

maxNumberOfProblems?

optional maxNumberOfProblems: number

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

The maximum number of problems to report in a file.

Default

10000

Inherited from

Settings.maxNumberOfProblems

---

minRandomLength?

optional minRandomLength: number

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

The minimum length of a random string to be ignored.

Default

40

Inherited from

Settings.minRandomLength

---

minWordLength?

optional minWordLength: number

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

The minimum length of a word before checking it against a dictionary.

Default

4

Inherited from

Settings.minWordLength

---

name?

optional name: string

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

Optional name of configuration.

Inherited from

Settings.name

---

noSuggestDictionaries?

optional noSuggestDictionaries: string[]

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

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.

Inherited from

Settings.noSuggestDictionaries

---

numSuggestions?

optional numSuggestions: number

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

Number of suggestions to make.

Default

10

Inherited from

Settings.numSuggestions

---

overrides?

optional overrides: OverrideSettings[]

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

Overrides are used to apply settings for specific files in your project.

For example:

"overrides": [
  // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:
  {
    "filename": "**​/{*.hrr,*.crr}",
    "languageId": "cpp"
  },
  // Force `*.txt` to use the Dutch dictionary (Dutch dictionary needs to be installed separately):
  {
    "language": "nl",
    "filename": "**​/dutch/**​/*.txt"
  }
]

---

parser?

optional parser: string

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

Experimental

Parser to use for the file content

Since

6.2.0

Inherited from

Settings.parser

---

patterns?

optional patterns: RegExpPatternDefinition[]

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

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

Inherited from

Settings.patterns

---

pnpFiles?

optional pnpFiles: string[]

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

The PnP files to search for. Note: .mjs files are not currently supported.

Default

[".pnp.js", ".pnp.cjs"]

Inherited from

Settings.pnpFiles

---

suggestionNumChanges?

optional suggestionNumChanges: number

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

The maximum number of changes allowed on a word to be considered a suggestions.

For example, appending an s onto example -> examples is considered 1 change.

Range: between 1 and 5.

Default

3

Inherited from

Settings.suggestionNumChanges

---

suggestionsTimeout?

optional suggestionsTimeout: number

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

The maximum amount of time in milliseconds to generate suggestions for a word.

Default

500

Inherited from

Settings.suggestionsTimeout

---

suggestWords?

optional suggestWords: string[]

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

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

Settings.suggestWords

---

usePnP?

optional usePnP: boolean

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

Packages managers like Yarn 2 use a .pnp.cjs file to assist in loading packages stored in the repository.

When true, the spell checker will search up the directory structure for the existence of a PnP file and load it.

Default

false

Inherited from

Settings.usePnP

---

words?

optional words: string[]

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

List of words to be considered correct.

Inherited from

Settings.words