OptionalallowTrue to enable compound word checking.
OptionalcaseDetermines 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.OptionaldescriptionOptional description of configuration.
OptionaldictionariesOptional 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.
OptionaldictionaryDefine 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"]
OptionalenabledIs the spell checker enabled.
OptionalenabledEnable / Disable checking file types (languageIds).
This setting replaces: Settings.enabledLanguageIds and Settings.enableFiletypes.
A Value of:
true - enable checking for the file typefalse - disable checking for the file typeA 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. |
OptionalenabledSpecify a list of file types to spell check. It is better to use Settings.enabledFileTypes to Enable / Disable checking files types.
OptionalenableEnable / Disable checking file types (languageIds).
These are in additional to the file types specified by Settings.enabledLanguageIds.
To disable a language, prefix with ! as in !json,
Example: individual file types
jsonc // enable checking for jsonc
!json // disable checking for json
kotlin // enable checking for kotlin
Example: enable all file types
* // enable checking for all file types
!json // except for json
OptionalflagList of words to always be considered incorrect. Words found in flagWords override words.
Format of flagWords
wordword:suggestion or word->suggestion, suggestionsExample:
"flagWords": [
"color: colour",
"incase: in case, encase",
"canot->cannot",
"cancelled->canceled"
]
OptionalidOptional identifier.
OptionalignoreList 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.
OptionalignoreList of words to be ignored. An ignored word will not show up as an error, even if it is
also in the flagWords.
OptionalincludeList 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.
OptionallanguageCurrent active spelling language. This specifies the language locale to use in choosing the general dictionary.
For example:
OptionallanguageForces the spell checker to assume a give language id. Used mainly as an Override.
OptionallanguageAdditional settings for individual languages.
See Language Settings for more details.
OptionalloadBy default, the bundled dictionary configurations are loaded. Explicitly setting this to false
will prevent ALL default configuration from being loaded.
OptionalmaxThe maximum number of times the same word can be flagged as an error in a file.
OptionalmaxThe maximum number of problems to report in a file.
OptionalminThe minimum length of a word before checking it against a dictionary.
OptionalnameOptional name of configuration.
OptionalnoOptional 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.
OptionalnumNumber of suggestions to make.
OptionaloverridesOverrides 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"
}
]
Optional ExperimentalparserParser to use for the file content
OptionalpatternsDefines 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"]
}
]
OptionalpnpThe PnP files to search for. Note: .mjs files are not currently supported.
OptionalsuggestionThe 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.
OptionalsuggestionsThe maximum amount of time in milliseconds to generate suggestions for a word.
OptionalsuggestA 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
word: suggestionword->suggestionword: first, second, thirdword->first, second, thirdOptionalusePackages 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.
OptionalwordsList of words to be considered correct.
In the below JSDoc comment, we helpfully specify an example configuration for the end-user to reference. And this example will get captured by the automatic documentation generator.
However, specifying the glob pattern inside of a JSDoc is tricky, because the glob contains the same symbol as the end-of-JSDoc symbol. To work around this, we insert a zero-width space in between the "*" and the "/" symbols.