Languages and Dictionaries

Settings that control dictionaries and language preferences.

Setting	Scope	Description
`cSpell.caseSensitive`	resource	Determines if words must match case and accent rules.
`cSpell.customDictionaries`	resource	Custom Dictionaries
`cSpell.dictionaries`	resource	Optional list of dictionaries to use.
`cSpell.dictionaryDefinitions`	resource	Dictionary Definitions
`cSpell.flagWords`	resource	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
`cSpell.ignoreWords`	resource	A list of words to be ignored by the spell checker.
`cSpell.language`	resource	Current active spelling language.
`cSpell.languageSettings`	resource	Additional settings for individual programming languages and locales.
`cSpell.noSuggestDictionaries`	resource	Optional list of dictionaries that will not be used for suggestions. Words in these dictionaries…
`cSpell.suggestWords`		A list of suggested replacements for words. Suggested words provide a way to make preferred…
`cSpell.useLocallyInstalledCSpellDictionaries`	resource	Search for `@cspell/cspell-bundled-dicts` in the workspace folder and use it if found.
`cSpell.userWords`	resource	Words to add to global dictionary -- should only be in the user config file.
`cSpell.words`	resource	List of words to be considered correct.

Settings

`cSpell.caseSensitive`

Name

cSpell.caseSensitive

Description

Determines if words must match case and accent rules.

false - Case is ignored and accents can be missing on the entire word. Incorrect accents or partially missing accents will be marked as incorrect. Note: Some languages like Portuguese have case sensitivity turned on by default. You must use cSpell.languageSettings to turn it off.
true - Case and accents are enforced by default.

Type

boolean

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

- none -

`cSpell.customDictionaries`

Name

cSpell.customDictionaries -- Custom Dictionaries

Description

Define custom dictionaries to be included by default. If addWords is true words will be added to this dictionary.

Example:

"cSpell.customDictionaries": {
  "project-words": {
    "name": "project-words",
    "path": "${workspaceRoot}/project-words.txt",
    "description": "Words used in this project",
    "addWords": true
  },
  "custom": true, // Enable the `custom` dictionary
  "internal-terms": false // Disable the `internal-terms` dictionary
}

Type

object

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

- none -

`cSpell.dictionaries`

Name

cSpell.dictionaries

Description

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. i.e. !typescript will turn off the dictionary with the name typescript.

Example:

// Enable `lorem-ipsum` and disable `typescript`
"cSpell.dictionaries": ["lorem-ipsum", "!typescript"]

Type

string[]

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

- none -

`cSpell.dictionaryDefinitions`

Name

cSpell.dictionaryDefinitions -- Dictionary Definitions

Description

Define custom dictionaries. If addWords is true words will be added to this dictionary.

This setting is subject to User/Workspace settings precedence rules: Visual Studio Code User and Workspace Settings.

It is better to use cSpell.customDictionaries

Example:

"cSpell.dictionaryDefinitions": [
  {
    "name": "project-words",
    "path": "${workspaceRoot}/project-words.txt",
    "description": "Words used in this project",
    "addWords": true
  }
]

Type

object[]

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

- none -

`cSpell.flagWords`

Name

cSpell.flagWords

Description

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

Type

string[]

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

- none -

`cSpell.ignoreWords`

Name: cSpell.ignoreWords
Description: A list of words to be ignored by the spell checker.
Type: string[]
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: - none -

`cSpell.language`

Name

cSpell.language

Description

Current active spelling language.

Example: en-GB for British English

Example: en,nl to enable both English and Dutch

Type

string

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

"en"

`cSpell.languageSettings`

Name: cSpell.languageSettings
Description: Additional settings for individual programming languages and locales.
Type: object[]
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: - none -

`cSpell.noSuggestDictionaries`

Name

cSpell.noSuggestDictionaries

Description

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.

Type

string[]

Scope

resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.

Default

- none -

`cSpell.suggestWords`

Name

cSpell.suggestWords

Description

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

Type

string[]

Scope

- none -

Default

- none -

`cSpell.useLocallyInstalledCSpellDictionaries`

Name: cSpell.useLocallyInstalledCSpellDictionaries
Description: Search for @cspell/cspell-bundled-dicts in the workspace folder and use it if found.
Type: boolean
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: true
Since Version: 4.0.0

`cSpell.userWords`

Name: cSpell.userWords
Description: Words to add to global dictionary -- should only be in the user config file.
Type: string[]
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: - none -

`cSpell.words`

Name: cSpell.words
Description: List of words to be considered correct.
Type: string[]
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: - none -

Settings​

cSpell.caseSensitive​

cSpell.customDictionaries​

cSpell.dictionaries​

cSpell.dictionaryDefinitions​

cSpell.flagWords​

cSpell.ignoreWords​

cSpell.language​

cSpell.languageSettings​

cSpell.noSuggestDictionaries​

cSpell.suggestWords​

cSpell.useLocallyInstalledCSpellDictionaries​

cSpell.userWords​

cSpell.words​

Settings

`cSpell.caseSensitive`

`cSpell.customDictionaries`

`cSpell.dictionaries`

`cSpell.dictionaryDefinitions`

`cSpell.flagWords`

`cSpell.ignoreWords`

`cSpell.language`

`cSpell.languageSettings`

`cSpell.noSuggestDictionaries`

`cSpell.suggestWords`

`cSpell.useLocallyInstalledCSpellDictionaries`

`cSpell.userWords`

`cSpell.words`