CSpell Configuration

CompatibleEngineVersions

`dictionaryDefinitions`

Description

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

Type

DictionaryDefinition[]

`enabled`

Description: Is the spell checker enabled.
Type: boolean

`enabledFileTypes`

Description

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.

Type

object

Since

8.8.1

`enabledLanguageIds`

Description: Specify a list of file types to spell check. It is better to use Settings.enabledFileTypes to Enable / Disable checking files types.
Type: LanguageIdSingle[]

`enableFiletypes`

Description

Enable / Disable checking file types (languageIds).

These are in addition 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

Type

LanguageIdSingle[]

`enableGlobDot`

Description

Enable scanning files and directories beginning with . (period).

By default, CSpell does not scan hidden files.

Type

boolean

`engines`

Description

Specify compatible engine versions.

This allows dictionaries and other components to specify the versions of engines (like cspell) they are compatible with.

It does not enforce compatibility, it is up to the client to use this information as needed.

Type

Since

9.6.3

`failFast`

Description: Exit with non-zero code as soon as an issue/error is encountered (useful for CI or git hooks)
Type: boolean

`features`

Description: Configure CSpell features.
Type: Features
Since: 5.16.0

`files`

Description

Glob patterns of files to be checked.

Glob patterns are relative to the globRoot of the configuration file that defines them.

Type

Glob[]

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type

string[]

`gitignoreRoot`

Description: Tells the spell checker to stop searching for .gitignore files when it reaches a matching root.
Type: FsPath
FsPath[]

`globRoot`

Description

The root to use for glob patterns found in this configuration. Default: location of the configuration file. For compatibility reasons, for config files with version 0.1, the glob root will default to be ${cwd}.

Use globRoot to define a different location. globRoot can be relative to the location of this configuration file. Defining globRoot does not impact imported configurations.

Special Values:

${cwd} - will be replaced with the current working directory.
. - will be the location of the containing configuration file.

Type

FSPathResolvable

`id`

Description: Optional identifier.
Type: string

`ignorePaths`

Description

Glob patterns of files to be ignored.

Glob patterns are relative to the globRoot of the configuration file that defines them.

The default is ["node_modules/"].

Warning: if you ignore ".git/" then it will also ignore ".git/COMMIT_EDITMSG" which is needed for the commit-msg git hook; in that case, rather use [".git/{info,lfs,logs,refs,objects}/**", ".git/{index,*refs,*HEAD}"].

Type

Glob[]

`ignoreRandomStrings`

Description: Ignore sequences of characters that look like random strings.
Type: boolean

`ignoreRegExpList`

Description

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.

Type

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type: string[]

`import`

Description

Allows this configuration to inherit configuration for one or more other files.

See Importing / Extending Configuration for more details.

Type

FsPath
FsPath[]

`includeRegExpList`

Description

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.

Type

`language`

Description

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.

Type

LocaleId

`languageId`

Description: Forces the spell checker to assume a given language id. Used mainly as an Override.
Type: MatchingFileType

`languageSettings`

Description

Additional settings for individual languages.

See Language Settings for more details.

Type

LanguageSetting[]

`loadDefaultConfiguration`

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

`maxDuplicateProblems`

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

`maxFileSize`

Description

The Maximum size of a file to spell check. This is used to prevent spell checking very large files.

The value can be number or a string formatted <number>[units], number with optional units.

Supported units:

K, KB - value * 1024
M, MB - value * 2^20
G, GB - value * 2^30

Special values:

0 - has the effect of removing the limit.

Examples:

1000000 - 1 million bytes
1000K or 1000KB - 1 thousand kilobytes
0.5M or 0.5MB - 0.5 megabytes

default: no limit

Type

number,string

Since

9.4.0

`maxNumberOfProblems`

Description: The maximum number of problems to report in a file.
Type: number

`minRandomLength`

Description: The minimum length of a random string to be ignored.
Type: number

`minWordLength`

Description: The minimum length of a word before checking it against a dictionary.
Type: number

`name`

Description: Optional name of configuration.
Type: string

`noConfigSearch`

Description: Prevents searching for local configuration when checking individual documents.
Type: boolean

`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

SoftWordBreakDefinitions

`numSuggestions`

Description: Number of suggestions to make.
Type: number

`overrides`

Description

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

Type

OverrideSettings[]

`patterns`

Description

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

Type

RegExpPatternDefinition[]

`pnpFiles`

Description: The PnP files to search for. Note: .mjs files are not currently supported.
Type: string[]

`readonly`

Description: Indicate that the configuration file should not be modified. This is used to prevent tools like the VS Code Spell Checker from modifying the file to add words and other configuration.
Type: boolean

`reporters`

Description

Define which reports to use. default - is a special name for the default cli reporter.

Examples:

["default"] - to use the default reporter
["@cspell/cspell-json-reporter"] - use the cspell JSON reporter.
[["@cspell/cspell-json-reporter", { "outFile": "out.json" }]]
[ "default", ["@cspell/cspell-json-reporter", { "outFile": "out.json" }]] - Use both the default reporter and the cspell-json-reporter.

Type

ReporterSettings[]

`showStatus`

Description: Show status.
Type: boolean

`softWordBreakDefinitions`

Description

Defines a set of word break rules that can be used for text segmentation.

Soft word breaks are done through injecting soft-hyphens at the appropriate positions in the text before spell checking.

This allows for word breaks that might not be captured by the camel case detection.

Note: soft-hyphens are removed before checking the word against the dictionaries.

For example, if there is a soft-hyphen (represented by a |) injected between error and code error|code, the following words would be checked against the dictionaries: errorcode, error, and code.

Type

Since

10.3.1

`softWordBreaks`

Description: Allows enabling or disabling soft word break rules by name.
Type: SoftWordBreaks
Since: 10.3.1

`spellCheckDelayMs`

Description: Delay in ms after a document has changed before checking it for spelling errors.
Type: number

`substitutionDefinitions`

Description: The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.
Type: SubstitutionDefinitions
Since: 9.7.0

`substitutions`

Description: The set of substitutions to apply to a document before spell checking.
Type: Substitutions
Since: 9.7.0

`suggestionNumChanges`

Description

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.

Type

number

`suggestionsTimeout`

Description: The maximum amount of time in milliseconds to generate suggestions for a word.
Type: number

`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[]

`unknownWords`

Description

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.

Type

UnknownWordsChoices

Since

9.1.0

`useGitignore`

Description: Tells the spell checker to load .gitignore files and skip files that match the globs in the .gitignore files found.
Type: boolean

`useIntlWordSegmentation`

Description: 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.
Type: boolean
Since: 10.2.0

`usePnP`

Description

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.

Type

boolean

`userWords`

Description: Words to add to global dictionary -- should only be in the user config file.
Type: string[]

`validateDirectives`

Description: Verify that the in-document directives are correct.
Type: boolean

`version`

Description

Configuration format version of the settings file.

This controls how the settings in the configuration file behave.

Type

Version

`vfs`

Description

Files to add to the CSpell Virtual File System.

They can be referenced using cspell-vfs:///<module>/<path-to-file>/<file-name> URLs.

They can be referenced in the path field of dictionary definitions.

Type

CSpellVFS

Since

9.7.0

`words`

Description: List of words to be considered correct.
Type: string[]

CSpellVFS

Field	Type	Description

CSpellVFS Fields

CSpellVFSData

Description: The data content of a CSpellVFS file.
Type: CSpellVFSTextData

CSpellVFSFileEntry

Field	Type	Description
data ^req	`CSpellVFSData`	The content data of the file.
encoding	`"base64"`	`"plaintext"`
url	`CSpellVFSFileUrl`	The optional file vfs url. It is already part of the CSpellVFS key.

CSpellVFSFileEntry Fields

`data`

Description: The content data of the file.
Type _{^{< required >}}: CSpellVFSData

`encoding`

Description: The encoding of the data. In most cases the encoding is determined from the data type and filename url.
Type: "base64" | "plaintext" | "utf8"

`url`

Description: The optional file vfs url. It is already part of the CSpellVFS key.
Type: CSpellVFSFileUrl

CSpellVFSFileUrl

Description

A URL string representing a CSpellVFS file. It should be of the form:

cspell-vfs:///<module>/<path-to-file>/<file-name>

Example: cspell-vfs:///@cspell/dict-en_us/en_US.trie.gz

Type

string

Since

9.7.0

CSpellVFSTextData

Description: Data content stored in a string for CSpellVFS file. It is often encoded (e.g. base64) binary data.
Type: string

CacheFormat

Type: "legacy" | "universal"

CacheSettings

Field	Type	Description
cacheFormat	`CacheFormat`	Format of the cache file.
cacheLocation	`FSPathResolvable`	Path to the cache location. Can be a file or a directory.
cacheStrategy	`CacheStrategy`	Strategy to use for detecting changed files, default: content
useCache	`boolean`	Store the results of processed files in order to only operate on the changed ones.

CacheSettings Fields

`cacheFormat`

Description

Format of the cache file.

legacy - use absolute paths in the cache file
universal - use a sharable format.

Type

CacheFormat

`cacheLocation`

Description

Path to the cache location. Can be a file or a directory. If none specified .cspellcache will be used. Relative paths are relative to the config file in which it is defined.

A prefix of ${cwd} is replaced with the current working directory.

Type

FSPathResolvable

`cacheStrategy`

Description: Strategy to use for detecting changed files, default: content
Type: CacheStrategy

`useCache`

Description: Store the results of processed files in order to only operate on the changed ones.
Type: boolean

CacheStrategy

Description

The Strategy to use to detect if a file has changed.

content - uses a hash of the file content to check file changes (slower - more accurate).
metadata - uses the file system timestamp and size to detect changes (fastest, may not work in CI).

Type

"content" | "metadata"

CharacterSet

Description

This is a set of characters that can include - or |

- - indicates a range of characters: a-c => abc
| - is a group separator, indicating that the characters on either side are not related.

Type

string

CharacterSetCosts

Field	Type	Description
characters ^req	`CharacterSet`	This is a set of characters that can include `-` or `
cost ^req	`number`	the cost to insert / delete / replace / swap the characters in a group
penalty	`number`	The penalty cost to apply if the accent is used.

CharacterSetCosts Fields

`characters`

Description

This is a set of characters that can include - or |

- - indicates a range of characters: a-c => abc
| - is a group separator, indicating that the characters on either side are not related.

Type _{^{< required >}}

CharacterSet

`cost`

Description: the cost to insert / delete / replace / swap the characters in a group
Type _{^{< required >}}: number

`penalty`

Description: The penalty cost to apply if the accent is used. This is used to discourage
Type: number

CompatibleEngineVersions

Field	Type	Description
code-spell-checker	`SemVersionPredicate`	The VSCode Spell Checker version predicate.
cspell	`SemVersionPredicate`	CSpell version predicate.

CompatibleEngineVersions Fields

`code-spell-checker`

Description: The VSCode Spell Checker version predicate.
Type: SemVersionPredicate
Since: 9.6.3

`cspell`

Description: CSpell version predicate.
Type: SemVersionPredicate
Since: 9.6.3

CostMapDefInsDel

Field	Type	Description
insDel ^req	`number`	The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
map ^req	`string`	The set of substrings to map, these are generally single character strings.
description	`string`	A description to describe the purpose of the map.
penalty	`number`	Add a penalty to the final cost.
replace	`number`	The cost to replace of of the substrings in the map with another substring in the map.
swap	`number`	The cost to swap two adjacent substrings found in the map.

CostMapDefInsDel Fields

`insDel`

Description: The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
Type _{^{< required >}}: number

`map`

Description

The set of substrings to map, these are generally single character strings.

Multiple sets can be defined by using a | to separate them.

Example: "eéê|aåá" contains two different sets.

To add a multi-character substring use ().

Example: "f(ph)(gh)" results in the following set: f, ph, gh.

To match the beginning of a word, use ^: "(^I)"".
To match the end of a word, use $: "(e$)(ing$)".

Type _{^{< required >}}

string

`description`

Description: A description to describe the purpose of the map.
Type: string

`penalty`

Description

Add a penalty to the final cost. This is used to discourage certain suggestions.

Example:

# Match adding/removing `-` to the end of a word.
map: "$(-$)"
replace: 50
penalty: 100

This makes adding a - to the end of a word more expensive.

Think of it as taking the toll way for speed but getting the bill later.

Type

number

`replace`

Description: The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute a with i: Like bat to bit or the reverse.
Type: number

`swap`

Description: The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change ei to ie or the reverse.
Type: number

CostMapDefReplace

Field	Type	Description
map ^req	`string`	The set of substrings to map, these are generally single character strings.
replace ^req	`number`	The cost to replace of of the substrings in the map with another substring in the map.
description	`string`	A description to describe the purpose of the map.
insDel	`number`	The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
penalty	`number`	Add a penalty to the final cost.
swap	`number`	The cost to swap two adjacent substrings found in the map.

CostMapDefReplace Fields

`map`

Description

The set of substrings to map, these are generally single character strings.

Multiple sets can be defined by using a | to separate them.

Example: "eéê|aåá" contains two different sets.

To add a multi-character substring use ().

Example: "f(ph)(gh)" results in the following set: f, ph, gh.

To match the beginning of a word, use ^: "(^I)"".
To match the end of a word, use $: "(e$)(ing$)".

Type _{^{< required >}}

string

`replace`

Description: The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute a with i: Like bat to bit or the reverse.
Type _{^{< required >}}: number

`description`

Description: A description to describe the purpose of the map.
Type: string

`insDel`

Description: The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
Type: number

`penalty`

Description

Add a penalty to the final cost. This is used to discourage certain suggestions.

Example:

# Match adding/removing `-` to the end of a word.
map: "$(-$)"
replace: 50
penalty: 100

This makes adding a - to the end of a word more expensive.

Think of it as taking the toll way for speed but getting the bill later.

Type

number

`swap`

Description: The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change ei to ie or the reverse.
Type: number

CostMapDefSwap

Field	Type	Description
map ^req	`string`	The set of substrings to map, these are generally single character strings.
swap ^req	`number`	The cost to swap two adjacent substrings found in the map.
description	`string`	A description to describe the purpose of the map.
insDel	`number`	The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
penalty	`number`	Add a penalty to the final cost.
replace	`number`	The cost to replace of of the substrings in the map with another substring in the map.

CostMapDefSwap Fields

`map`

Description

The set of substrings to map, these are generally single character strings.

Multiple sets can be defined by using a | to separate them.

Example: "eéê|aåá" contains two different sets.

To add a multi-character substring use ().

Example: "f(ph)(gh)" results in the following set: f, ph, gh.

To match the beginning of a word, use ^: "(^I)"".
To match the end of a word, use $: "(e$)(ing$)".

Type _{^{< required >}}

string

`swap`

Description: The cost to swap two adjacent substrings found in the map. Example: Map['e', 'i'] This represents the cost to change ei to ie or the reverse.
Type _{^{< required >}}: number

`description`

Description: A description to describe the purpose of the map.
Type: string

`insDel`

Description: The cost to insert/delete one of the substrings in the map. Note: insert/delete costs are symmetrical.
Type: number

`penalty`

Description

Add a penalty to the final cost. This is used to discourage certain suggestions.

Example:

# Match adding/removing `-` to the end of a word.
map: "$(-$)"
replace: 50
penalty: 100

This makes adding a - to the end of a word more expensive.

Think of it as taking the toll way for speed but getting the bill later.

Type

number

`replace`

Description: The cost to replace of of the substrings in the map with another substring in the map. Example: Map['a', 'i'] This would be the cost to substitute a with i: Like bat to bit or the reverse.
Type: number

CustomDictionaryPath

Description: A path or url to a custom dictionary file.
Type: string

CustomDictionaryScope

Description: Specifies the scope of a dictionary.
Type: "user" | "workspace" | "folder"

DictionaryDefinition

Type: DictionaryDefinitionPreferred
DictionaryDefinitionCustom
DictionaryDefinitionAugmented
DictionaryDefinitionInline
DictionaryDefinitionSimple
DictionaryDefinitionAlternate

DictionaryDefinitionAlternate

Field	Type	Description
file ^req	`DictionaryPath`	Path to the file, only for legacy dictionary definitions.
name ^req	`DictionaryId`	This is the name of a dictionary.
description	`string`	Optional description of the contents / purpose of the dictionary.
ignoreForbiddenWords	`boolean`	Some dictionaries may contain forbidden words to prevent compounding from generating
kind	`DictionaryKind`	Used to specify the type of dictionary being referenced.
noSuggest	`boolean`	Indicate that suggestions should not come from this dictionary.
repMap	`ReplaceMap`	Replacement pairs.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
type	`DictionaryFileTypes`	Type of file:
useCompounds	`boolean`	Use Compounds.

DictionaryDefinitionAlternate Fields

`file`

Description: Path to the file, only for legacy dictionary definitions.
Type _{^{< required >}}: DictionaryPath

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

`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

`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

Since

10.3.0

`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

`repMap`

Description: Replacement pairs.
Type: ReplaceMap

`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

`type`

Description

Type of file:

S - single word per line,
W - each line can contain one or more words separated by space,
C - each line is treated like code (Camel Case is allowed).

Default is S.

C is the slowest to load due to the need to split each line based upon code splitting rules.

Note: this settings does not apply to inline dictionaries or .trie files.

Type

`useCompounds`

Description: Use Compounds.
Type: boolean

DictionaryDefinitionAugmented

Field	Type	Description
name ^req	`DictionaryId`	This is the name of a dictionary.
path ^req	`DictionaryPath`	Path or url to the dictionary file.
btrie	`DictionaryPathToBTrie`	An alternative path to a bTrie dictionary file.
description	`string`	Optional description of the contents / purpose of the dictionary.
dictionaryInformation	`DictionaryInformation`
ignoreForbiddenWords	`boolean`	Some dictionaries may contain forbidden words to prevent compounding from generating
kind	`DictionaryKind`	Used to specify the type of dictionary being referenced.
noSuggest	`boolean`	Indicate that suggestions should not come from this dictionary.
repMap	`ReplaceMap`	Replacement pairs.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
type	`DictionaryFileTypes`	Type of file:
useCompounds	`boolean`	Use Compounds.

DictionaryDefinitionAugmented Fields

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`path`

Description: Path or url to the dictionary file.
Type _{^{< required >}}: DictionaryPath

`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: DictionaryPathToBTrie
Since: 9.6.0

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

`dictionaryInformation`

Type: DictionaryInformation

`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

`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

Since

10.3.0

`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

`repMap`

Description: Replacement pairs.
Type: ReplaceMap

`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

`type`

Description

Type of file:

S - single word per line,
W - each line can contain one or more words separated by space,
C - each line is treated like code (Camel Case is allowed).

Default is S.

C is the slowest to load due to the need to split each line based upon code splitting rules.

Note: this settings does not apply to inline dictionaries or .trie files.

Type

`useCompounds`

Description: Use Compounds.
Type: boolean

DictionaryDefinitionCustom

Field	Type	Description
addWords ^req	`boolean`	When `true`, let's the spell checker know that words can be added to this dictionary.
name ^req	`DictionaryId`	This is the name of a dictionary.
path ^req	`CustomDictionaryPath`	A file path or url to a custom dictionary file.
btrie	`DictionaryPathToBTrie`	An alternative path to a bTrie dictionary file.
description	`string`	Optional description of the contents / purpose of the dictionary.
ignoreForbiddenWords	`boolean`	Some dictionaries may contain forbidden words to prevent compounding from generating
kind	`DictionaryKind`	Used to specify the type of dictionary being referenced.
noSuggest	`boolean`	Indicate that suggestions should not come from this dictionary.
repMap	`ReplaceMap`	Replacement pairs.
scope	`CustomDictionaryScope` `CustomDictionaryScope``[]`	Defines the scope for when words will be added to the dictionary.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
type	`DictionaryFileTypes`	Type of file:
useCompounds	`boolean`	Use Compounds.

DictionaryDefinitionCustom Fields

`addWords`

Description: When true, let's the spell checker know that words can be added to this dictionary.
Type _{^{< required >}}: boolean

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`path`

Description: A file path or url to a custom dictionary file.
Type _{^{< required >}}: CustomDictionaryPath

`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: DictionaryPathToBTrie
Since: 9.6.0

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

`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

`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

CustomDictionaryScope
CustomDictionaryScope[]

Since

10.3.0

`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

`repMap`

Description: Replacement pairs.
Type: ReplaceMap

`scope`

Description

Defines the scope for when words will be added to the dictionary.

Scope values: user, workspace, folder.

Type

`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

`type`

Description

Type of file:

S - single word per line,
W - each line can contain one or more words separated by space,
C - each line is treated like code (Camel Case is allowed).

Default is S.

C is the slowest to load due to the need to split each line based upon code splitting rules.

Note: this settings does not apply to inline dictionaries or .trie files.

Type

`useCompounds`

Description: Use Compounds.
Type: boolean

DictionaryDefinitionInline

Description: Inline Dictionary Definitions
Type: DictionaryDefinitionInlineWords
DictionaryDefinitionInlineIgnoreWords
DictionaryDefinitionInlineFlagWords
DictionaryDefinitionInlineSuggestWords
Since: 6.23.0

DictionaryDefinitionInlineFlagWords

Field	Type	Description
flagWords ^req	`string``[]`	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
name ^req	`DictionaryId`	This is the name of a dictionary.
description	`string`	Optional description of the contents / purpose of the dictionary.
ignoreWords	`string``[]`	List of words to be ignored. An ignored word will not show up as an error, even if it is
suggestWords	`string``[]`	A list of suggested replacements for words.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
words	`string``[]`	List of words to be considered correct.

DictionaryDefinitionInlineFlagWords Fields

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type _{^{< required >}}

string[]

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type: string[]

`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[]

`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

`words`

Description: List of words to be considered correct.
Type: string[]

DictionaryDefinitionInlineIgnoreWords

Field	Type	Description
ignoreWords ^req	`string``[]`	List of words to be ignored. An ignored word will not show up as an error, even if it is
name ^req	`DictionaryId`	This is the name of a dictionary.
description	`string`	Optional description of the contents / purpose of the dictionary.
flagWords	`string``[]`	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
suggestWords	`string``[]`	A list of suggested replacements for words.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
words	`string``[]`	List of words to be considered correct.

DictionaryDefinitionInlineIgnoreWords Fields

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type _{^{< required >}}: string[]

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type

string[]

`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[]

`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

`words`

Description: List of words to be considered correct.
Type: string[]

DictionaryDefinitionInlineSuggestWords

Field	Type	Description
name ^req	`DictionaryId`	This is the name of a dictionary.
suggestWords ^req	`string``[]`	A list of suggested replacements for words.
description	`string`	Optional description of the contents / purpose of the dictionary.
flagWords	`string``[]`	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
ignoreWords	`string``[]`	List of words to be ignored. An ignored word will not show up as an error, even if it is
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
words	`string``[]`	List of words to be considered correct.

DictionaryDefinitionInlineSuggestWords Fields

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`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 _{^{< required >}}

string[]

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type

string[]

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type: string[]

`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

`words`

Description: List of words to be considered correct.
Type: string[]

DictionaryDefinitionInlineWords

Field	Type	Description
name ^req	`DictionaryId`	This is the name of a dictionary.
words ^req	`string``[]`	List of words to be considered correct.
description	`string`	Optional description of the contents / purpose of the dictionary.
flagWords	`string``[]`	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
ignoreWords	`string``[]`	List of words to be ignored. An ignored word will not show up as an error, even if it is
suggestWords	`string``[]`	A list of suggested replacements for words.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and

DictionaryDefinitionInlineWords Fields

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`words`

Description: List of words to be considered correct.
Type _{^{< required >}}: string[]

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type

string[]

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type: string[]

`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[]

`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

DictionaryDefinitionPreferred

Field	Type	Description
name ^req	`DictionaryId`	This is the name of a dictionary.
path ^req	`DictionaryPath`	Path or url to the dictionary file.
btrie	`DictionaryPathToBTrie`	An alternative path to a bTrie dictionary file.
description	`string`	Optional description of the contents / purpose of the dictionary.
ignoreForbiddenWords	`boolean`	Some dictionaries may contain forbidden words to prevent compounding from generating
kind	`DictionaryKind`	Used to specify the type of dictionary being referenced.
noSuggest	`boolean`	Indicate that suggestions should not come from this dictionary.
repMap	`ReplaceMap`	Replacement pairs.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and
type	`DictionaryFileTypes`	Type of file:
useCompounds	`boolean`	Use Compounds.

DictionaryDefinitionPreferred Fields

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

`path`

Description: Path or url to the dictionary file.
Type _{^{< required >}}: DictionaryPath

`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: DictionaryPathToBTrie
Since: 9.6.0

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

`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

`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

Since

10.3.0

`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

`repMap`

Description: Replacement pairs.
Type: ReplaceMap

`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

`type`

Description

Type of file:

S - single word per line,
W - each line can contain one or more words separated by space,
C - each line is treated like code (Camel Case is allowed).

Default is S.

C is the slowest to load due to the need to split each line based upon code splitting rules.

Note: this settings does not apply to inline dictionaries or .trie files.

Type

`useCompounds`

Description: Use Compounds.
Type: boolean

DictionaryDefinitionSimple

Field	Type	Description
name ^req	`DictionaryId`	This is the name of a dictionary.
description	`string`	Optional description of the contents / purpose of the dictionary.
supportNonStrictSearches	`boolean`	Strip case and accents to allow for case insensitive searches and

DictionaryDefinitionSimple Fields

`name`

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type _{^{< required >}}

DictionaryKindWords
DictionaryKindFlagWords
DictionaryKindIgnoreWords
DictionaryKindSuggestWords

`description`

Description: Optional description of the contents / purpose of the dictionary.
Type: string

`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

DictionaryFileTypes

Type: "S" | "W" | "C" | "T"

DictionaryId

Description

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 *, !, ;, ,, {, }, [, ], ~.

Type

string

DictionaryInformation

Field	Type	Description
accents	`CharacterSet` `CharacterSetCosts``[]`	The accent characters.
adjustments	`PatternAdjustment``[]`	A collection of patterns to test against the suggested words.
alphabet	`CharacterSet` `CharacterSetCosts``[]`	The alphabet to use.
costs	`EditCosts`	Define edit costs.
hunspellInformation	`HunspellInformation`	Used by dictionary authors
ignore	`CharacterSet`	An optional set of characters that can possibly be removed from a word before
locale	`string`	The locale of the dictionary.
suggestionEditCosts	`SuggestionCostsDefs`	Used in making suggestions. The lower the value, the more likely the suggestion

DictionaryInformation Fields

`accents`

Description

The accent characters.

Default: "\u0300-\u0341"

Type

CharacterSet
CharacterSetCosts[]

`adjustments`

Description: A collection of patterns to test against the suggested words. If the word matches the pattern, then the penalty is applied.
Type: PatternAdjustment[]

`alphabet`

Description: The alphabet to use.
Type: CharacterSet
CharacterSetCosts[]

`costs`

Description: Define edit costs.
Type: EditCosts

`hunspellInformation`

Description: Used by dictionary authors
Type: HunspellInformation

`ignore`

Description

An optional set of characters that can possibly be removed from a word before checking it.

This is useful in languages like Arabic where Harakat accents are optional.

Note: All matching characters are removed or none. Partial removal is not supported.

Type

CharacterSet

`locale`

Description: The locale of the dictionary. Example: nl,nl-be
Type: string

`suggestionEditCosts`

Description: Used in making suggestions. The lower the value, the more likely the suggestion will be near the top of the suggestion list.
Type: SuggestionCostsDefs

DictionaryKind

Description

The kind of dictionary.

Used to specify the type of dictionary being referenced.

Values:

words - A dictionary containing words.
flag-words - A dictionary containing flag words.
ignore-words - A dictionary containing words to ignore.
suggest-words - A dictionary containing suggested word corrections.

Type

DictionaryKindFlagWords

Type: string

DictionaryKindIgnoreWords

Type: string

DictionaryKindSuggestWords

Type: string

DictionaryKindWords

Type: string

DictionaryNegRef

Description

This a negative reference to a named dictionary.

It is used to exclude or include a dictionary by name.

The reference starts with 1 or more !.

!<dictionary_name> - Used to exclude the dictionary matching <dictionary_name>.
!!<dictionary_name> - Used to re-include a dictionary matching <dictionary_name>. Overrides !<dictionary_name>.
!!!<dictionary_name> - Used to exclude a dictionary matching <dictionary_name>. Overrides !!<dictionary_name>.

Type

string

DictionaryPath

Description: A File System Path to a dictionary file. Pattern: ^.*\.(?:txt|trie|btrie|dic)(?:\.gz)?$
Type: string

DictionaryPathToBTrie

Description: A File System Path to a dictionary file. Pattern: ^.*\.(?:btrie)(?:\.gz)?$
Type: string
Since: 9.6.0

DictionaryRef

Description: This a reference to a named dictionary. It is expected to match the name of a dictionary.
Type: DictionaryId

DictionaryReference

Description

Reference to a dictionary by name. One of:

DictionaryRef
DictionaryNegRef

Type

DictionaryRef
DictionaryNegRef

EditCosts

Field	Type	Description
accentCosts	`number`	The cost to add / remove an accent
baseCost	`number`	This is the base cost for making an edit.
capsCosts	`number`	The cost to change capitalization.
firstLetterPenalty	`number`	The extra cost incurred for changing the first letter of a word.
nonAlphabetCosts	`number`	This is the cost for characters not in the alphabet.

EditCosts Fields

`accentCosts`

Description: The cost to add / remove an accent This should be very cheap, it helps with fixing accent issues.
Type: number

`baseCost`

Description: This is the base cost for making an edit.
Type: number

`capsCosts`

Description: The cost to change capitalization. This should be very cheap, it helps with fixing capitalization issues.
Type: number

`firstLetterPenalty`

Description: The extra cost incurred for changing the first letter of a word. This value should be less than 100 - baseCost.
Type: number

`nonAlphabetCosts`

Description: This is the cost for characters not in the alphabet.
Type: number

FSPathResolvable

Description

A File System Path.

Special Properties:

${cwd} prefix - will be replaced with the current working directory.
Relative paths are relative to the configuration file.

Type

FsPath

FeatureEnableOnly

Type: boolean

Features

Field	Type	Description
weighted-suggestions	`FeatureEnableOnly`	Enable/disable using weighted suggestions.

Features Fields

`weighted-suggestions`

Description: Enable/disable using weighted suggestions.
Type: FeatureEnableOnly

FsPath

Description: A File System Path. Relative paths are relative to the configuration file.
Type: string

Glob

Description: These are glob expressions.
Type: SimpleGlob

HunspellInformation

Field	Type	Description
aff ^req	`string`	Selected Hunspell AFF content.
costs	`object`	The costs to apply when using the hunspell settings

HunspellInformation Fields

`aff`

Description

Selected Hunspell AFF content. The content must be UTF-8

Sections:

TRY
MAP
REP
KEY
ICONV
OCONV

Example:

# Comment
TRY aeistlunkodmrvpgjhäõbüoöfcwzxðqþ`
MAP aàâäAÀÂÄ
MAP eéèêëEÉÈÊË
MAP iîïyIÎÏY
MAP oôöOÔÖ
MAP (IJ)(Ĳ)

Type _{^{< required >}}

string

`costs`

Description: The costs to apply when using the hunspell settings
Type: object

LanguageId

Type: LanguageIdSingle
LanguageIdMultiple
LanguageIdMultipleNeg

LanguageIdMultiple

Description

A single string with a comma separated list of file types:

typescript,cpp
json,jsonc,yaml
etc.

Type

string

LanguageIdMultipleNeg

Description

A Negative File Type used to exclude files of that type.

!typescript - will exclude typescript files.
!cpp,!json - will exclude cpp and json files.
!typescript,javascript - will exclude typescript files and include javascript files.

Type

string

LanguageIdSingle

Description

A file type:

* - will match ALL file types.
typescript, cpp, json, etc.

Type

string

LanguageSetting

Field	Type	Description
languageId ^req	`MatchingFileType`	The language id. Ex: `typescript`, `html`, or `php`. `*` -- will match all languages.
allowCompoundWords	`boolean`	True to enable compound word checking.
caseSensitive	`boolean`	Determines if words must match case and accent rules.
description	`string`	Optional description of configuration.
dictionaries	`DictionaryReference``[]`	Optional list of dictionaries to use. Each entry should match the name of the dictionary.
dictionaryDefinitions	`DictionaryDefinition``[]`	Define additional available dictionaries.
enabled	`boolean`	Is the spell checker enabled.
flagWords	`string``[]`	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
id	`string`	Optional identifier.
ignoreRegExpList	`RegExpPatternList`	List of regular expression patterns or pattern names to exclude from spell checking.
ignoreWords	`string``[]`	List of words to be ignored. An ignored word will not show up as an error, even if it is
includeRegExpList	`RegExpPatternList`	List of regular expression patterns or defined pattern names to match for spell checking.
local	`LocaleId` `LocaleId``[]`	Deprecated - The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.
locale	`LocaleId` `LocaleId``[]`	The locale filter, matches against the language. This can be a comma separated list. `*` will match all locales.
name	`string`	Optional name of configuration.
noSuggestDictionaries	`DictionaryReference``[]`	Optional list of dictionaries that will not be used for suggestions.
patterns	`RegExpPatternDefinition``[]`	Defines a list of patterns that can be used with the ignoreRegExpList and
softWordBreakDefinitions	`SoftWordBreakDefinitions`	Defines a set of word break rules that can be used for text segmentation.
softWordBreaks	`SoftWordBreaks`	Allows enabling or disabling soft word break rules by name.
substitutionDefinitions	`SubstitutionDefinitions`	The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.
substitutions	`Substitutions`	The set of substitutions to apply to a document before spell checking.
suggestWords	`string``[]`	A list of suggested replacements for words.
unknownWords	`UnknownWordsChoices`	Controls how unknown words are handled.
useIntlWordSegmentation	`boolean`	Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
words	`string``[]`	List of words to be considered correct.

LanguageSetting Fields

`languageId`

Description: The language id. Ex: typescript, html, or php. * -- will match all languages.
Type _{^{< required >}}: MatchingFileType

`allowCompoundWords`

Description: True to enable compound word checking.
Type: boolean

`caseSensitive`

Description

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.

Type

boolean

`description`

Description: Optional description of configuration.
Type: string

`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.

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

See the Dictionaries and Custom Dictionaries for more details.

Type

`dictionaryDefinitions`

Description

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

Type

DictionaryDefinition[]

`enabled`

Description: Is the spell checker enabled.
Type: boolean

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type

string[]

`id`

Description: Optional identifier.
Type: string

`ignoreRegExpList`

Description

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.

Type

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type: string[]

`includeRegExpList`

Description

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.

Type

`local`

Description: Deprecated - The locale filter, matches against the language. This can be a comma separated list. * will match all locales.
Type: LocaleId
LocaleId[]

`locale`

Description: The locale filter, matches against the language. This can be a comma separated list. * will match all locales.
Type: LocaleId
LocaleId[]

`name`

Description: Optional name of configuration.
Type: string

`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

SoftWordBreakDefinitions

`patterns`

Description

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

Type

RegExpPatternDefinition[]

`softWordBreakDefinitions`

Description

Defines a set of word break rules that can be used for text segmentation.

Soft word breaks are done through injecting soft-hyphens at the appropriate positions in the text before spell checking.

This allows for word breaks that might not be captured by the camel case detection.

Note: soft-hyphens are removed before checking the word against the dictionaries.

Type

Since

10.3.1

`softWordBreaks`

Description: Allows enabling or disabling soft word break rules by name.
Type: SoftWordBreaks
Since: 10.3.1

`substitutionDefinitions`

Description: The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.
Type: SubstitutionDefinitions
Since: 9.7.0

`substitutions`

Description: The set of substitutions to apply to a document before spell checking.
Type: Substitutions
Since: 9.7.0

`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[]

`unknownWords`

Description

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.

Type

UnknownWordsChoices

Since

9.1.0

`useIntlWordSegmentation`

Description: 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.
Type: boolean
Since: 10.2.0

`words`

Description: List of words to be considered correct.
Type: string[]

LocaleId

Description: This is a written language locale like: en, en-GB, fr, es, de or en,fr for both English and French
Type: string

MatchingFileType

Type: LanguageId
LanguageId[]

OverrideSettings

Field	Type	Description
filename ^req	`Glob` `Glob``[]`	Glob pattern or patterns to match against.
allowCompoundWords	`boolean`	True to enable compound word checking.
caseSensitive	`boolean`	Determines if words must match case and accent rules.
description	`string`	Optional description of configuration.
dictionaries	`DictionaryReference``[]`	Optional list of dictionaries to use. Each entry should match the name of the dictionary.
dictionaryDefinitions	`DictionaryDefinition``[]`	Define additional available dictionaries.
enabled	`boolean`	Is the spell checker enabled.
enabledFileTypes	`object`	Enable / Disable checking file types (languageIds).
enabledLanguageIds	`LanguageIdSingle``[]`	Specify a list of file types to spell check. It is better to use Settings.enabledFileTypes to Enable / Disable checking files types.
enableFiletypes	`LanguageIdSingle``[]`	Enable / Disable checking file types (languageIds).
flagWords	`string``[]`	List of words to always be considered incorrect. Words found in `flagWords` override `words`.
id	`string`	Optional identifier.
ignoreRandomStrings	`boolean`	Ignore sequences of characters that look like random strings.
ignoreRegExpList	`RegExpPatternList`	List of regular expression patterns or pattern names to exclude from spell checking.
ignoreWords	`string``[]`	List of words to be ignored. An ignored word will not show up as an error, even if it is
includeRegExpList	`RegExpPatternList`	List of regular expression patterns or defined pattern names to match for spell checking.
language	`LocaleId`	Sets the locale.
languageId	`MatchingFileType`	Sets the programming language id to match file type.
languageSettings	`LanguageSetting``[]`	Additional settings for individual languages.
loadDefaultConfiguration	`boolean`	By default, the bundled dictionary configurations are loaded. Explicitly setting this to `false`
maxDuplicateProblems	`number`	The maximum number of times the same word can be flagged as an error in a file.
maxFileSize	`number,string`	The Maximum size of a file to spell check. This is used to prevent spell checking very large files.
maxNumberOfProblems	`number`	The maximum number of problems to report in a file.
minRandomLength	`number`	The minimum length of a random string to be ignored.
minWordLength	`number`	The minimum length of a word before checking it against a dictionary.
name	`string`	Optional name of configuration.
noSuggestDictionaries	`DictionaryReference``[]`	Optional list of dictionaries that will not be used for suggestions.
numSuggestions	`number`	Number of suggestions to make.
patterns	`RegExpPatternDefinition``[]`	Defines a list of patterns that can be used with the ignoreRegExpList and
pnpFiles	`string``[]`	The PnP files to search for. Note: `.mjs` files are not currently supported.
softWordBreakDefinitions	`SoftWordBreakDefinitions`	Defines a set of word break rules that can be used for text segmentation.
softWordBreaks	`SoftWordBreaks`	Allows enabling or disabling soft word break rules by name.
substitutionDefinitions	`SubstitutionDefinitions`	The set of available substitutions. This is a collection of substitution definitions that can be applied to a document before spell checking.
substitutions	`Substitutions`	The set of substitutions to apply to a document before spell checking.
suggestionNumChanges	`number`	The maximum number of changes allowed on a word to be considered a suggestions.
suggestionsTimeout	`number`	The maximum amount of time in milliseconds to generate suggestions for a word.
suggestWords	`string``[]`	A list of suggested replacements for words.
unknownWords	`UnknownWordsChoices`	Controls how unknown words are handled.
useIntlWordSegmentation	`boolean`	Enables locale-sensitive text segmentation to support languages like Japanese, Chinese, Thai, Lao, Khmer, Myanmar, etc.
usePnP	`boolean`	Packages managers like Yarn 2 use a `.pnp.cjs` file to assist in loading
words	`string``[]`	List of words to be considered correct.

OverrideSettings Fields

`filename`

Description: Glob pattern or patterns to match against.
Type _{^{< required >}}: Glob
Glob[]

`allowCompoundWords`

Description: True to enable compound word checking.
Type: boolean

`caseSensitive`

Description

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.

Type

boolean

`description`

Description: Optional description of configuration.
Type: string

`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.

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

See the Dictionaries and Custom Dictionaries for more details.

Type

`dictionaryDefinitions`

Description

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

Type

DictionaryDefinition[]

`enabled`

Description: Is the spell checker enabled.
Type: boolean

`enabledFileTypes`

Description

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.

Type

object

Since

8.8.1

`enabledLanguageIds`

Description: Specify a list of file types to spell check. It is better to use Settings.enabledFileTypes to Enable / Disable checking files types.
Type: LanguageIdSingle[]

`enableFiletypes`

Description

Enable / Disable checking file types (languageIds).

These are in addition 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

Type

LanguageIdSingle[]

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

Case Sensitivity:

A word is flagged if it exactly matches an entry, or if its lowercased form exactly matches an entry. In practice this means:

An entry written in all lowercase (e.g. avocado) flags that word in any casing found in the document — avocado, Avocado, and AVOCADO are all flagged.
An entry containing any uppercase letter (e.g. Avocado) only flags that exact casing — avocado and AVOCADO are not flagged.

Type

string[]

`id`

Description: Optional identifier.
Type: string

`ignoreRandomStrings`

Description: Ignore sequences of characters that look like random strings.
Type: boolean

`ignoreRegExpList`

Description

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.

Type

`ignoreWords`

Description: List of words to be ignored. An ignored word will not show up as an error, even if it is also in the flagWords.
Type: string[]

`includeRegExpList`

Description

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.

Type

`language`

Description: Sets the locale.
Type: LocaleId

`languageId`

Description: Sets the programming language id to match file type.
Type: MatchingFileType

`languageSettings`

Description

Additional settings for individual languages.

See Language Settings for more details.

Type

LanguageSetting[]

`loadDefaultConfiguration`

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

`maxDuplicateProblems`

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

`maxFileSize`

Description

The Maximum size of a file to spell check. This is used to prevent spell checking very large files.

The value can be number or a string formatted <number>[units], number with optional units.

Supported units:

K, KB - value * 1024
M, MB - value * 2^20
G, GB - value * 2^30

Special values:

0 - has the effect of removing the limit.

Examples:

1000000 - 1 million bytes
1000K or 1000KB - 1 thousand kilobytes
0.5M or 0.5MB - 0.5 megabytes

default: no limit

Type

number,string

Since

9.4.0

`maxNumberOfProblems`

Description: The maximum number of problems to report in a file.
Type: number

`minRandomLength`

Description: The minimum length of a random string to be ignored.
Type: number

`minWordLength`

Description: The minimum length of a word before checking it against a dictionary.
Type: number

`name`

Description: Optional name of configuration.
Type: string

`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