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)
- Esperanto
- French
- German
- Greek
- Hebrew
- Italian
- Norwegian Bokmål
- Persian
- Polish
- Portuguese - Brazilian
- Portuguese
- Russian
- Serbian (Cyrillic)
- Serbian (Latin)
- Slovenian
- Spanish
- Swedish
- Turkish
- Ukrainian
- Vietnamese
Programming Dictionaries
- bash - Bash/Shell scripts
- cpp - C and C++
- Django - Django framework function names
- Docker - Dockerfile instructions
- Elixir
- Go
- Java
- LaTex
- Lua
- PHP
- Python
- Ruby
- Rust
- Scala
- TypeScript
Specialized Dictionaries
All Dictionaries
package | dictionary ID | name | description |
---|---|---|---|
@cspell/dict-ada | ada | Ada Language | Ada Language Dictionary |
@cspell/dict-al | al | AL | AL Dictionary |
@cspell/dict-ar | ar | Arabic | Arabic dictionary for CSpell. |
@cspell/dict-aws | aws | AWS | AWS dictionary for cspell. |
@cspell/dict-bash | bash | bash | Bash dictionary for cspell. |
@cspell/dict-bg-bg | bg-bg | Bulgarian | Bulgarian dictionary for cspell. |
@cspell/dict-ca | ca | Catalan | Catalan dictionary for cspell. |
@cspell/dict-city-names-finland | city-names-finland | Cities of Finland | List of cities in Finland. |
@cspell/dict-clojure | clojure | clojure | Clojure dictionary for cspell. |
@cspell/dict-companies | companies | Company names | Company names dictionary for cspell. |
@cspell/dict-cpp | cpp-legacy; cpp; cpp-refined | C/C++ Dictionary | C/C++ Keywords and common library functions. |
@cspell/dict-cryptocurrencies | cryptocurrencies | Cryptocurrencies | Cryptocurrencies dictionary for cspell. |
@cspell/dict-cs-cz | cs-cz | Czech | Czech dictionary for cspell. |
@cspell/dict-csharp | csharp | csharp | C# dictionary for cspell. |
@cspell/dict-css | css | css | Css dictionary for cspell. |
@cspell/dict-da-dk | da-dk | Danish Dictionary | Danish (da-DK) Dictionary. |
@cspell/dict-dart | dart | dart | Dart dictionary for cspell. |
@cspell/dict-data-science | data-science | Data Science | Data Science dictionary for cspell. |
@cspell/dict-de-at | de-at | Austrian German Dictionary | Austrian German (de-AT) Dictionary. |
@cspell/dict-de-ch | de-ch | Swiss German Dictionary | Swiss German (de-CH) Dictionary. |
@cspell/dict-de-de | de-de | German Dictionary | German (de-DE) Dictionary. |
@cspell/dict-django | django | Django Keywords | List of Python Django Framework keywords. |
@cspell/dict-docker | docker | Docker Dictionary | Docker dictionary for cspell. |
@cspell/dict-dotnet | dotnet | .Net Dictionary | .Net keywords. |
@cspell/dict-el | el | Greek | Greek dictionary for cspell. |
@cspell/dict-elixir | elixir | elixir | Elixir dictionary for cspell. |
@cspell/dict-en-common-misspellings | English - Common Misspellings | Common English misspellings dictionary for cspell. | |
@cspell/dict-en-au | en-au | Australian English Dictionary | Australian English Dictionary |
@cspell/dict-en-ca | en-ca | Canadian English Dictionary | Canadian English Dictionary |
@cspell/dict-en-gb | en-gb | British English Dictionary | British English Dictionary |
@cspell/dict-en-gb-mit | en-gb-mit | British English Dictionary Limited | British English Dictionary with MIT License |
@cspell/dict-en_us | en_us | American English Dictionary | American English Dictionary |
@cspell/dict-en-shared | en-shared | en_shared | English words shared between the various English dictionaries. |
@cspell/dict-eo | eo | Esperanto | Esperanto dictionary for cspell. |
@cspell/dict-es-es | es-es | Spanish Dictionary (Spain) | Spanish Dictionary (Spain) |
@cspell/dict-et-ee | et-ee | Estonian | Estonian dictionary for cspell. |
@cspell/dict-eu | eu | Basque | Basque dictionary for cspell. |
@cspell/dict-fa-ir | fa-ir | Persian Dictionary | Persian Dictionary |
@cspell/dict-filetypes | filetypes | filetypes | Filetypes dictionary for cspell. |
@cspell/dict-fonts | fonts | font names | Font names dictionary for cspell. |
@cspell/dict-fr-fr | fr-fr | French Dictionary (France) | French Dictionary (France) |
@cspell/dict-fr-reforme | fr-fr-90 | Français Réforme 1990 | Français Réforme 1990 dictionary for cspell. |
@cspell/dict-fullstack | fullstack | Fullstack | Common words encountered during fullstack development |
@cspell/dict-gaming-terms | gaming-terms | Gaming | Gaming dictionary for cspell. |
@cspell/dict-git | git | CSpell configuration for GIT | |
@cspell/dict-golang | golang | Go Language | Go Language Dictionary |
@cspell/dict-haskell | haskell | Haskell | Haskell dictionary for cspell. |
@cspell/dict-he | he | Hebrew Dictionary | Hebrew Dictionary |
@cspell/dict-hr-hr | hr-hr | Croatian | Croatian dictionary for cspell. |
@cspell/dict-html | html | html | Html dictionary for cspell. |
@cspell/dict-html-symbol-entities | html-symbol-entities | HTML Symbol Entities | HTML Symbol Entities Dictionary |
@cspell/dict-it-it | it-it | Italian | Italian dictionary for cspell. |
@cspell/dict-java | java | Java | Java dictionary for cspell. |
@cspell/dict-k8s | k8s | k8s | K8s dictionary for cspell. |
@cspell/dict-latex | latex | LaTeX | LaTeX cspell dictionary |
@cspell/dict-lorem-ipsum | lorem-ipsum | lorem-ipsum | Lorem-ipsum dictionary for cspell. |
@cspell/dict-lt-lt | lt-lt | Lithuanian | Lithuanian dictionary for cspell. |
@cspell/dict-lua | lua | lua | Lua dictionary for cspell. |
@cspell/dict-markdown | markdown | Markdown | Markdown dictionary for cspell. |
@cspell/dict-medicalterms | medical terms | Medical terms | Medical Terms Dictionary |
@cspell/dict-mnemonics | mnemonics | Mnemonics | i86 Mnemonics dictionary for cspell |
@cspell/dict-monkeyc | monkeyc | Monkey C | Monkey C dictionary for cspell. |
@cspell/dict-nb-no | nb-no | Norwegian Bokmål | Norwegian Bokmål dictionary for cspell. |
@cspell/dict-nl-nl | nl-nl | Dutch (Netherlands) Dictionary | Dutch (Netherlands) Dictionary |
@cspell/dict-node | node | Node.js | Node.js dictionary for cspell. |
@cspell/dict-npm | npm | NPM | NPM dictionary for cspell. |
@cspell/dict-php | php | PHP Dictionary | Php dictionary for cspell. |
@cspell/dict-pl_pl | pl-pl | Polish Dictionary | Polish Dictionary |
@cspell/dict-powershell | powershell | PowerShell Dictionary | PowerShell Keyword Dictionary |
@cspell/dict-pt-br | pt-br | Portuguese (Brazilian) Dictionary | Portuguese (Brazilian) Dictionary |
@cspell/dict-pt-pt | pt-pt | Portuguese Dictionary (Portugal) | Portuguese Dictionary (Portugal) |
@cspell/dict-public-licenses | public-licenses | Common Public Licenses | Common Public Licenses dictionary for cspell. |
@cspell/dict-python | python; python-common | Python Dictionary | Python Keyword Dictionary |
@cspell/dict-r | r | R | R dictionary for cspell. |
@cspell/dict-redis | redis | redis | Redis dictionary for cspell. |
@cspell/dict-ro-ro | ro-ro | Romanian | Romanian dictionary for cspell. |
@cspell/dict-ru_ru | ru-ru | Russian Dictionary (Combined) | Russian Dictionary (Combined) |
@cspell/dict-ruby | ruby | Ruby | For ruby and ruby on rails |
@cspell/dict-rust | rust | Rust Dictionary | Rust Keyword Dictionary |
@cspell/dict-scala | scala | Scala | Scala dictionary for cspell. |
@cspell/dict-scientific-terms-us | scientific-terms-us | Scientific Terms US | Scientific Terms US dictionary for cspell. |
@cspell/dict-shell | bash; shellscript | ShellScript | ShellScript dictionary for cspell. |
@cspell/dict-sk-sk | sk-sk | Slovak | Slovak dictionary for cspell. |
@cspell/dict-sl-si | sl-si | Slovenian | Slovenian dictionary for CSpell. |
@cspell/dict-software-terms | softwareTerms; networking-terms; web-services | Software Terms | Software terms dictionary for cspell. |
@cspell/dict-sql | sql | sql | SQL dictionary for CSpell. |
@cspell/dict-sr-cyrl | sr-cyrl | Serbian (Cyrillic) | Serbian (Cyrillic) dictionary for cspell. |
@cspell/dict-sr-latn | sr-latn | Serbian (Latin) | Serbian (Latin) dictionary for cspell. |
@cspell/dict-sv | sv | Swedish Dictionary | Swedish Dictionary |
@cspell/dict-svelte | svelte | Svelte | Svelte dictionary for cspell. |
@cspell/dict-swift | swift | Swift | Swift dictionary for cspell. |
@cspell/dict-tr-tr | tr-tr | Turkish | Turkish dictionary for cspell. |
@cspell/dict-typescript | typescript | TypeScript | TypeScript and JavaScript dictionary for cspell. |
@cspell/dict-uk-ua | uk-ua | Ukrainian Dictionary | Ukrainian Dictionary |
@cspell/dict-vi-vn | vi-vn | Vietnamese | Vietnamese dictionary for cspell. |
@cspell/dict-vue | vue | CSpell configuration for VUE files | |
@cspell/dict-win32 | win32 | Win32 | Win32 dictionary for cspell. |
Documentation
See Documentation
Contributing
Please help correct any mistakes in the dictionaries.
See: Contributing
Special thanks to all of our amazing contributors!
How to create a new dictionary
Please fork this repository to add new dictionaries.
Install Yarn
Using Yeoman script
The Yeoman script can help you create the dictionary template files seen in most of dictionary directories.
Running the generator
In the cspell-dicts
repository root.
Run yarn to make sure everything is installed.
yarn
Run create-dictionary
to start the Yeoman script.
yarn create-dictionary
or
yarn create-dictionary <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 yarn 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
cspell link add ./cspell-ext.json
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.
cspell
Verify with - Install
cspell
:npm install -g cspell
- Check the global links:
cspell link list
- Check a file:
cspell check <path/to/source/file.ext> [--local=<locale>] [--language-id=<filetype>]
Example:cspell check README.md --local=en,es
-- to check the readme file assuming English and Spanish words.
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:
cspell link remove ./cspell-ext.json
npm Global Install
From the dictionary directory:
npm install -g
From NPM repository:
npm install -g @cspell/dict-<name>
Then run the link command found in the dictionary README.md
file.
It has the following pattern: cspell link add @cspell/dict-<name>
.
To unlink: cspell link remove @cspell/dict-<name>
Brought to you by Street Side Software