Reporting and Display

Settings that control how the spell checker reports and displays errors.

Setting	Scope	Description
`cSpell.autoFormatConfigFile`	window	Auto Format Configuration File
`cSpell.diagnosticLevel`	resource	Set Diagnostic Reporting Level
`cSpell.diagnosticLevelFlaggedWords`	resource	Set Diagnostic Reporting Level for Flagged Words
`cSpell.hideAddToDictionaryCodeActions`	resource	Hide the options to add words to dictionaries or settings.
`cSpell.hideIssuesWhileTyping`	application	Hide Issues While Typing
`cSpell.maxDuplicateProblems`	resource	The maximum number of times the same word can be flagged as an error in a file.
`cSpell.maxNumberOfProblems`	resource	Controls the maximum number of spelling errors per document.
`cSpell.minWordLength`	resource	The minimum length of a word before checking it against a dictionary.
`cSpell.numSuggestions`	resource	Controls the number of suggestions shown.
`cSpell.revealIssuesAfterDelayMS`	application	Reveal Issues After a Delay in Milliseconds
`cSpell.showAutocompleteDirectiveSuggestions`	language-overridable	Show CSpell in-document directives as you type.
`cSpell.showCommandsInEditorContextMenu`	application	Show Spell Checker actions in Editor Context Menu
`cSpell.showSuggestionsLinkInEditorContextMenu`	application	Show Spelling Suggestions link in the top level context menu.
`cSpell.suggestionMenuType`	resource	The type of menu used to display spelling suggestions.
`cSpell.suggestionNumChanges`	resource	The maximum number of changes allowed on a word to be considered a suggestions.
`cSpell.validateDirectives`	window	Verify that the in-document directives are correct.

Settings

`cSpell.autoFormatConfigFile`

Name: cSpell.autoFormatConfigFile -- Auto Format Configuration File
Description: If a cspell configuration file is updated, format the configuration file using the VS Code Format Document Provider. This will cause the configuration file to be saved prior to being updated.
Type: boolean
Scope: window - Windows (instance) specific settings which can be configured in user, workspace, or remote settings.
Default: false

`cSpell.diagnosticLevel`

Name

cSpell.diagnosticLevel -- Set Diagnostic Reporting Level

Description

The Diagnostic Severity Level determines how issues are shown in the Problems Pane and within the document. Set the level to Hint to hide the issues from the Problems Pane.

Note: cSpell.useCustomDecorations must be false to use VS Code Diagnostic Severity Levels.

See: VS Code Diagnostic Severity Level

Type

( "Error" | "Warning" | "Information" | "Hint" )

Value	Description
`Error`	Report Spelling Issues as Errors
`Warning`	Report Spelling Issues as Warnings
`Information`	Report Spelling Issues as Information
`Hint`	Report Spelling Issues as Hints, will not show up in Problems

Scope

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

Default

"Information"

`cSpell.diagnosticLevelFlaggedWords`

Name

cSpell.diagnosticLevelFlaggedWords -- Set Diagnostic Reporting Level for Flagged Words

Description

Flagged word issues found by the spell checker are marked with a Diagnostic Severity Level. This affects the color of the squiggle. By default, flagged words will use the same diagnostic level as general issues. Use this setting to customize them.

See: VS Code Diagnostic Severity Level

Type

( "Error" | "Warning" | "Information" | "Hint" )

Value	Description
`Error`	Report Spelling Issues as Errors
`Warning`	Report Spelling Issues as Warnings
`Information`	Report Spelling Issues as Information
`Hint`	Report Spelling Issues as Hints, will not show up in Problems

Scope

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

Default

- none -

Since Version

4.0.0

`cSpell.hideAddToDictionaryCodeActions`

Name: cSpell.hideAddToDictionaryCodeActions
Description: Hide the options to add words to dictionaries or settings.
Type: boolean
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: false

`cSpell.hideIssuesWhileTyping`

Name

cSpell.hideIssuesWhileTyping -- Hide Issues While Typing

Description

Control how spelling issues are displayed while typing. See: cSpell.revealIssuesAfterMS to control when issues are revealed.

Type

( "Off" | "Word" | "Line" | "Document" )

Value	Description
`Off`	Show issues while typing
`Word`	Hide issues while typing in the current word
`Line`	Hide issues while typing on the line
`Document`	Hide all issues while typing in the document

Scope

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

Default

"Word"

Since Version

4.0.0

`cSpell.maxDuplicateProblems`

Name: cSpell.maxDuplicateProblems
Description: The maximum number of times the same word can be flagged as an error in a file.
Type: number
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: 20

`cSpell.maxNumberOfProblems`

Name: cSpell.maxNumberOfProblems
Description: Controls the maximum number of spelling errors per document.
Type: number
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: 100

`cSpell.minWordLength`

Name: cSpell.minWordLength
Description: The minimum length of a word before checking it against a dictionary.
Type: number
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: 4

`cSpell.numSuggestions`

Name: cSpell.numSuggestions
Description: Controls the number of suggestions shown.
Type: number
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: 8

`cSpell.revealIssuesAfterDelayMS`

Name: cSpell.revealIssuesAfterDelayMS -- Reveal Issues After a Delay in Milliseconds
Description: Reveal hidden issues related to cSpell.hideIssuesWhileTyping after a delay in milliseconds.
Type: number
Scope: application - Settings that apply to all instances of VS Code and can only be configured in user settings.
Default: 1500
Since Version: 4.0.0

`cSpell.showAutocompleteDirectiveSuggestions`

Name

cSpell.showAutocompleteDirectiveSuggestions

Description

Show CSpell in-document directives as you type.

Note: VS Code must be restarted for this setting to take effect.

Type

boolean

Scope

language-overridable - Resource settings that can be overridable at a language level.

Default

true

`cSpell.showCommandsInEditorContextMenu`

Name: cSpell.showCommandsInEditorContextMenu
Description: Show Spell Checker actions in Editor Context Menu
Type: boolean
Scope: application - Settings that apply to all instances of VS Code and can only be configured in user settings.
Default: true

`cSpell.showSuggestionsLinkInEditorContextMenu`

Name: cSpell.showSuggestionsLinkInEditorContextMenu
Description: Show Spelling Suggestions link in the top level context menu.
Type: boolean
Scope: application - Settings that apply to all instances of VS Code and can only be configured in user settings.
Default: true

`cSpell.suggestionMenuType`

Name

cSpell.suggestionMenuType

Description

The type of menu used to display spelling suggestions.

Type

( "quickPick" | "quickFix" )

Value	Description
`quickPick`	Suggestions will appear as a drop down at the top of the IDE. (Best choice for Vim Key Bindings)
`quickFix`	Suggestions will appear inline near the word, inside the text editor.

Scope

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

Default

"quickPick"

`cSpell.suggestionNumChanges`

Name

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

Scope

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

Default

3

`cSpell.validateDirectives`

Name: cSpell.validateDirectives
Description: Verify that the in-document directives are correct.
Type: boolean
Scope: window - Windows (instance) specific settings which can be configured in user, workspace, or remote settings.
Default: - none -

Settings​

cSpell.autoFormatConfigFile​

cSpell.diagnosticLevel​

cSpell.diagnosticLevelFlaggedWords​

cSpell.hideAddToDictionaryCodeActions​

cSpell.hideIssuesWhileTyping​

cSpell.maxDuplicateProblems​

cSpell.maxNumberOfProblems​

cSpell.minWordLength​

cSpell.numSuggestions​

cSpell.revealIssuesAfterDelayMS​

cSpell.showAutocompleteDirectiveSuggestions​

cSpell.showCommandsInEditorContextMenu​

cSpell.showSuggestionsLinkInEditorContextMenu​

cSpell.suggestionMenuType​

cSpell.suggestionNumChanges​

cSpell.validateDirectives​

Settings

`cSpell.autoFormatConfigFile`

`cSpell.diagnosticLevel`

`cSpell.diagnosticLevelFlaggedWords`

`cSpell.hideAddToDictionaryCodeActions`

`cSpell.hideIssuesWhileTyping`

`cSpell.maxDuplicateProblems`

`cSpell.maxNumberOfProblems`

`cSpell.minWordLength`

`cSpell.numSuggestions`

`cSpell.revealIssuesAfterDelayMS`

`cSpell.showAutocompleteDirectiveSuggestions`

`cSpell.showCommandsInEditorContextMenu`

`cSpell.showSuggestionsLinkInEditorContextMenu`

`cSpell.suggestionMenuType`

`cSpell.suggestionNumChanges`

`cSpell.validateDirectives`