Release v1.9.0-alpha.5

1.9.0-alpha.5 (2020-05-17)

Bug Fixes

Features

• Custom Dictionaries (#482) (075ec87)

Defining the workspace root path

• workspaceRootPath - By default, the workspace root path matches the first folder listed in the
  workspace. If a cspell.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 dictionaries
• customWorkspaceDictionaries - for defining custom workspace level dictionaries
• customFolderDictionaries - for defining custom folder level dictionaries

Custom dictionaries can be either a dictionary reference (name of a defined dictionary) or a dictionary definition.

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.
  }
]

Example with a dictionary reference

cspell.json

"dictionaryDefinitions": [
    {
        "name": "cities",
        "path": "./sampleDictionaries/cities.txt"
    },
    {
        "name": "project-terms",
        "path": "./words.txt"
    }
]

VS Code settings.json

"cSpell.customWorkspaceDictionaries": ["project-terms"]

Custom Dictionary Paths

Dictionary paths can be absolute or relative based upon the following patterns:

• ~ - relative to the user home directory
• . - relative to current workspace folder
• ${workspaceRoot} or ${root} - relative to the workspaceRootPath
• ${workspaceFolder} - relative to the first folder in the workspace
• ${workspaceFolder:[folder name]} - [folder name] is one of the folders in the workspace. i.e ${workspaceFolder:client}

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

1. Add Word to Folder Dictionary -- shows only if a workspace with more than one folder is open
2. Add Word to Workspace Dictionary -- shows if a folder or workspace is open
3. Add Word to User Dictionary -- always shows, add the word to the User's dictionary

Commands

These can be bound to keyboard shortcuts.

1. Enable Spell Checking by Default - enables the spell checker if it has been disabled.
   • Command: cSpell.enableForGlobal
2. Disable Spell Checker by Default - disables the spell checker.
   • Command: cSpell.disableForGlobal

Release v1.9.0-alpha.4

v1.9.0-alpha.4

Release v1.9.0-alpha.3

v1.9.0-alpha.3

v1.9.0-alpha.1

Bug Fixes

• Make sure to listen for all settings changes. (#484) (ffd9a97)

Features

• Custom Dictionaries (#482) (075ec87)

Defining the workspace root path

• workspaceRootPath - By default, the workspace root path matches the first folder listed in the
  workspace. If a cspell.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 dictionaries
• customWorkspaceDictionaries - for defining custom workspace level dictionaries
• customFolderDictionaries - 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 the workspaceRootPath
• ${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

1. Add Word to Folder Dictionary -- shows only if a workspace with more than one folder is open
2. Add Word to Workspace Dictionary -- shows if a folder or workspace is open
3. Add Word to User Dictionary -- always shows, add the word to the User's dictionary

Commands

These can be bound to keyboard shortcuts.

1. Enable Spell Checking by Default - enables the spell checker if it has been disabled.
   • Command: cSpell.enableForGlobal
2. Disable Spell Checker by Default - disables the spell checker.
   • Command: cSpell.disableForGlobal

v1.9.0-alpha.0

Bug Fixes

• Make sure to listen for all settings changes. (#484) (ffd9a97)

Features

• Custom Dictionaries (#482) (075ec87)

Defining the workspace root path

• workspaceRootPath - By default, the workspace root path matches the first folder listed in the
  workspace. If a cspell.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 dictionaries
• customWorkspaceDictionaries - for defining custom workspace level dictionaries
• customFolderDictionaries - 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 the workspaceRootPath
• ${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

1. Add Word to Folder Dictionary -- shows only if a workspace with more than one folder is open
2. Add Word to Workspace Dictionary -- shows if a folder or workspace is open
3. Add Word to User Dictionary -- always shows, add the word to the User's dictionary

Commands

These can be bound to keyboard shortcuts.

1. Enable Spell Checking by Default - enables the spell checker if it has been disabled.
   • Command: cSpell.enableForGlobal
2. Disable Spell Checker by Default - disables the spell checker.
   • Command: cSpell.disableForGlobal

v1.8.0 Release

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 globs

Relative 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"]

Bugs

Fixes #384

VS Code Marketplace Release

v1.7.24

v1.7.24

Add Contraction Support

0.10.6

Update version # for release.

Bug fixes

0.10.2

Update readme.md

Add to Dictionary

Summary

The main feature of this release is the ability to quickly and easily add words to workspace dictionary.