Legacy

Legacy settings that have been deprecated or are not commonly used.

Setting	Scope	Description
`cSpell.allowCompoundWords`	resource	Enable / Disable allowing word compounds.

Settings

`cSpell.allowCompoundWords`

Name

cSpell.allowCompoundWords

Description

Enable / Disable allowing word compounds.

true means arraylength would be ok
false means it would not pass.

Note: this can also cause many misspelled words to seem correct.

Type

boolean

Scope

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

Default

false

`cSpell.customFolderDictionaries`

Name

~~cSpell.customFolderDictionaries~~ -- Custom Folder Dictionaries

Description

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

Type

CustomDictionaryEntry[]

Scope

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

Deprecation Message

Use cSpell.customDictionaries instead.

Default

- none -

`cSpell.customUserDictionaries`

Name

~~cSpell.customUserDictionaries~~ -- Custom User Dictionaries

Description

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

Type

CustomDictionaryEntry[]

Scope

application - Settings that apply to all instances of VS Code and can only be configured in user settings.

Deprecation Message

Use cSpell.customDictionaries instead.

Default

- none -

`cSpell.customWorkspaceDictionaries`

Name

~~cSpell.customWorkspaceDictionaries~~ -- Custom Workspace Dictionaries

Description

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

Type

CustomDictionaryEntry[]

Scope

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

Deprecation Message

Use cSpell.customDictionaries instead.

Default

- none -

`cSpell.enabledLanguageIds`

Name

~~cSpell.enabledLanguageIds~~ -- Enabled Language Ids

Description

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

Type

string[]

Scope

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

Deprecation Message

Use cSpell.enabledFileTypes instead.

Default

- none -

`cSpell.showStatus`

Name: ~~cSpell.showStatus~~
Description: Display the spell checker status on the status bar.
Type: boolean
Scope: application - Settings that apply to all instances of VS Code and can only be configured in user settings.
Deprecation Message: No longer used.
Default: true

`cSpell.showStatusAlignment`

Name

~~cSpell.showStatusAlignment~~

Description

The side of the status bar to display the spell checker status.

Type

Any of:

"Left"
"Right"

( "Left" | "Right" )

Value	Description
`Left`	Left Side of Statusbar
`Right`	Right Side of Statusbar

Scope

application - Settings that apply to all instances of VS Code and can only be configured in user settings.

Deprecation Message

No longer supported.

Default

"Right"

Type Definitions

`CustomDictionaryAugmentExistingDictionary`

Name

CustomDictionaryAugmentExistingDictionary

Description

Type

Fields
Name `name` (required) Description The reference name of the dictionary. Example: `My Words` or `custom` If the name matches a pre-defined dictionary, it will override the pre-defined dictionary. If you use: `typescript` it will replace the built-in TypeScript dictionary. Type `string` Required Yes
Name `addWords` Description Indicate if this custom dictionary should be used to store added words. Type `boolean` Default `true`
Name `description` Description Optional: A human readable description. Type `string`
Name `noSuggest` Description 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. Type `boolean`
Name `path` Description Define the path to the dictionary text file. Note: if path is `undefined` the `name`d dictionary is expected to be found in the `dictionaryDefinitions`. File Format: Each line in the file is considered a dictionary entry. Case is preserved while leading and trailing space is removed. The path should be absolute, or relative to the workspace. Example: relative to User's folder `"path": "~/dictionaries/custom_dictionary.txt"` Example: relative to the `client` folder in a multi-root workspace `"path": "${workspaceFolder:client}/build/custom_dictionary.txt"` Example: relative to the current workspace folder in a single-root workspace Note: this might not work as expected in a multi-root workspace since it is based upon the relative workspace for the currently open file. `"path": "${workspaceFolder}/build/custom_dictionary.txt"` Example: relative to the workspace folder in a single-root workspace or the first folder in a multi-root workspace `"path": "./build/custom_dictionary.txt"` Type `string`
Name `scope` Description Options are `user` - words that apply to all projects and workspaces `workspace` - words that apply to the entire workspace `folder` - words that apply to only a workspace folder Type `( ( "user" \| "workspace" \| "folder" ) \| ( "user" \| "workspace" \| "folder" )[] )`

TypeScript:

{
  addWords?: boolean;
  description?: string;
  name: string;
  noSuggest?: boolean;
  path?: string;
  scope?: (("user" | "workspace" | "folder") | ("user" | "workspace" | "folder")[]);
}

`CustomDictionary`

Name

CustomDictionary

Description

Type

Fields
Name `name` (required) Description The reference name of the dictionary. Example: `My Words` or `custom` If the name matches a pre-defined dictionary, it will override the pre-defined dictionary. If you use: `typescript` it will replace the built-in TypeScript dictionary. Type `string` Required Yes
Name `path` (required) Description Define the path to the dictionary text file. Note: if path is `undefined` the `name`d dictionary is expected to be found in the `dictionaryDefinitions`. File Format: Each line in the file is considered a dictionary entry. Case is preserved while leading and trailing space is removed. The path should be absolute, or relative to the workspace. Example: relative to User's folder `"path": "~/dictionaries/custom_dictionary.txt"` Example: relative to the `client` folder in a multi-root workspace `"path": "${workspaceFolder:client}/build/custom_dictionary.txt"` Example: relative to the current workspace folder in a single-root workspace Note: this might not work as expected in a multi-root workspace since it is based upon the relative workspace for the currently open file. `"path": "${workspaceFolder}/build/custom_dictionary.txt"` Example: relative to the workspace folder in a single-root workspace or the first folder in a multi-root workspace `"path": "./build/custom_dictionary.txt"` Type `string` Required Yes
Name `addWords` Description Indicate if this custom dictionary should be used to store added words. Type `boolean` Default `true`
Name `btrie` Description An alternative path to a bTrie dictionary file. It will be used in place of `path` if the version of CSpell being used supports btrie files. Type `string` CSpell Version 9.6.0
Name `description` Description Optional: A human readable description. Type `string`
Name `ignoreForbiddenWords` Description 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. Type `boolean`
Name `kind` Description Used to specify the type of dictionary being referenced. Values: `words` - (default) A dictionary containing words. `flag-words` - A dictionary containing flag words. Words found in the dictionary will be treated like `flagWords`. `ignore-words` - A dictionary containing words to ignore. This is the same as setting `noSuggest` to `true`. `suggest-words` - A dictionary containing suggested word corrections. Words found in the dictionary will be treated like `suggestWords`. Type `( "words" \| "flag-words" \| "ignore-words" \| "suggest-words" )` CSpell Version 10.3.0
Name `noSuggest` Description 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. Type `boolean`
Name `scope` Description Options are `user` - words that apply to all projects and workspaces `workspace` - words that apply to the entire workspace `folder` - words that apply to only a workspace folder Type `( ( "user" \| "workspace" \| "folder" ) \| ( "user" \| "workspace" \| "folder" )[] )`
Name `supportNonStrictSearches` Description 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. Type `boolean` Default `true`

TypeScript:

{
  addWords?: boolean;
  btrie?: string;
  description?: string;
  ignoreForbiddenWords?: boolean;
  kind?: ("words" | "flag-words" | "ignore-words" | "suggest-words");
  name: string;
  noSuggest?: boolean;
  path: string;
  scope?: (("user" | "workspace" | "folder") | ("user" | "workspace" | "folder")[]);
  supportNonStrictSearches?: boolean;
}

`CustomDictionaryEntry`

Name

CustomDictionaryEntry

Description

Type

Any of:

CustomDictionaryAugmentExistingDictionary
CustomDictionary
string

( CustomDictionaryAugmentExistingDictionary | CustomDictionary | string )

Settings​

cSpell.allowCompoundWords​

cSpell.customFolderDictionaries​

cSpell.customUserDictionaries​

cSpell.customWorkspaceDictionaries​

cSpell.enabledLanguageIds​

cSpell.showStatus​

cSpell.showStatusAlignment​

Type Definitions​

CustomDictionaryAugmentExistingDictionary​

CustomDictionary​

CustomDictionaryEntry​

Settings

`cSpell.allowCompoundWords`

`cSpell.customFolderDictionaries`

`cSpell.customUserDictionaries`

`cSpell.customWorkspaceDictionaries`

`cSpell.enabledLanguageIds`

`cSpell.showStatus`

`cSpell.showStatusAlignment`

Type Definitions

`CustomDictionaryAugmentExistingDictionary`

`CustomDictionary`

`CustomDictionaryEntry`