Skip to content
Various cspell dictionaries
JavaScript Python Shell
Branch: master
Clone or download
Jason3S Add Word to various dictionaries (#149)
* Add software terms

* Remove unused US dict dir

* Update django.txt

* Remove unused merg command

* Update en_US.txt

Fix #134
Fix #132

* Update softwareTerms.txt

Fix #88

* Update en_US.trie.gz
Latest commit ef3b384 Jan 22, 2020
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode
generator-cspell-dicts Update build process (#146) Dec 23, 2019
packages Add Word to various dictionaries (#149) Jan 22, 2020
scripts Remove dead scripts May 15, 2019
util
.gitattributes chore: Add gitattributes for line endings May 19, 2019
.gitignore Build scientific dictionary with a trie. May 19, 2019
.travis.yml Make sure tests are run. May 19, 2019
CHANGELOG.md Add contributing file Aug 3, 2017
CONTRIBUTING.md docs() improve Markdown syntax Aug 7, 2017
CONTRIBUTORS.md Update CONTRIBUTORS.md Dec 4, 2019
LICENSE Initial commit Mar 24, 2017
README.md Update README.md Dec 4, 2019
appveyor.yml Create appveyor.yml May 19, 2019
cSpell.json
lerna.json Update lerna Jan 13, 2019
package-lock.json Update build process (#146) Dec 23, 2019
package.json

README.md

cspell-dicts

Various cspell dictionaries. Each dictionary is its own package. See README.md in each directory.

Language Dictionaries

Programming Dictionaries

Specialized Dictionaries

Contributing

Please help correct any mistakes in the dictionaries.

See: Contributing

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.

Install cspell-tools

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

In the cspell-dicts repository root.

npx yo cspell-dicts <name> <path/to/source/words>

Yeoman will ask you a series of questions:

Field Description
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 * mean it will match any language. More than one local can be added by separating them with a comma. i.e. en, en_AU.
languageId this is the VS Code programming language id or file type. * will match all file types. Examples: java, cpp, plaintext, markdown, ruby. Types know to cspell
store as trie for large source files (> 1MB) or hunspell files, this should be y. n will work for all programming language keyword files.
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 npm run build.

Once all the questions have been answered, the dictionary directory will be created and the files will be copied.

Please update README.md and LICENSE files as necessary.

Testing Dictionaries

Smoke test

Linking

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.

Verify with cspell
  • Install cspell: 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):

image

Clean up

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 README.md file. It has the following pattern: cspell-dict-<name>-link. To unlink: cspell-dict-<name>-unlink

You can’t perform that action at this time.