CSpell

Settings related to CSpell Command Line Tool.

Setting	Scope	Description
cSpell.ignoreRandomStrings		Ignore sequences of characters that look like random strings.
cSpell.ignoreRegExpList	resource	List of regular expressions or Pattern names (defined in cSpell.patterns)…
cSpell.includeRegExpList	resource	List of regular expression patterns or defined pattern names to match for spell checking.
cSpell.minRandomLength		The minimum length of a random string to be ignored.
cSpell.overrides	resource	Overrides are used to apply settings for specific files in your project.
cSpell.patterns	resource	Defines a list of patterns that can be used with the cSpell.ignoreRegExpList…
cSpell.unknownWords		Controls how unknown words are handled.

Settings

cSpell.ignoreRandomStrings

Name

cSpell.ignoreRandomStrings

Description

Ignore sequences of characters that look like random strings.

Type

boolean

Scope

- none -

Default

true

---

cSpell.ignoreRegExpList

Name

cSpell.ignoreRegExpList

Description

List of regular expressions or Pattern names (defined in cSpell.patterns) to exclude from spell checking.

• When using the VS Code Preferences UI, it is not necessary to escape the \, VS Code takes care of that.
• When editing the VS Code settings.json file, it is necessary to escape \. Each \ becomes \\.

The default regular expression flags are gi. Add u (gui), to enable Unicode.

VS Code UI	settings.json	Description
/\\[a-z]+/gi	/\\\\[a-z]+/gi	Exclude LaTeX command like \mapsto
/\b[A-Z]{3,5}\b/g	/\\b[A-Z]{3,5}\\b/g	Exclude full-caps acronyms of 3-5 length.
CStyleComment	CStyleComment	A built in pattern

Type

string[]

Scope

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

Default

- none -

---

cSpell.includeRegExpList

Name

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

Type

string[]

Scope

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

Default

- none -

---

cSpell.minRandomLength

Name

cSpell.minRandomLength

Description

The minimum length of a random string to be ignored.

Type

number

Scope

- none -

Default

40

---

cSpell.overrides

Name

cSpell.overrides

Description

Overrides are used to apply settings for specific files in your project.

Example:

"cSpell.overrides": [
  // Force `*.hrr` and `*.crr` files to be treated as `cpp` files:
  {
    "filename": "**/{*.hrr,*.crr}",
    "languageId": "cpp"
  },
  // Force `dutch/**/*.txt` to be treated as Dutch (dictionary needs to be installed separately):
  {
    "filename": "**/dutch/**/*.txt",
    "language": "nl"
  }
]

Type

object[]

Scope

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

Default

- none -

---

cSpell.patterns

Name

cSpell.patterns

Description

Defines a list of patterns that can be used with the cSpell.ignoreRegExpList and cSpell.includeRegExpList options.

Example:

"cSpell.patterns": [
  {
    "name": "comment-single-line",
    "pattern": "/#.*/g"
  },
  {
    "name": "comment-multi-line",
    "pattern": "/(?:\\/\\*[\\s\\S]*?\\*\\/)/g"
  }
]

Type

object[]

Scope

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

Default

- none -

---

cSpell.unknownWords

Name

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

( "report-all" | "report-simple" | "report-common-typos" | "report-flagged" )

Scope

- none -

Default

"report-all"

Since Version

9.1.0

---