Menus and Actions

Settings that control the menu items and actions available in the spell checker.

Setting	Scope	Description
`cSpell.allowWordsToBeAddTo`	resource	Specify where words can be added to. This setting is used to control the "Add to Dictionary"…
`cSpell.hideAddToDictionaryCodeActions`	resource	Hide the options to add words to dictionaries or settings.
`cSpell.menuItemsOnCSpellConfigMenu`	resource	Control which menu items are shown on the Spelling Config Menu.
`cSpell.menuItemsOnEditorContextMenu`	resource	Control which menu items are shown on the Editor Context Menu.
`cSpell.menuItemsOnSpellCheckerActionMenu`	resource	Control which menu items are shown on the Spell Checker Action Menu.
`cSpell.menuItemsOnSpellingContextMenu`	resource	Control which menu items are shown on the Spelling Context Menu.
`cSpell.showCommandsInEditorContextMenu`	resource	Show Spell Checker actions in Editor Context Menu
`cSpell.showSuggestionsLinkInEditorContextMenu`	resource	Show Spelling Suggestions link in the top level context menu.
`cSpell.suggestionMenuType`	resource	The type of menu used to display spelling suggestions.

Settings

`cSpell.allowWordsToBeAddTo`

Name

cSpell.allowWordsToBeAddTo

Description

Specify where words can be added to. This setting is used to control the "Add to Dictionary" code actions.

Examples

To disable adding words to user settings, but allow adding words to workspace settings:

"cSpell.addWordTo": {
  "user": false // Do not allow adding words to user settings
}

To disable adding words to all VSCode settings:

"cSpell.addWordTo": {
  "user": false       // Do not allow adding words to user settings
  "workspace": false, // Do not allow adding words to workspace settings
  "folder": false     // Do not allow adding words to folder settings
}

Type

ActionAddToTargets

Scope

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

Default

default
{
  "cspell": true,
  "dictionaries": true,
  "folder": true,
  "user": true,
  "workspace": true
}

Since Extension Version

4.9.1

`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.menuItemsOnCSpellConfigMenu`

Name

cSpell.menuItemsOnCSpellConfigMenu

Description

Control which menu items are shown on the Spelling Config Menu.

Type

EnabledItemsOnCSpellConfigMenu

Scope

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

Default

default
{
  "createCSpellConfig": true,
  "createCustomDictionary": true
}

Since Extension Version

4.9.1

`cSpell.menuItemsOnEditorContextMenu`

Name

cSpell.menuItemsOnEditorContextMenu

Description

Control which menu items are shown on the Editor Context Menu.

Type

EnabledItemsOnEditorContextMenu

Scope

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

Default

default
{
  "hideIssues": true,
  "showIssues": true,
  "spellingContextMenu": true,
  "suggestSpellingCorrections": true
}

Since Extension Version

4.9.1

`cSpell.menuItemsOnSpellCheckerActionMenu`

Name

cSpell.menuItemsOnSpellCheckerActionMenu

Description

Control which menu items are shown on the Spell Checker Action Menu.

Type

EnabledItemsOnActionMenu

Scope

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

Default

default
{
  "allowDocumentScheme": true, "createCSpellConfig": true,
  "disableFileType": true, "editKeyboardShortcuts": true,
  "editSpellCheckerSettings": true, "enableFileType": true,
  "excludeDocumentScheme": true, "hideIssues": true, "openConfigFiles": true,
  "openFileInfoView": true, "openIssuesPanel": true,
  "openSpellCheckerConsole": true, "showIssues": true
}

Since Extension Version

4.9.1

`cSpell.menuItemsOnSpellingContextMenu`

Name

cSpell.menuItemsOnSpellingContextMenu

Description

Control which menu items are shown on the Spelling Context Menu.

Type

EnabledItemsOnSpellingContextMenu

Scope

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

Default

default
{
  "addIgnoreWord": true, "addIssuesToDictionary": true,
  "addWordToCSpellConfig": true, "addWordToDictionary": true,
  "addWordToFolderDictionary": true, "addWordToFolderSettings": true,
  "addWordToUserDictionary": true, "addWordToUserSettings": true,
  "addWordToWorkspaceDictionary": true, "addWordToWorkspaceSettings": true,
  "suggestSpellingCorrections": true
}

Since Extension Version

4.9.1

`cSpell.showCommandsInEditorContextMenu`

Name: cSpell.showCommandsInEditorContextMenu
Description: Show Spell Checker actions in Editor Context Menu
Type: boolean
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: true

`cSpell.showSuggestionsLinkInEditorContextMenu`

Name: cSpell.showSuggestionsLinkInEditorContextMenu
Description: Show Spelling Suggestions link in the top level context menu.
Type: boolean
Scope: resource - Resource settings, which apply to files and folders, and can be configured in all settings levels, even folder settings.
Default: true

`cSpell.suggestionMenuType`

Name

cSpell.suggestionMenuType

Description

The type of menu used to display spelling suggestions.

Type

Any of:

"quickPick"
"quickFix"

( "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"

Type Definitions

`ActionAddToTargets`

Name

ActionAddToTargets

Description

Specify where words can be added to. This setting is used to control the "Add to Dictionary" code actions.

Examples

To disable adding words to user settings, but allow adding words to workspace settings:

"cSpell.addWordTo": {
  "user": false // Do not allow adding words to user settings
}

To disable adding words to all VSCode settings:

"cSpell.addWordTo": {
  "user": false       // Do not allow adding words to user settings
  "workspace": false, // Do not allow adding words to workspace settings
  "folder": false     // Do not allow adding words to folder settings
}

Type

Fields
Name `cspell` Description Allow adding words cspell configuration file settings. `true` - allow add to cspell settings `false` - never enable add to cspell settings Type `boolean` Default `true`
Name `dictionaries` Description Allow adding words user defined dictionaries settings. `true` - allow add to cspell settings `false` - never enable add to cspell settings Type `boolean` Default `true`
Name `folder` Description Allow adding words to folder settings. `true` - allow add to folder settings `false` - never enable add to folder settings Type `boolean` Default `true`
Name `user` Description Allow adding words to user settings. `true` - allow add to user settings `false` - never enable add to user settings Type `boolean` Default `true`
Name `workspace` Description Allow adding words to workspace settings. `true` - allow add to workspace settings `false` - never enable add to workspace settings Type `boolean` Default `true`

TypeScript:

{
  cspell?: boolean;
  dictionaries?: boolean;
  folder?: boolean;
  user?: boolean;
  workspace?: boolean;
}

Since Extension Version

4.9.1

`EnabledItemsOnCSpellConfigMenu`

Name

EnabledItemsOnCSpellConfigMenu

Description

Control which menu items are shown on the Spelling Config Menu.

Type

Fields
Name `createCSpellConfig` Description Enable Menu Item: Create a CSpell Configuration File Type `boolean`
Name `createCustomDictionary` Description Enable Menu Item: Create a Custom Dictionary File Type `boolean`

{
  createCSpellConfig?: boolean;
  createCustomDictionary?: boolean;
}

Since Extension Version

4.9.1

`EnabledItemsOnEditorContextMenu`

Name

EnabledItemsOnEditorContextMenu

Description

Control which menu items are shown on the Editor Context Menu.

Type

Fields
Name `hideIssues` Description Enable Menu Item: `Hide Spelling Issues` Type `boolean`
Name `showIssues` Description Enable Menu Item: `Show Spelling Issues` Type `boolean`
Name `spellingContextMenu` Description Enable Menu Item: `Spelling` Type `boolean`
Name `suggestSpellingCorrections` Description Enable Menu Item: `Spelling Suggestions...` Type `boolean`

{
  hideIssues?: boolean;
  showIssues?: boolean;
  spellingContextMenu?: boolean;
  suggestSpellingCorrections?: boolean;
}

Since Extension Version

4.9.1

`EnabledItemsOnActionMenu`

Name

EnabledItemsOnActionMenu

Description

Control which menu items are shown on the Spell Checker Action Menu.

Type

TypeScript:

{
  allowDocumentScheme?: boolean;
  createCSpellConfig?: boolean;
  disableFileType?: boolean;
  editKeyboardShortcuts?: boolean;
  editSpellCheckerSettings?: boolean;
  enableFileType?: boolean;
  excludeDocumentScheme?: boolean;
  hideIssues?: boolean;
  openConfigFiles?: boolean;
  openFileInfoView?: boolean;
  openIssuesPanel?: boolean;
  openSpellCheckerConsole?: boolean;
  showIssues?: boolean;
}

Since Extension Version

4.9.1

`EnabledItemsOnSpellingContextMenu`

Name

EnabledItemsOnSpellingContextMenu

Description

Control which menu items are shown on the Spelling Context Menu.

Type

Fields
Name `addIgnoreWord` Description Enable Menu Item: Ignore Word Type `boolean`
Name `addIssuesToDictionary` Description Enable Menu Item: Add All Spelling Issues to Dictionary Type `boolean`
Name `addWordToCSpellConfig` Description Enable Menu Item: Add Word to CSpell Configuration Type `boolean`
Name `addWordToDictionary` Description Enable Menu Item: Add Word to Dictionary Type `boolean`
Name `addWordToFolderDictionary` Description Enable Menu Item: Add Word to Folder Dictionary Type `boolean`
Name `addWordToFolderSettings` Description Enable Menu Item: Add Word to Folder Settings Type `boolean`
Name `addWordToUserDictionary` Description Enable Menu Item: Add Word to User Dictionary Type `boolean`
Name `addWordToUserSettings` Description Enable Menu Item: Add Word to User Settings Type `boolean`
Name `addWordToWorkspaceDictionary` Description Enable Menu Item: Add Word to Workspace Dictionary Type `boolean`
Name `addWordToWorkspaceSettings` Description Enable Menu Item: Add Word to Workspace Settings Type `boolean`
Name `suggestSpellingCorrections` Description Enable Menu Item: Spelling Suggestions... Type `boolean`

TypeScript:

{
  addIgnoreWord?: boolean;
  addIssuesToDictionary?: boolean;
  addWordToCSpellConfig?: boolean;
  addWordToDictionary?: boolean;
  addWordToFolderDictionary?: boolean;
  addWordToFolderSettings?: boolean;
  addWordToUserDictionary?: boolean;
  addWordToUserSettings?: boolean;
  addWordToWorkspaceDictionary?: boolean;
  addWordToWorkspaceSettings?: boolean;
  suggestSpellingCorrections?: boolean;
}

Since Extension Version

4.9.1

Settings​

cSpell.allowWordsToBeAddTo​

cSpell.hideAddToDictionaryCodeActions​

cSpell.menuItemsOnCSpellConfigMenu​

cSpell.menuItemsOnEditorContextMenu​

cSpell.menuItemsOnSpellCheckerActionMenu​

cSpell.menuItemsOnSpellingContextMenu​

cSpell.showCommandsInEditorContextMenu​

cSpell.showSuggestionsLinkInEditorContextMenu​

cSpell.suggestionMenuType​

Type Definitions​

ActionAddToTargets​

EnabledItemsOnCSpellConfigMenu​

EnabledItemsOnEditorContextMenu​

EnabledItemsOnActionMenu​

EnabledItemsOnSpellingContextMenu​

Settings

`cSpell.allowWordsToBeAddTo`

`cSpell.hideAddToDictionaryCodeActions`

`cSpell.menuItemsOnCSpellConfigMenu`

`cSpell.menuItemsOnEditorContextMenu`

`cSpell.menuItemsOnSpellCheckerActionMenu`

`cSpell.menuItemsOnSpellingContextMenu`

`cSpell.showCommandsInEditorContextMenu`

`cSpell.showSuggestionsLinkInEditorContextMenu`

`cSpell.suggestionMenuType`

Type Definitions

`ActionAddToTargets`

`EnabledItemsOnCSpellConfigMenu`

`EnabledItemsOnEditorContextMenu`

`EnabledItemsOnActionMenu`

`EnabledItemsOnSpellingContextMenu`