plasticrake / cspell-dicts

Various cspell dictionaries

cspell-dicts

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

Language Dictionaries

• Catalan
• Czech
• Danish
• Dutch
• English - American (Included by default in cspell and VS Code Spell Checker)
• English - British (Included by default in cspell and VS Code Spell Checker)
• French
• German
• Greek
• Hebrew
• Italian
• Persian
• Polish
• Portuguese - Brazilian
• Portuguese
• Russian (Small)
• Russian (Large)
• Spanish
• Swedish
• Turkish
• Ukrainian
• Vietnamese

Programming Dictionaries

• bash - Bash/Shell scripts
• cpp - C and C++
• Django - Django framework function names
• Elixir
• Go
• Java
• LaTex
• Lua
• PHP
• Python
• Ruby
• Rust
• Scala

Specialized Dictionaries

• HTML Symbol Entities
• lorem ipsum
• Medical Terms
• Scientific Terms

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):

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