Various cspell dictionaries. Each dictionary is its own package. See
README.md in each directory.
- English - American (Included by default in cspell and VS Code Spell Checker)
- English - British (Included by default in cspell and VS Code Spell Checker)
- Portuguese - Brazilian
- Russian (Small)
- Russian (Large)
- cpp - C and C++
- Django - Django framework function names
Please help correct any mistakes in the dictionaries.
How to create a new dictionary
Please fork this repository to add new dictionaries.
Using Yeoman script
The Yeoman script can help you create the dictionary template files seen in most of dictionary directories.
npm i -g cspell-tools npm i -g hunspell-reader
Install Yeoman Generator
Install Yeoman and then link the generator.
cd generator-cspell-dicts npm link cd ..
Running the generator
cspell-dicts repository root.
npx yo cspell-dicts <name> <path/to/source/words>
Yeoman will ask you a series of questions:
|name||this is the dictionary. i.e. en_AU or ruby|
|friendly name||this is the friendly name, like Australian|
|description||short description of the dictionary.|
|source file||this is the source file to use to build the dictionary. It can be a .txt or hunspell .dic file. This file will be copied to the dictionary project.|
|local||this is the two letter language code with an optional cultural code. a
|languageId||this is the VS Code programming language id or file type.
|store as trie||for large source files (> 1MB) or hunspell files, this should be
|run build||prepare the word list so it can be used by cspell efficiently. You can always run the build step yourself in the dictionary directory
Once all the questions have been answered, the dictionary directory will be created and the files will be copied.
LICENSE files as necessary.
From the dictionary directory
npm run cspell-link
This will add an entry in the cspell global config to import the
cspell-ext.json file in the dictionary directory.
Use either VS Code or cspell to verify that files spell check correctly.
npm install -g cspell
- Check a file:
cspell check path/to/source/file.ext
Checking a file will show you what has been ignored (gray) as well as what is considered an error (red):
Remember to unlink when you are done:
npm run cspell-unlink
npm Global Install
From the dictionary directory.
npm install -g
Then run the link command found in the dictionary
It has the following pattern: