A simple source code spell checker for code
OTHER License
Bot releases are hidden (Show)
Published by Jason3S over 4 years ago
workspaceRootPath
- By default, the workspace root path matches the first folder listed in thecspell.json
exists at the workspace root, it will be used and merged with any folder levelcspell.json
files found.Note: the reason behind this change was to make the behaviour in multi-root workspace more predictable.
"cSpell.workspaceRootPath": "${workspaceFolder:client}/.."
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"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.
}
]
"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.
}
]
"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.
}
]
Dictionary paths can be absolute or relative based upon the following patterns:
~
- relative to the user home directory.
- relative to the workspaceRootPath
${workspaceFolder}
- relative to current workspace folder${workspaceFolder:[folder name]}
- [folder name]
is one of the folders in the workspace.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 dictionaryThese can be bound to keyboard shortcuts.
Enable Spell Checking by Default
- enables the spell checker if it has been disabled.
cSpell.enableForGlobal
Disable Spell Checker by Default
- disables the spell checker.
cSpell.disableForGlobal
Published by Jason3S over 4 years ago
workspaceRootPath
- By default, the workspace root path matches the first folder listed in thecspell.json
exists at the workspace root, it will be used and merged with any folder levelcspell.json
files found.Note: the reason behind this change was to make the behaviour in multi-root workspace more predictable.
"cSpell.workspaceRootPath": "${workspaceFolder:client}/.."
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"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.
}
]
"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.
}
]
"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.
}
]
Dictionary paths can be absolute or relative based upon the following patterns:
~
- relative to the user home directory.
- relative to the workspaceRootPath
${workspaceFolder}
- relative to current workspace folder${workspaceFolder:[folder name]}
- [folder name]
is one of the folders in the workspace.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 dictionaryThese can be bound to keyboard shortcuts.
Enable Spell Checking by Default
- enables the spell checker if it has been disabled.
cSpell.enableForGlobal
Disable Spell Checker by Default
- disables the spell checker.
cSpell.disableForGlobal
Published by Jason3S over 4 years ago
Performance enhancements and a few features.
enableFiletypes
Fixes #408 :
A new setting enableFiletypes
will add the listed filetypes to enableLanguageIds
.
Example:
"cSpell.enableFiletypes": [
"jupyter", "kotlin", "kotlinscript", "!json"
]
will enable Jupyter, Kotlin, KotlinScript and disable JSON files.
${workspaceFolder}
substitution in paths and globsRelative paths were difficult to get working when specified in VS Code settings. It wasn't clear what they should be relative to. Relative paths to a cspell.json
files are clear.
It is now possible to have the following setting in VS Code preferences.
"cSpell.import": [
"${workspaceFolder}/node_modules/company_standards/cspell.json"
]
for a multiroot with folders client
, server
, common
, it is possible to specify the name of the folder:
"ignorePaths": [
"${workspaceFolder:client}/**/*.json"
],
"cSpell.import": [
"${workspaceFolder:server}/node_modules/company_standards/cspell.json"
],
"cSpell.dictionaryDefinitions": [
{
"name": "Company Terms",
"path": "${workspaceFolder:common}/dictionaries/terms.txt"
}
],
"cSpell.dictionaries": ["Company Terms"]
Fixes #384
Published by Jason3S over 4 years ago
Published by Jason-Rev over 8 years ago
Published by Jason-Rev over 8 years ago
Published by Jason-Rev over 8 years ago
Version pushed to the extension marketplace.
Published by Jason-Rev over 8 years ago
The main feature of this release is the ability to quickly and easily add words to workspace dictionary.