Appearance

Settings that control the appearance of the spell checker.

Setting	Scope	Description
cSpell.dark	application	Decoration for dark themes.
cSpell.doNotUseCustomDecorationForScheme	application	Use VS Code to Render Spelling Issues
cSpell.light	application	Decoration for light themes.
cSpell.overviewRulerColor	application	The CSS color used to show issues in the ruler.
cSpell.showInRuler	application	Show spelling issues in the editor ruler.
cSpell.textDecoration	application	The CSS Style used to decorate spelling issues. Depends upon cSpell.useCustomDecorations.
cSpell.textDecorationColor	application	The decoration color for normal spelling issues.
cSpell.textDecorationColorFlagged	application	The decoration color for flagged issues.
cSpell.textDecorationColorSuggestion	application	The decoration color for spelling suggestions.
cSpell.textDecorationLine	application	The CSS line type used to decorate issues.
cSpell.textDecorationStyle	application	The CSS line style used to decorate issues.
cSpell.textDecorationThickness	application	The CSS line thickness used to decorate issues.
cSpell.useCustomDecorations	application	Draw custom decorations on Spelling Issues.

Settings

cSpell.dark

Name

cSpell.dark

Description

Decoration for dark themes.

See:

• cSpell.overviewRulerColor
• cSpell.textDecoration

Type

object

Scope

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

Default

- none -

Since Version

4.0.0

---

cSpell.doNotUseCustomDecorationForScheme

Name

cSpell.doNotUseCustomDecorationForScheme -- Use VS Code to Render Spelling Issues

Description

Use the VS Code Diagnostic Collection to render spelling issues.

With some edit boxes, like the source control message box, the custom decorations do not show up. This setting allows the use of the VS Code Diagnostic Collection to render spelling issues.

Type

object

Scope

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

Default

{"vscode-scm":true}

Since Version

4.0.0

---

cSpell.light

Name

cSpell.light

Description

Decoration for light themes.

See:

• cSpell.overviewRulerColor
• cSpell.textDecoration

Type

object

Scope

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

Default

- none -

Since Version

4.0.0

---

cSpell.overviewRulerColor

Name

cSpell.overviewRulerColor

Description

The CSS color used to show issues in the ruler.

Depends upon cSpell.useCustomDecorations. Disable the ruler by setting cSpell.showInRuler to false.

See:

• <color> CSS: Cascading Style Sheets, MDN
• CSS Colors, W3C Schools
• Hex colors

Examples:

• green
• DarkYellow
• #ffff0080 - semi-transparent yellow.
• rgb(255 153 0 / 80%)

Type

string

Scope

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

Default

"#348feb80"

Since Version

4.0.0

---

cSpell.showInRuler

Name

cSpell.showInRuler

Description

Show spelling issues in the editor ruler.

Note: This setting is only used when cSpell.useCustomDecorations is true.

Note: To set the color of the ruler, use cSpell.overviewRulerColor.

Type

boolean

Scope

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

Default

true

Since Version

4.0.35

---

cSpell.textDecoration

Name

cSpell.textDecoration

Description

The CSS Style used to decorate spelling issues. Depends upon cSpell.useCustomDecorations.

This setting is used to manually configure the text decoration. If it is not set, the following settings are used:

• cSpell.textDecorationLine to pick the line type
• cSpell.textDecorationStyle to pick the style
• cSpell.textDecorationColor to set the color
• cSpell.textDecorationThickness to set the thickness.

See: text-decoration - CSS: Cascading Style Sheets, MDN

Format: <line> [style] <color> [thickness]

• line - underline, overline, see: text-decoration-line, MDN
• style - solid, wavy, dotted, see: text-decoration-style, MDN
• color - see: text-decoration-color, MDN
• thickness - see: text-decoration-thickness, MDN

Examples:

• underline green
• underline dotted yellow 0.2rem
• underline wavy #ff0c 1.5px - Wavy underline with 1.5px thickness in semi-transparent yellow.

To change the ruler color, use cSpell.overviewRulerColor.

Type

string

Scope

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

Default

- none -

Since Version

4.0.0

---

cSpell.textDecorationColor

Name

cSpell.textDecorationColor

Description

The decoration color for normal spelling issues.

See: text-decoration - CSS: Cascading Style Sheets, MDN

• color - see: text-decoration-color, MDN

To change the ruler color, use cSpell.overviewRulerColor.

Examples:

• green
• yellow
• #ff0c

Type

string

Scope

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

Default

"#348feb"

Since Version

4.0.0

---

cSpell.textDecorationColorFlagged

Name

cSpell.textDecorationColorFlagged

Description

The decoration color for flagged issues.

See: text-decoration - CSS: Cascading Style Sheets, MDN

• color - see: text-decoration-color, MDN

Examples:

• green
• yellow
• #ff0c

Type

string

Scope

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

Default

"#f44"

Since Version

4.0.0

---

cSpell.textDecorationColorSuggestion

Name

cSpell.textDecorationColorSuggestion

Description

The decoration color for spelling suggestions.

See: text-decoration - CSS: Cascading Style Sheets, MDN

• color - see: text-decoration-color, MDN

Common Format: #RGBA or #RRGGBBAA or #RGB or #RRGGBB

Examples:

• green
• yellow
• #ff0c

Type

string

Scope

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

Default

"#cf88"

Since Version

4.0.2

---

cSpell.textDecorationLine

Name

cSpell.textDecorationLine

Description

The CSS line type used to decorate issues.

See: text-decoration - CSS: Cascading Style Sheets, MDN

• line - underline, overline, see: text-decoration-line, MDN

Type

( "underline" | "overline" | "line-through" )

Scope

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

Default

"underline"

Since Version

4.0.0

---

cSpell.textDecorationStyle

Name

cSpell.textDecorationStyle

Description

The CSS line style used to decorate issues.

See: text-decoration - CSS: Cascading Style Sheets, MDN

• style - solid, wavy, dotted, see: text-decoration-style, MDN

Type

( "solid" | "wavy" | "dotted" | "dashed" | "double" )

Scope

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

Default

"dashed"

Since Version

4.0.0

---

cSpell.textDecorationThickness

Name

cSpell.textDecorationThickness

Description

The CSS line thickness used to decorate issues.

See: text-decoration - CSS: Cascading Style Sheets, MDN

• thickness - see: text-decoration-thickness, MDN

Examples:

• auto
• from-font
• 0.2rem
• 1.5px
• 10%

Type

string

Scope

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

Default

"auto"

Since Version

4.0.0

---

cSpell.useCustomDecorations

Name

cSpell.useCustomDecorations

Description

Draw custom decorations on Spelling Issues.

• true - Use custom decorations. - VS Code Diagnostic Severity Levels are not used.
• false - Use the VS Code Diagnostic Collection to render spelling issues.

Note: This setting overrides the VS Code Diagnostics setting: cSpell.diagnosticLevel.

Type

boolean

Scope

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

Default

false

Since Version

4.0.0

---