Interface CSpellSettings

Url to JSON Schema

True to enable compound word checking.

Define cache settings.

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.

Optional description of configuration.

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.

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

Is the spell checker enabled.

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

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

Enable / Disable checking file types (languageIds).

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

Example: individual file types

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

Example: enable all file types

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

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

By default, CSpell does not scan hidden files.

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

Configure CSpell features.

Glob patterns of files to be checked.

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

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

Tells the spell checker to stop searching for .gitignore files when it reaches a matching root.

The root to use for glob patterns found in this configuration. Default: location of the configuration file. For compatibility reasons, 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.

Optional identifier.

Glob patterns of files to be ignored.

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

Ignore sequences of characters that look like random strings.

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

YAML

ignoreRegExpList:
  - >-
   /\b[A-Z]+\b/g
Copy

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.

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

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

See Importing / Extending Configuration for more details.

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.

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.

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

Additional settings for individual languages.

See Language Settings for more details.

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

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

The maximum number of problems to report in a file.

The minimum length of a random string to be ignored.

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

Optional name of configuration.

Prevents searching for local configuration when checking individual documents.

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.

Number of suggestions to make.

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

Parser to use for the file content

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

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

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.

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.

Show status.

Delay in ms after a document has changed before checking it for spelling errors.

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.

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

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

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

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.

Words to add to global dictionary -- should only be in the user config file.

Verify that the in-document directives are correct.

Configuration format version of the settings file.

This controls how the settings in the configuration file behave.

List of words to be considered correct.