@cspell/dict-en_us

What is @cspell/dict-en_us?

@cspell/dict-en_us is a dictionary package for the CSpell spell checker. It provides American English word lists that can be used to enhance the spell-checking capabilities of CSpell.

What are @cspell/dict-en_us's main functionalities?

Adding the dictionary to CSpell

This feature allows you to add the American English dictionary to your CSpell configuration. By including 'en_us' in the 'dictionaries' array, CSpell will use the word list provided by @cspell/dict-en_us for spell checking.

{
  "dictionaries": ["en_us"]
}

Installing the dictionary

This feature demonstrates how to install the @cspell/dict-en_us package using npm. This is the first step to using the American English dictionary with CSpell.

npm install @cspell/dict-en_us

Other packages similar to @cspell/dict-en_us

@cspell/dict-en-gb

@cspell/dict-en-gb provides British English word lists for the CSpell spell checker. It is similar to @cspell/dict-en_us but focuses on British English instead of American English.

@cspell/dict-fr-fr

@cspell/dict-fr-fr offers French word lists for the CSpell spell checker. It is similar in functionality to @cspell/dict-en_us but is designed for French language spell checking.

hunspell-dict-en-us

hunspell-dict-en-us provides American English dictionaries for the Hunspell spell checker. It is similar to @cspell/dict-en_us but is used with the Hunspell spell checking engine instead of CSpell.

README

Cspell English Dictionary

English dictionary for cspell.

This is a pre-built dictionary for use with cspell.

Note

This dictionary comes pre-installed with cspell. It should not be necessary to add it.

Requirements

Tool	Version
cspell	>= 6
Code Spell Checker - Visual Studio Code	>= 2

Installation

Global Install and add to cspell global settings.

npm install -g @cspell/dict-en_us
cspell link add @cspell/dict-en_us

Uninstall from cspell

cspell link remove @cspell/dict-en_us

Manual Installation

The cspell-ext.json file in this package should be added to the import section in your cspell.json file.

{
    // …
    "import": ["@cspell/dict-en_us/cspell-ext.json"],
    // …
}

Building

Building is only necessary if you want to modify the contents of the dictionary. Note: Building will take a few minutes for large files.

npm run build

Adding Words

Please add any words to src/additional_words.txt by making a pull request.

Resources

The Hunspell source for this dictionary can be found:

http://wordlist.aspell.net/hunspell-readme/

License

MIT

Some packages may have other licenses included.