Skip to content

Release v2.0.1-alpha.17

Choose a tag to compare

@github-actions github-actions released this 25 Aug 18:38

Version 2.0 Preview

This is a Preview release of the Extension.

Work is still underway for the final release to the VS Code Marketplace.

Highlights

  • By default, only files in a workspace are spell checked.
  • Be able to specify which files to check by adding globs to files setting.
  • Spelling suggestions available from the context menu.
  • Improved context menu options.
  • Upgrades cspell to version 5.8.2.
  • Supports case sensitive dictionaries
  • Full support of Yaml configuration files: cspell.config.yaml
  • Full support of configuration in package.json under cspell section.
  • Partial support of JavaScript configuration files: cspell.config.js
    The extension supports reading the configuration but can only write to .json and .yaml files.
  • Supports dictionary entries that have numbers and mixed case.
  • Supports more word splitting formats
    It correctly splits both ERRORcode and ERRORCode
  • Reduced installation size and faster loading

Manual Installation

  • Download and decompress code-spell-checker.zip
  • From VS Code Install from VSIX code-spell-checker-2.0.1-alpha.17.vsix
    image

Features

Turning on case sensitive spell checking

VS Code UI

image

VS Code settings.json

"cSpell.caseSensitive": true

cspell.json

"caseSensitive": true

For a file type: markdown
cspell.json

"languageSettings": [
    { "languageId": "markdown", "caseSensitive": true }
]

For a file extension: *.md
cspell.json

"overrides": [
    { "filename": "*.md", "caseSensitive": true }
]

Making Words Forbidden

There are several ways to mark a word as forbidden:

  1. In a custom word list with words beginning with !.
    !forbiddenWord
    
  2. In words section of cspell configuration:
    "words": [
        "!forbiddenWord",
        "configstore"
    ],
    
  3. In flagWords section of cspell configuration:
    "flagWords": ["forbiddenWord"]
    

Overriding Forbidden words

Sometimes it is necessary to allow a word even if it is forbidden.

In a comment

/**
 * Do not mark `forbiddenWord` as incorrect.
 * cspell:ignore forbiddenWord
 */

In the cspell configuration

{
    "ignoreWords": ["forbiddenWord"]
}