v1.9.0-alpha.0
Pre-release
Pre-release
Bug Fixes
Features
Defining the workspace root path
workspaceRootPath
- By default, the workspace root path matches the first folder listed in the
workspace. If acspell.json
exists at the workspace root, it will be used and merged with any folder level
cspell.json
files found.
Note: the reason behind this change was to make the behaviour in multi-root workspace more predictable.
Example
"cSpell.workspaceRootPath": "${workspaceFolder:client}/.."
Custom Dictionaries
It is now possible to tell the extension to use custom dictionaries. Three new configuration settings have been added.
customUserDictionaries
- for defining custom user level dictionariescustomWorkspaceDictionaries
- for defining custom workspace level dictionariescustomFolderDictionaries
- for defining custom folder level dictionaries
User Example
"cSpell.customUserDictionaries": [
{
"name": "my words", // name of dictionary (should be unique)
"description": "These are the words I use in all projects.",
"path": "~/custom-words.txt",
"addWords": true // Add Word to User Dictionary will add words to this file.
},
{
"name": "company terms",
"description": "These are terms used by my company.",
"path": "~/gist/company-terms/company-terms.txt",
"addWords": false // Do not add to the company terms.
}
]
Workspace Example:
"cSpell.customWorkspaceDictionaries": [
{
"name": "project words", // name of dictionary (should be unique)
"description": "These are words for this project.",
// Relative to the "client" folder in the workspace.
"path": "${workspaceFolder:client}/project-words.txt",
"addWords": true // Add Word to Workspace Dictionary will add words to this file.
}
]
Folder Example:
"cSpell.customFolderDictionaries": [
{
"name": "folder words", // name of dictionary (should be unique)
"description": "These are words for this project.",
// Relative to the current folder in the workspace.
"path": "${workspaceFolder}/folder-words.txt",
"addWords": false // Do NOT add to folder words.
},
{
"name": "project words", // name of dictionary (should be unique)
"description": "These are words for this project.",
// Relative to the "client" folder in the workspace.
"path": "${workspaceFolder:client}/project-words.txt",
"addWords": true // Add Word to Workspace Dictionary when adding folder words.
}
]
Custom Dictionary Paths
Dictionary paths can be absolute or relative based upon the following patterns:
~
- relative to the user home directory.
- relative to theworkspaceRootPath
${workspaceFolder}
- relative to current workspace folder${workspaceFolder:[folder name]}
-[folder name]
is one of the folders in the workspace.
Adding words to Dictionaries
Editor Context Menu (right-click)
The menu options in the Context Menu change based upon the workspace configuration.
They are made visible by the setting: cSpell.showCommandsInEditorContextMenu
Add Word to Folder Dictionary
-- shows only if a workspace with more than one folder is openAdd Word to Workspace Dictionary
-- shows if a folder or workspace is openAdd Word to User Dictionary
-- always shows, add the word to the User's dictionary
Commands
These can be bound to keyboard shortcuts.
Enable Spell Checking by Default
- enables the spell checker if it has been disabled.- Command:
cSpell.enableForGlobal
- Command:
Disable Spell Checker by Default
- disables the spell checker.- Command:
cSpell.disableForGlobal
- Command: