Contributing

Contributions are very welcome.

How to create a new extension

Please fork this repository to add new dictionaries.

The Yeoman script can help you create the dictionary template files seen in most of dictionary directories.

Install Yeoman and then link the generator.

npm install -g yo
cd generator-cspell-dicts-extensions
npm link
cd ..

In the vscode-cspell-dict-extensions repository root.

yo cspell-dict-extensions <name>

Yeoman will ask you a series of questions:

Field	Description
name	this is the dictionary. i.e. `swedish`, `ruby`, or `rust`
friendly name	this is the friendly name, like `Swedish`
display name	this is the name shown on the VS Code Extensions page.
description	short description of the extension.
Source Dictionary	This is the NPM install name of the source dictionary
Add Enable / Disable Commands	This is used for adding helper commands for human language locals like `fr` for French or `fr,fr_CA` for Canadian French. This option is not necessary for word lists like `companies` or programming languages.
Base Name For Commands	This is added as a suffix onto the command names.
Language Local	This is the two letter language code supported by the dictionary included in the `Source Dictionary` step.
Target Directory	Where to create the extension
NPM Package Name	name added to the `package.json`

After all the information is entered, the extension should be generated.

Please fix any errors and make sure the following two commands run:

cd extensions/<name>
npm install
npm run build

Please update README.md, package.json and LICENSE files as necessary.

code extensions/<name>

Within VS Code Debug -> Start Debugging with the Launch Extension configuration.