Spelling Checker for Visual Studio Code

A basic spell checker that works well with code and documents.

The goal of this spell checker is to help catch common spelling errors while keeping the number of false positives low.

Support Further Development​

Functionality​

Load a TypeScript, JavaScript, Text, etc. file. Words not in the dictionary files will have a squiggly underline.

Example​

Suggestions​

To see the list of suggestions:

After positioning the cursor in the word, any of the following should display the list of suggestions:

• Click on the 💡 (lightbulb) in the left hand margin.
• Quick Fix Editor action command:
  • Mac: ⌘+. or Cmd+.
  • PC: Ctrl+.

Install​

Open up VS Code and hit F1 and type ext select install and type code-spell-checker hit enter and reload window to enable.

Supported Languages​

• English (US)
• English (GB) - turn on by changing "cSpell.language": "en" to "cSpell.language": "en-GB"

Add-On Dictionaries​

Language Dictionaries​

• Ancient Greek - Ancient Greek dictionary extension for VS Code.
• Arabic - Arabic dictionary extension for VS Code.
• Australian English - Australian English dictionary extension for VS Code.
• Austrian German - Austrian German dictionary extension for VS Code.
• Basque - Basque dictionary extension for VS Code.
• British English - British English dictionary extension for VS Code.
• Bulgarian - Bulgarian dictionary extension for VS Code.
• Canadian English - Canadian English dictionary extension for VS Code.
• Catalan - Catalan dictionary extension for VS Code.
• Croatian - Croatian dictionary extension for VS Code.
• Czech - Czech dictionary extension for VS Code.
• Danish - Danish dictionary extension for VS Code.
• Dutch - Dutch / Nederlands dictionary extension for VS Code.
• Esperanto - Esperanto dictionary extension for VS Code.
• Estonian - Estonian dictionary extension for VS Code.
• Finnish - Finnish dictionary extension for VS Code.
• French - French dictionary extension for VS Code.
• French Réforme 90 - French Réforme 90 dictionary extension for VS Code.
• German - German dictionary extension for VS Code.
• Greek - Greek dictionary extension for VS Code.
• Hebrew - Hebrew dictionary extension for VS Code.
• Hungarian - Hungarian dictionary extension for VS Code.
• Indonesian - Indonesian dictionary extension for VS Code.
• Italian - Italian dictionary extension for VS Code.
• Latin - Latin dictionary extension for VS Code.
• Latvian - Latvian dictionary extension for VS Code.
• Lithuanian - Lithuanian dictionary extension for VS Code.
• Macedonian - Macedonian dictionary extension for VS Code.
• Norwegian Bokmål - Norwegian Bokmål dictionary extension for VS Code.
• Persian - Persian dictionary extension for VS Code.
• Polish - Polish dictionary extension for VS Code.
• Portuguese - Portuguese dictionary extension for VS Code.
• Brazilian Portuguese - Brazilian Portuguese dictionary extension for VS Code.
• Romanian - Romanian dictionary extension for VS Code.
• Russian - Russian dictionary extension for VS Code.
• Serbian - Serbian dictionary extension for VS Code.
• Slovak - Slovak dictionary extension for VS Code.
• Slovenian - Slovenian dictionary extension for VS Code.
• Spanish - Spanish Add-On for Code Spell Checker
• Swedish - Swedish dictionary extension for VS Code.
• Swiss German - Swiss German dictionary extension for VS Code.
• Turkish - Turkish dictionary extension for VS Code.
• Ukrainian - Ukrainian dictionary extension for VS Code.
• Vietnamese - Vietnamese dictionary extension for VS Code.

Technical Dictionaries​

• Medical Terms - Medical Terms Add-On for Code Spell Checker
• Scientific Terms - Scientific Terms dictionary extension for VS Code.
• Win32 - Win32 dictionary extension for VS Code.

Enabled File Types​

• AsciiDoc
• C, C++
• C#
• css, less, scss
• Dart
• Elixir
• Go
• Html
• Java
• JavaScript
• JSON / JSONC
• LaTeX
• Markdown
• PHP
• PowerShell
• Pug / Jade
• Python
• reStructuredText
• Ruby
• Rust
• Scala
• Text
• TypeScript
• YAML
• SQL

Enable / Disable File Types​

To Enable or Disable spell checking for a file type:

1. Click on the Spell Checker status in the status bar:

2. On the Info screen, click the checkbox.

How it works with camelCase​

The concept is simple, split camelCase words before checking them against a list of known English words.

• camelCase -> camel case
• HTMLInput -> html input -- Notice that the I is associated with Input and not HTML
• snake_case_words -> snake case words
• camel2snake -> camel snake -- (the 2 is ignored)

Special case with ALL CAPS words​

There are a few special cases to help with common spelling practices for ALL CAPS words.

Trailing s, ing, ies, es, ed are kept with the previous word.

• CURLs -> curls -- trailing s
• CURLedRequest -> curled request -- trailing ed

Things to note​

• This spellchecker is case insensitive. It will not catch errors like english which should be English.
• The spellchecker uses a local word dictionary. It does not send anything outside your machine.
• The words in the dictionary can and do contain errors.
• There are missing words.
• Only words longer than 3 characters are checked. "jsj" is not checked, while "jsja" is checked and will be marked as incorrect because it does not exist in any of the dictionaries.
• All symbols and punctuation are ignored.

In Document Settings​

It is possible to add spell check settings into your source code. This is to help with file specific issues that may not be applicable to the entire project.

All settings are prefixed with cSpell: or spell-checker:.

• disable -- turn off the spell checker for a section of code.
• enable -- turn the spell checker back on after it has been turned off.
• ignore -- specify a list of words to be ignored.
• words -- specify a list of words to be considered correct and will appear in the suggestions list.
• locale -- set locale (example: cSpell:locale fr,en to use French and English languages)
• ignoreRegExp -- Any text matching the regular expression will NOT be checked for spelling.
• includeRegExp -- Only text matching the collection of includeRegExp will be checked.
• enableCompoundWords / disableCompoundWords -- Allow / disallow words like: "stringlength".

Enable / Disable checking sections of code​

It is possible to disable / enable the spell checker by adding comments to your code.

Disable Checking​

• cSpell:disable
• spell-checker: disable
• spellchecker: disable
• cspell: disable-line
• cspell: disable-next-line

Enable Checking​

• cSpell:enable
• spell-checker: enable
• spellchecker: enable

JavaScript Example​

// cSpell:disable
const wackyWord = ['zaallano', 'wooorrdd', 'zzooommmmmmmm'];
/* cSpell:enable */

// Nest disable / enable is not Supported

// spell-checker:disable
// It is now disabled.

var liep = 1;

/* cspell:disable */
// It is still disabled

// cSpell:enable
// It is now enabled

const str = 'goededag'; // <- will be flagged as an error.

// spell-checker:enable <- doesn't do anything

// cSPELL:DISABLE <-- also works.

// if there isn't an enable, spelling is disabled till the end of the file.
const str = 'goedemorgen'; // <- will NOT be flagged as an error.

Markdown Example​

<!--- cSpell:disable --->

This text is not checked.

<!--- cSpell:enable --->

This text is checked.

Ignore​

Ignore allows you the specify a list of words you want to ignore within the document.

// cSpell:ignore zaallano, wooorrdd
// cSpell:ignore zzooommmmmmmm
const wackyWord = ['zaallano', 'wooorrdd', 'zzooommmmmmmm'];

Note: words defined with ignore will be ignored for the entire file.

Words​

The words list allows you to add words that will be considered correct and will be used as suggestions.

// cSpell:words woorxs sweeetbeat
const companyName = 'woorxs sweeetbeat';

Note: words defined with words will be used for the entire file.

Enable / Disable compound words​

In some programming language it is common to glue words together.

// cSpell:enableCompoundWords
char * errormessage;  // Is ok with cSpell:enableCompoundWords
int    errornumber;   // Is also ok.

Note: Compound word checking cannot be turned on / off in the same file. The last setting in the file determines the value for the entire file.

Excluding and Including Text to be checked.​

By default, the entire document is checked for spelling. cSpell:disable/cSpell:enable above allows you to block off sections of the document. ignoreRegExp and includeRegExp give you the ability to ignore or include patterns of text. By default the flags gim are added if no flags are given.

The spell checker works in the following way:

1. Find all text matching includeRegExp
2. Remove any text matching excludeRegExp
3. Check the remaining text.

Exclude Example​

// cSpell:ignoreRegExp 0x[0-9a-f]+     -- will ignore c style hex numbers
// cSpell:ignoreRegExp /0x[0-9A-F]+/g  -- will ignore upper case c style hex numbers.
// cSpell:ignoreRegExp g{5} h{5}       -- will only match ggggg, but not hhhhh or 'ggggg hhhhh'
// cSpell:ignoreRegExp g{5}|h{5}       -- will match both ggggg and hhhhh
// cSpell:ignoreRegExp /g{5} h{5}/     -- will match 'ggggg hhhhh'
/* cSpell:ignoreRegExp /n{5}/          -- will NOT work as expected because of the ending comment -> */
/*
   cSpell:ignoreRegExp /q{5}/          -- will match qqqqq just fine but NOT QQQQQ
*/
// cSpell:ignoreRegExp /[^\s]{40,}/    -- will ignore long strings with no spaces.
// cSpell:ignoreRegExp Email           -- this will ignore email like patterns -- see Predefined RegExp expressions
var encodedImage = 'HR+cPzr7XGAOJNurPL0G8I2kU0UhKcqFssoKvFTR7z0T3VJfK37vS025uKroHfJ9nA6WWbHZ/ASn...';
var email1 = 'emailaddress@myfancynewcompany.com';
var email2 = '<emailaddress@myfancynewcompany.com>';

Note: ignoreRegExp and includeRegExp are applied to the entire file. They do not start and stop.

Include Example​

In general you should not need to use includeRegExp. But if you are mixing languages then it could come in helpful.

# cSpell:includeRegExp #.*
# cSpell:includeRegExp /(["]{3}|[']{3})[^\1]*?\1/g
# only comments and block strings will be checked for spelling.
def sum_it(self, seq):
    """This is checked for spelling"""
    variabele = 0
    alinea = 'this is not checked'
    for num in seq:
        # The local state of 'value' will be retained between iterations
        variabele += num
        yield variabele

Predefined RegExp expressions​

Exclude patterns​

• Urls¹ -- Matches urls
• HexValues -- Matches common hex format like #aaa, 0xfeef, \u0134
• EscapeCharacters¹ -- matches special characters: \n, \t etc.
• Base64¹ -- matches base64 blocks of text longer than 40 characters.
• Email -- matches most email addresses.

Include Patterns​

• Everything¹ -- By default we match an entire document and remove the excludes.
• string -- This matches common string formats like '...', "...", and `...`
• CStyleComment -- These are C Style comments /* */ and //
• PhpHereDoc -- This matches PHPHereDoc strings.

^1. These patterns are part of the default include/exclude list for every file.

Customization​

The spell checker configuration can be controlled via VS Code preferences or cspell.json configuration file.

Order of precedence:

1. Workspace Folder cspell.json
2. Workspace Folder .vscode/cspell.json
3. VS Code Preferences cSpell section.

Adding words to the Workspace Dictionary​

You have the option to add you own words to the workspace dictionary. The easiest, is to put your cursor on the word you wish to add, when you lightbulb shows up, hit Ctrl+. (windows) / Cmd+. (Mac). You will get a list of suggestions and the option to add the word.

You can also type in a word you want to add to the dictionary: F1 add word -- select Add Word to Dictionary and type in the word you wish to add.

cspell.json​

Words added to the dictionary are placed in the cspell.json file in the workspace folder. Note, the settings in cspell.json will override the equivalent cSpell settings in VS Code's settings.json.

Example cspell.json file​

// cSpell Settings
{
    // Version of the setting file.  Always 0.2
    "version": "0.2",
    // language - current active spelling language
    "language": "en",
    // words - list of words to be always considered correct
    "words": [
        "mkdirp",
        "tsmerge",
        "githubusercontent",
        "streetsidesoftware",
        "vsmarketplacebadge",
        "visualstudio"
    ],
    // flagWords - list of words to be always considered incorrect
    // This is useful for offensive words and common spelling errors.
    // For example "hte" should be "the"
    "flagWords": [
        "hte"
    ]
}

VS Code Configuration Settings​

    //-------- Code Spell Checker Configuration --------
    // The Language locale to use when spell checking. "en", "en-US" and "en-GB" are currently supported by default.
    "cSpell.language": "en",

    // Controls the maximum number of spelling errors per document.
    "cSpell.maxNumberOfProblems": 100,

    // Controls the number of suggestions shown.
    "cSpell.numSuggestions": 8,

    // The minimum length of a word before checking it against a dictionary.
    "cSpell.minWordLength": 4,

    // Specify file types to spell check.
    "cSpell.enabledLanguageIds": [
        "csharp",
        "go",
        "javascript",
        "javascriptreact",
        "markdown",
        "php",
        "plaintext",
        "typescript",
        "typescriptreact",
        "yaml",
        "sql"
    ],

    // Enable / Disable the spell checker.
    "cSpell.enabled": true,

    // Words to add to dictionary for a workspace.
    "cSpell.words": [],

    // Enable / Disable compound words like 'errormessage'
    "cSpell.allowCompoundWords": false,

    // Words to be ignored and not suggested.
    "cSpell.ignoreWords": ["behaviour"],

    // User words to add to dictionary.  Should only be in the user settings.
    "cSpell.userWords": [],

    // Specify paths/files to ignore.
    "cSpell.ignorePaths": [
        "node_modules",        // this will ignore anything the node_modules directory
        "**/node_modules",     // the same for this one
        "**/node_modules/**",  // the same for this one
        "node_modules/**",     // Doesn't currently work due to how the current working directory is determined.
        "vscode-extension",    //
        ".git",                // Ignore the .git directory
        "*.dll",               // Ignore all .dll files.
        "**/*.dll"             // Ignore all .dll files
    ],

    // flagWords - list of words to be always considered incorrect
    // This is useful for offensive words and common spelling errors.
    // For example "hte" should be "the"`
    "cSpell.flagWords": ["hte"],

    // Set the delay before spell checking the document. Default is 50.
    "cSpell.spellCheckDelayMs": 50,

    // Set Diagnostic Reporting Level
    //   Error - Report Spelling Issues as Errors
    //   Warning - Report Spelling Issues as Warnings
    //   Information - Report Spelling Issues as Information (default)
    //   Hint - Report Spelling Issues as Hints, will not show up in Problems
    "cSpell.diagnosticLevel": "Information",

Dictionaries​

The spell checker includes a set of default dictionaries.

General Dictionaries​

• wordsEn - Derived from Hunspell US English words.
• wordsEnGb - Derived from Hunspell GB English words.
• companies - List of well known companies
• softwareTerms - Software Terms and concepts like "coroutine", "debounce", "tree", etc.
• misc - Terms that do not belong in the other dictionaries.

Programming Language Dictionaries​

• typescript - keywords for Typescript and Javascript
• node - terms related to using nodejs.
• php - php keywords and library methods
• go - go keywords and library methods
• python - python keywords
• powershell - powershell keywords
• html - html related keywords
• css - css, less, and scss related keywords

Miscellaneous Dictionaries​

• fonts - long list of fonts - to assist with css

Based upon the programming language, different dictionaries will be loaded.

Here are some of the default rules:

• "*" matches any programming language / file type.
• "locale" is used to filter based upon the "cSpell.language" setting.

{
"cSpell.languageSettings": [
  { "languageId": '*',      "locale": 'en',    "dictionaries": ['wordsEn'] },
  { "languageId": '*',      "locale": 'en-US', "dictionaries": ['wordsEn'] },
  { "languageId": '*',      "locale": 'en-GB', "dictionaries": ['wordsEnGb'] },
  { "languageId": '*',                         "dictionaries": ['companies', 'softwareTerms', 'misc'] },
  { "languageId": "python",                    "dictionaries": ["python"]},
  { "languageId": "go",                        "dictionaries": ["go"] },
  { "languageId": "javascript",                "dictionaries": ["typescript", "node"] },
  { "languageId": "javascriptreact",           "dictionaries": ["typescript", "node"] },
  { "languageId": "typescript",                "dictionaries": ["typescript", "node"] },
  { "languageId": "typescriptreact",           "dictionaries": ["typescript", "node"] },
  { "languageId": "html",                      "dictionaries": ["html", "fonts", "typescript", "css"] },
  { "languageId": "php",                       "dictionaries": ["php", "html", "fonts", "css", "typescript"] },
  { "languageId": "css",                       "dictionaries": ["fonts", "css"] },
  { "languageId": "less",                      "dictionaries": ["fonts", "css"] },
  { "languageId": "scss",                      "dictionaries": ["fonts", "css"] },
];
}

How to add your own Dictionaries​

cSpell.customDictionaries​

interface Settings {
    'cSpell.customDictionaries': {
        [name: string]: CustomDictionary;
    };
}

interface CustomDictionary {
    /**
     * @title Name of Dictionary
     * The reference name of the dictionary.
     *
     *
     * Example: `My Words` or `custom`
     *
     *
     * If they name matches a pre-defined dictionary, it will override the pre-defined dictionary.
     * If you use: `typescript` it will replace the built-in TypeScript dictionary.
     */
    name?: DictionaryId;

    /**
     * @title Description of the Dictionary
     * Optional: A human readable description.
     */
    description?: string;

    /**
     * @title Path to Dictionary Text File
     * Define the path to the dictionary text file.
     *
     *
     * **Note:** if path is `undefined` the `name`d dictionary is expected to be found
     * in the `dictionaryDefinitions`.
     *
     *
     * File Format: Each line in the file is considered a dictionary entry.
     * Case is preserved while leading and trailing space is removed.
     * The path should be absolute, or relative to the workspace.
     *
     * **Example:** relative to User's folder
     *
     * ```
     * ~/dictionaries/custom_dictionary.txt
     * ```
     *
     * **Example:** relative to the `client` folder in a multi-root workspace
     *
     * ```
     * ${workspaceFolder:client}/build/custom_dictionary.txt
     * ```
     *
     * **Example:** relative to the current workspace folder in a single-root workspace
     *
     * **Note:** this might no as expected in a multi-root workspace since it is based upon the relative
     * workspace for the currently open file.
     *
     * ```
     * ${workspaceFolder}/build/custom_dictionary.txt
     * ```
     *
     * **Example:** relative to the workspace folder in a single-root workspace or the first folder in
     * a multi-root workspace
     *
     * ```
     * ./build/custom_dictionary.txt
     * ```
     */
    path?: FsPath;

    /**
     * @title Add Words to Dictionary
     * Indicate if this custom dictionary should be used to store added words.
     * @default true
     */
    addWords?: boolean;

    /**
     * @title Scope of dictionary
     * Options are
     * - `user` - words that apply to all projects and workspaces
     * - `workspace` - words that apply to the entire workspace
     * - `folder` - words that apply to only a workspace folder
     */
    scope?: CustomDictionaryScope | CustomDictionaryScope[];
}

Global Dictionary​

To add a global dictionary, you will need change your user settings.

Define the Dictionary​

In your user settings, you will need to tell the spell checker where to find your word list.

Example adding medical terms, so words like acanthopterygious can be found.

VS Code Settings

"cSpell.customDictionaries": {
  "myWords": {
    "name": "myWords",
    "path": "~/my-words.txt",
    "scope": "user",
    "addWords": true
  }
}

Explained: In this example, we have told the spell checker where to find our personal dictionary called myWords.

• name - this is the name of the dictionary, all references to this dictionary is done by the name.
• path - this the path to the dictionary file. Since it is in the user settings, we have to use absolute paths or paths relative to the user directory by using ~/.
• scope - (Optional) this is used to "scope" a dictionary to user, workspace, or folder. Scope is used to help communicate the intended use of the dictionary.
• addWords - (Optional) default - true - is used to show / hide the dictionary as a possible target for adding words.

Project / Workspace Dictionary using cspell.json​

To add a dictionary at the project level should be defined in a cspell.json file so it can be used with the cspell command line tool. This file can be either at the project root or in the .vscode directory.

Example adding medical terms, where the terms are checked into the project and we only want to use it for .md files.

{
    "dictionaryDefinitions": [
        { "name": "medicalTerms", "path": "./dictionaries/medicalterms-en.txt"},
        { "name": "cities", "path": "./dictionaries/cities.txt"}
    ],
    "dictionaries": [
        "cities"
    ],
    "languageSettings": [
        { "languageId": "markdown", "dictionaries": ["medicalTerms"] },
        { "languageId": "plaintext", "dictionaries": ["medicalTerms"] }
    ]
}

Explained: In this example, two dictionaries were defined: cities and medicalTerms. The paths are relative to the location of the cSpell.json file. This allows for dictionaries to be checked into the project.

The cities dictionary is used for every file type, because it was added to the list to dictionaries. The medicalTerms dictionary is only used when editing markdown or plaintext files.

DictionaryDefinition

interface DictionaryDefinition {
    /**
     * This is the name of a dictionary.
     *
     * Name Format:
     * - Must contain at least 1 number or letter.
     * - Spaces are allowed.
     * - Leading and trailing space will be removed.
     * - Names ARE case-sensitive.
     * - Must not contain `*`, `!`, `;`, `,`, `{`, `}`, `[`, `]`, `~`.
     */
    name: DictionaryId;
    /** Optional description. */
    description?: string;
    /** Path to custom dictionary text file. */
    path: CustomDictionaryPath;
    /**
     * Defines the scope for when words will be added to the dictionary.
     * Scope values: `user`, `workspace`, `folder`.
     */
    scope?: CustomDictionaryScope | CustomDictionaryScope[];
    /**
     * When `true`, let's the spell checker know that words can be added to this dictionary.
     */
    addWords: boolean;
}

Project / Workspace Dictionary using VS Code Settings​

VS Code Settings

"cSpell.customDictionaries": {
  "project-words": {
    "name": "project-words",
    "path": "${workspaceRoot}/project-words.txt",
    "description": "Words used in this project",
    "addWords": true
  },
  "medicalTerms": {
    "name": "medicalTerms",
    "path": "/Users/guest/projects/cSpell-WordLists/dictionaries/medicalterms-en.txt",
    "addWords": false // Do not add words to this dictionary
  },
  "companyTerms": {
    "name": "companyTerms",
    "path": "${workspaceFolder}/../company/terms.txt"
    // "addWords": true -- is implied
  },
  "custom": true, // Enable the `custom` dictionary
  "internal-terms": false // Disable the `internal-terms` dictionary
}

FAQ​

See: FAQ

Brought to you by Street Side Software