cspell-dicts

April 23, 2026 · View on GitHub

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

Support Future Development

GitHub Sponsors

Open Collective

Street Side Software

PayPal

Natural Language Dictionaries

Programming Dictionaries

  • .Net - .Net keywords Dictionary. 1
  • Ada - Ada Language Dictionary 1
  • AL - AL (Microsoft Business Central) Dictionary 1
  • bash - Bash dictionary. 1
  • C/C++ - C/C++ Keywords and common library functions. 1
  • C# - C# dictionary. 1
  • Clojure - Clojure dictionary.
  • CSS - CSS dictionary. 1
  • Dart - Dart dictionary. 1
  • Data Science - Data Science dictionary. 1
  • Django - List of Python Django Framework keywords. 1
  • Docker - Docker dictionary. 1
  • Elixir - Elixir dictionary. 1
  • Emacs Lisp - Emacs Lisp dictionary.
  • F# - F# dictionary. 1
  • Flutter - Flutter dictionary. 1
  • Fullstack - Common words encountered during fullstack development 1
  • GDScript - GDScript dictionary for cspell.
  • Git - CSpell configuration for GIT 1
  • Go Language - Go Language Dictionary 1
  • Haskell - Haskell dictionary. 1
  • HTML - HTML dictionary. 1
  • HTML Symbol Entities - HTML Symbol Entities Dictionary 1
  • Java - Java dictionary. 1
  • Julia - Julia function and keyword dictionary 1
  • K8s - K8s dictionary. 1
  • Kotlin - Kotlin dictionary. 1
  • LaTeX - LaTeX cspell dictionary 1
  • Lua - Lua dictionary. 1
  • Makefile - Makefile dictionary. 1
  • Markdown - Markdown dictionary. 1
  • Mnemonics - i86 Mnemonics dictionary for cspell
  • Monkey C - Monkey C dictionary. 1
  • Node.js - Node.js dictionary. 1
  • NPM - Dictionary of Common Javascript Packages. 1
  • PHP - Php dictionary. 1
  • PowerShell - PowerShell Keyword Dictionary 1
  • Python - Python Keyword Dictionary 1
  • R - R dictionary. 1
  • Ruby - For ruby and ruby on rails 1
  • Rust - Rust Keyword Dictionary 1
  • Scala - Scala dictionary. 1
  • ShellScript - ShellScript dictionary. 1
  • SQL - SQL dictionary. 1
  • Svelte - Svelte dictionary. 1
  • Swift - Swift dictionary. 1
  • Terraform - Terraform dictionary. 1
  • TypeScript/JavaScript - TypeScript and JavaScript dictionary. 1
  • Vue - CSpell configuration for VUE files 1
  • Win32 - Win32 dictionary.
  • Zig - Zig dictionary for cspell. 1

Specialized Dictionaries

Dictionary Bundles

1 Bundled with CSpell.
2 Dictionaries are enabled when packages is imported.

All Dictionaries

PackageNameDictionary IDs
@cspell/dict-ada1Adaada
@cspell/dict-al1ALal
@cspell/dict-arArabicar
@cspell/dict-aws1AWSaws2
@cspell/dict-bash1bash
@cspell/dict-bg-bgBulgarianbg-bg
@cspell/dict-bnBengalibn
@cspell/dict-caCatalanca
@cspell/dict-city-names-finlandCities of Finlandcity-names-finland2
@cspell/dict-clojureClojureclojure
@cspell/dict-companies1Company namescompanies2
@cspell/dict-cpp1C/C++cpp-legacy
cpp
cpp-compound-words
cpp-refined
@cspell/dict-cryptocurrencies1Cryptocurrenciescryptocurrencies2
cryptocurrencies-legacy
@cspell/dict-cs-czCzechcs-cz
@cspell/dict-csharp1C#csharp
@cspell/dict-cspell-bundleCSpell Dictionaries Bundle
@cspell/dict-css1CSScss
@cspell/dict-da-dkDanish Dictionaryda-dk
@cspell/dict-dart1Dartdart
@cspell/dict-data-science1Data Sciencedata-science
data-science-models
data-science-tools
@cspell/dict-de-atAustrian German Dictionaryde-at
@cspell/dict-de-chSwiss German Dictionaryde-ch
@cspell/dict-de-deGerman Dictionaryde-de
@cspell/dict-django1Djangodjango
@cspell/dict-docker1Dockerdocker
@cspell/dict-dotnet1.Netdotnet
@cspell/dict-elGreekel
@cspell/dict-elispEmacs Lispelisp
@cspell/dict-elixir1Elixirelixir
@cspell/dict-en_us1English - Americanen_us
@cspell/dict-en-auEnglish - Australianen-au
@cspell/dict-en-caEnglish - Canadianen-ca
@cspell/dict-en-common-misspellings1English - Common Misspellingsen-common-misspellings
en-gb-common-misspellings
en-us-common-misspellings
@cspell/dict-en-gbEnglish - Britishen-gb
@cspell/dict-en-gb-iseEnglish - British (-ise)en-gb
@cspell/dict-en-gb-legacyEnglish - British (Legacy)en-gb-legacy
@cspell/dict-en-gb-mit1English - British (Limited)en-gb
@cspell/dict-en-sharedEnglish - Shareden-shared
@cspell/dict-en-slangModern English Slang Wordsen-slang
@cspell/dict-eoEsperantoeo
@cspell/dict-es-esSpanish Dictionary (Spain)es-es
@cspell/dict-et-eeEstonianet-ee
@cspell/dict-euBasqueeu
@cspell/dict-fa-irPersian Dictionaryfa-ir
@cspell/dict-fi-fiFinnishfi-fi
@cspell/dict-filetypes1File Typesfiletypes2
@cspell/dict-flutter1Flutterflutter
@cspell/dict-fonts1Font Namesfonts
@cspell/dict-fr-frFrench Dictionary (France)fr-fr
@cspell/dict-fr-reformeFrançais Réforme 1990fr-fr-90
@cspell/dict-fsharp1F#fsharp
@cspell/dict-fullstack1Fullstackfullstack
@cspell/dict-gaming-terms1Gaminggaming-terms
game-development
@cspell/dict-gdScottish Gaelicgd
@cspell/dict-gdscriptGDScriptgdscript
@cspell/dict-gisGIS and PostGISgis
@cspell/dict-git1Gitgit
@cspell/dict-gl-esGalician Dictionary (Spain)gl-es
@cspell/dict-golang1Go Languagegolang
@cspell/dict-google1Google Cloudgoogle
@cspell/dict-grcAncient Greekgrc
@cspell/dict-haskell1Haskellhaskell
@cspell/dict-heHebrew Dictionaryhe
@cspell/dict-hr-hrCroatianhr-hr
@cspell/dict-html1HTMLhtml
@cspell/dict-html-symbol-entities1HTML Symbol Entitieshtml-symbol-entities
@cspell/dict-hu-huHungarianhu-hu
@cspell/dict-hyArmenianhy_am
@cspell/dict-id-idIndonesiaid-id
@cspell/dict-it-itItalianit-it
@cspell/dict-java1Javajava
@cspell/dict-julia1Juliajulia
@cspell/dict-k8s1K8sk8s
@cspell/dict-kotlin1Kotlinkotlin
@cspell/dict-laLatinla
@cspell/dict-latex1LaTeXlatex
@cspell/dict-lorem-ipsum1Lorem-ipsumlorem-ipsum
@cspell/dict-lt-ltLithuanianlt-lt
@cspell/dict-lua1Lualua
@cspell/dict-lvLatvianlv
@cspell/dict-makefile1Makefilemakefile
@cspell/dict-markdown1Markdown
@cspell/dict-medicaltermsMedical termsmedical terms2
@cspell/dict-mime-typesmime-typesmime-types
@cspell/dict-mkMacedonianmk
@cspell/dict-mn-mnMongolianmn-mn
@cspell/dict-mnemonicsMnemonicsmnemonics
@cspell/dict-monkeyc1Monkey Cmonkeyc
@cspell/dict-nb-noNorwegian Bokmålnb-no
@cspell/dict-nl-nlDutch (Netherlands) Dictionarynl-nl
@cspell/dict-node1Node.jsnode
@cspell/dict-npm1NPMnpm
@cspell/dict-people-namesPeople Namespeople-names2
@cspell/dict-php1PHPphp
@cspell/dict-pl_plPolish Dictionarypl-pl
@cspell/dict-pokemonPokémonpokemon2
@cspell/dict-powershell1PowerShellpowershell
@cspell/dict-pt-brPortuguese (Brazilian) Dictionarypt-br
@cspell/dict-pt-ptPortuguese Dictionary (Portugal)pt-pt
@cspell/dict-public-licenses1Common Public Licensespublic-licenses2
@cspell/dict-python1Pythonpython
python-common
@cspell/dict-r1Rr
@cspell/dict-redisRedisredis
@cspell/dict-ro-roRomanianro-ro
@cspell/dict-ru_ruRussian Dictionary (Combined)ru-ru
@cspell/dict-ruby1Rubyruby
ruby-gems
@cspell/dict-rust1Rustrust
rust-crates
@cspell/dict-scala1Scalascala
@cspell/dict-scientific-terms-gbScientific Terms GBscientific-terms-gb
@cspell/dict-scientific-terms-usScientific Terms USscientific-terms-us2
mathematics-terms-us2
@cspell/dict-shell1ShellScriptbash
shellscript
@cspell/dict-sk-skSlovaksk-sk
@cspell/dict-sl-siSloveniansl-si
@cspell/dict-software-terms1Software Termssoftware-term-suggestions2
softwareTerms2
software-tools2
networking-terms
web-services2
computing-acronyms2
coding-compound-terms2
software-terms-alternative
@cspell/dict-sql1SQLsql
@cspell/dict-sr-cyrlSerbian (Cyrillic)sr-cyrl
@cspell/dict-sr-latnSerbian (Latin)sr-latn
@cspell/dict-svSwedish Dictionarysv
@cspell/dict-svelte1Sveltesvelte
@cspell/dict-swift1Swiftswift
@cspell/dict-terraform1Terraformterraform
@cspell/dict-tr-trTurkishtr-tr
@cspell/dict-typescript1TypeScript/JavaScripttypescript
@cspell/dict-uk-uaUkrainian Dictionaryuk-ua
@cspell/dict-vi-vnVietnamesevi-vn
@cspell/dict-vimVimvim
@cspell/dict-vue1Vue
@cspell/dict-win32Win32win32
@cspell/dict-zig1Zigzig

1 Bundled with CSpell.
2 Dictionaries are enabled when packages is imported.

Sorted by Dictionary Name IDs

Name IDDescriptionLocaleFile Type
ada 1Ada Language Dictionary-ada
al 1AL Keywords Dictionary-al
arArabic dictionary.ar-
aws 1 2AWS dictionary.
bash 1Bash dictionary.-bashscript
bg-bgBulgarian dictionary.bg
bg-BG
-
bnBengali dictionary for cspell.bn-
caCatalan dictionary.ca-
city-names-finland 2List of cities in Finland.
clojureClojure dictionary.-clojure
coding-compound-terms 1 2Common coding compound terms.
companies 1 2Company names dictionary.
computing-acronyms 1 2Common acronyms related to computing.
cpp 1C/C++ Keywords and common library functions.-c
cpp
cpp-compound-words 1C/C++ Common word compounds.-c
cpp
cpp-legacy 1Legacy C/C++ Keywords and common library functions.-c
cpp
cpp-refined 1Refined list of C/C++ Keywords and common library functions.-c
cpp
cryptocurrencies 1 2Cryptocurrencies dictionary.
cryptocurrencies-legacy 1Legacy Cryptocurrency dictionary.
cs-czCzech dictionary.cs-
csharp 1C# dictionary.csharp
css 1Css dictionary.-css
da-dkDanish (da-DK) Dictionary.da
da-DK
-
dart 1Dart dictionary.-dart
data-science 1Data Science Terms dictionary.-python
data-science-models 1Data Science Models dictionary.-python
data-science-tools 1Data Science Tools dictionary.-python
de-atAustrian German (de-AT) Dictionary.de_AT-
de-chSwiss German (de-CH) Dictionary.de
de_CH
-
de-deGerman (de-DE) Dictionary.de
de_DE
-
django 1List of Python Django Framework keywords.html
python
docker 1Docker dictionary.-dockerfile
dotnet 1.Net keywords.-cs
elGreek dictionary.el-
elispEmacs Lisp dictionary.-elisp
lisp
elixir 1Elixir dictionary.-elixir
en_us 1American English Dictionaryen
en-US
-
en-auAustralian English Dictionaryen-AU-
en-caCanadian English Dictionaryen-CA-
en-common-misspellings 1Common English misspellingsen
en-gb
en-us
-
en-gbBritish English Dictionaryen-GB-
en-gbBritish English Dictionaryen-GB-
en-gb 1British English Dictionaryen-GB-
en-gb-common-misspellings 1Common British English misspellingsen-gb-
en-gb-legacyLegacy British English Dictionaryen-GB-
en-sharedEnglish words shared between the various English dictionaries.en-
en-slangModern English slang words dictionary.
en-us-common-misspellings 1Common American English misspellingsen-us-
eoEsperanto dictionary.eo-
es-esSpanish Dictionary (Spain)es
es_ES
-
et-eeEstonian dictionary.et
et-EE
-
euBasque dictionary.eu-
fa-irPersian Dictionaryfa
fa-IR
-
fi-fiFinnish dictionary.fi
fi-fi
-
filetypes 1 2File types dictionary.
flutter 1Flutter dictionary.-dart
fonts 1Font names dictionary.
fr-frFrench Dictionary (France)fr
fr_FR
-
fr-fr-90Français Réforme 1990 dictionary.fr
fr-90
fr-fr
-
fsharp 1F# dictionary.-fsharp
fullstack 1Common words encountered during fullstack development-ada
c
cpp
csharp
...
game-development 1Game development dictionary. Includes Godot, Unity, and more terms.
gaming-terms 1Gaming dictionary.
gdScottish Gaelic dictionarygd-
gdscriptGDScript dictionary for cspell.-gdscript
gisGIS and PostGIS dictionary.
git 1Git Termscommit-msg
git-commit
shellscript
gl-esGalician Dictionary (Spain)gl
gl_ES
-
golang 1Go Language Dictionary-go
google 1Google Cloud Development dictionary.
grcAncient Greek dictionary.el-GRC
gr
grc
grc_GR
-
haskell 1Haskell dictionary.-haskell
heHebrew Dictionaryhe-
hr-hrCroatian dictionary.hr
hr-HR
-
html 1HTML dictionary.-html
html-symbol-entities 1HTML Symbol Entities Dictionaryhtml
markdown
hu-huHungarian dictionary.hu
hu-hu
-
hy_amArmenian dictionaryhy
hy-AM
-
id-idIndonesia dictionary.id
id-ID
-
it-itItalian dictionary.it
it-IT
-
java 1Java dictionary.-java
julia 1Julia Dictionary-julia
k8s 1K8s dictionary.-yaml
kotlin 1Kotlin dictionary.-kotlin
laLatin dictionary.la
la-VA
-
latex 1LaTeX dictionary-latex
lorem-ipsum 1Lorem-ipsum dictionary.lorem
lorem-ipsum
-
lt-ltLithuanian dictionary.lt
lt-LT
-
lua 1Lua dictionary.-lua
lvLatvian dictionary.lv-
makefile 1Makefile dictionary.-makefile
mathematics-terms-us 2Mathematics Terms US dictionary.--
medical terms 2List of nearly 100,000 medical terms.
mime-typesMIME Types dictionary.
mkMacedonian dictionary.mk
mk-cyrl
-
mn-mnMongolian dictionary.mn
mn-MN
-
mnemonicsi86 Mnemonics dictionary for cspellc
cpp
h
hpp
monkeyc 1Monkey C dictionary.-monkeyc
nb-noNorwegian Bokmål dictionary.nb
nb-no
-
networking-terms 1Software networking terms dictionary.
nl-nlDutch (Netherlands) Dictionarynl
nl-NL
-
node 1Node.js dictionary.-javascript
javascriptreact
typescript
typescriptreact
npm 1Dictionary of Common Javascript Packages.-javascript
javascriptreact
typescript
typescriptreact
people-names 2People Names dictionary.
php 1Php dictionary.-php
pl-plPolish Dictionarypl
pl_PL
-
pokemon 2Pokémon dictionary.
powershell 1PowerShell Keyword Dictionary-powershell
pt-brPortuguese (Brazilian) Dictionarypt
pt_BR
-
pt-ptPortuguese Dictionary (Portugal)pt
pt_PT
-
public-licenses 1 2Common Public Licenses dictionary.
python 1Python Dictionarypython
python-common 1Python Common Terms Dictionarypython
r 1R dictionary.-r
redisRedis dictionary.
ro-roRomanian dictionary.ro
ro-RO
-
ru-ruRussian Dictionary (Combined)ru
ru-ru
-
ruby 1For ruby and ruby on rails-ruby
ruby-gems 1For common ruby gems-ruby
rust 1Rust Keyword Dictionary-rust
rust-crates 1Common Rust Crates Dictionary-rust
scala 1Scala dictionary.-scala
scientific-terms-gbScientific Terms GB dictionary.en-GB-
scientific-terms-us 2Scientific Terms US dictionary.--
shellscript 1ShellScript dictionary.-shellscript
sk-skSlovak dictionary.sk-
sl-siSlovenian dictionary.sl
sl-SI
-
software-term-suggestions 1 2undefined
software-terms-alternative 1Alternative software terms dictionary.
software-tools 1 2Software tools dictionary.
softwareTerms 1 2Software terms dictionary.
sql 1SQL dictionary.-sql
sr-cyrlSerbian (Cyrillic) dictionary.sr
sr-Cyrl
-
sr-latnSerbian (Latin) dictionary.sr
sr-Latn
-
svSwedish Dictionarysv
sv_SE
-
svelte 1Svelte dictionary.-javascript
svelte
typescript
swift 1Swift dictionary.-swift
terraform 1Terraform dictionary.-terraform
tf
tfvars
tr-trTurkish dictionary.tr
tr-TR
-
typescript 1TypeScript and JavaScript dictionary.-astro
javascript
javascriptreact
mdx
...
uk-uaUkrainian Dictionaryuk-
vi-vnVietnamese dictionary.vi-
vimVim dictionary.
web-services 1 2Web Services and APIs dictionary.
win32Win32 dictionary.-c
cpp
zig 1Zig dictionary-zig
zon

1 Bundled with CSpell.
2 Dictionaries are enabled when packages is imported.

Documentation

See Documentation

Contributing

Please help correct any mistakes in the dictionaries.

See: Contributing

Special thanks to all of our amazing contributors!

Contributor Jason3S Contributor nschonni Contributor Kurt-von-Laven Contributor kevintraver Contributor digger-yu Contributor kenji-miyake Contributor Ki-er Contributor arkid15r Contributor rbalet Contributor phansys Contributor ccoVeille Contributor calvinballing Contributor anthony0030 Contributor spotlesscoder Contributor d2s Contributor JoshuaKGoldberg Contributor abdusabri Contributor btseee Contributor canarduck Contributor ScottWrightWTG Contributor cidrblock Contributor outdooracorn Contributor thompson-tomo Contributor SethFalco Contributor sghng Contributor tlindsay42 Contributor mfulton26 Contributor mrazauskas Contributor mwarres Contributor tas50 Contributor Zamiell Contributor AlekSi Contributor andyw8 Contributor ndac-todoroki Contributor simon-v-swyftx Contributor trentbl Contributor astorije Contributor jaycenhorton Contributor jim-hays-root Contributor mnemotic Contributor shaihu Contributor StyleShit Contributor viktorstrate Contributor crapStone Contributor hdahlheim Contributor sitch Contributor ssbarnea Contributor cjduncana Contributor dflock Contributor IvanGoncharov Contributor karlhorky Contributor Karolis2011 Contributor KrOstir Contributor LuizZak Contributor natescherer Contributor pzmarzly Contributor tobysmith568 Contributor alecmev Contributor awgeorge Contributor babyraging Contributor borjapazr Contributor david-fong Contributor Encephala Contributor fa0311 Contributor holtskinner Contributor jcgoette Contributor jordiolivares Contributor mad-gooze Contributor Maxim-Mazurok Contributor Nightblade Contributor TomAFrench Contributor treemmett Contributor VictorRos Contributor virzak Contributor asportnoy Contributor bentolor Contributor datafoo Contributor djmattyg007 Contributor dwenegar Contributor hiroya-uga Contributor inwardmovement Contributor jcfranco Contributor jsoref Contributor keith-oak Contributor Kissaki Contributor liby Contributor luke-underwood Contributor merlijn-sebrechts Contributor miodju Contributor mvilrokx Contributor OnkarRuikar Contributor scripthunter7 Contributor simonvanlierde Contributor tats-u Contributor trollixx Contributor ttasovac Contributor tvardero Contributor mtoohey31 Contributor 0xnmn Contributor ChocolateLoverRaj Contributor cylewaitforit Contributor INOMO-RKr Contributor KB-perByte Contributor koooge Contributor koviubi56 Contributor krzysiekwie Contributor lnasc256 Contributor magnushiie Contributor Majid110 Contributor mantasu Contributor marcalexiei Contributor markgaze Contributor martinlindhe Contributor matter123 Contributor MBehtemam Contributor mhasanmeet Contributor mhf-ir Contributor mmmarcos Contributor Mo-Gul Contributor msftenhanceprovenance Contributor niiccolas Contributor nlbuescher Contributor paaloeye Contributor pedro3g Contributor peteraritchie Contributor Peterdedecker Contributor plasticrake Contributor purplekeyboard Contributor rasa Contributor Real-Gecko Contributor revelt Contributor Rollcloud Contributor RotationMatrix Contributor roydukkey Contributor sasaking-k Contributor sennpang Contributor shanefontaine Contributor sheldonhull Contributor sherpalabsio Contributor smara-codes Contributor snyk-bot Contributor thakyZ Contributor thegraffix Contributor vineyardbovines Contributor wavygecko Contributor yf-yang Contributor adam-zielonka Contributor ADTC Contributor afifvdin Contributor AhmedAlaa4611 Contributor alcapitan Contributor AlnisS Contributor andrewdavid48 Contributor andreww2012 Contributor Androlax2 Contributor arledesma Contributor asktree Contributor ava57r Contributor Boshkovski-David Contributor brandonching Contributor carlocorradini Contributor carmenbianca Contributor chrisdecker1201 Contributor claudiu-cristea Contributor CsatiZoltan Contributor d-corler Contributor dalindev Contributor daniel-mackenzie Contributor davidmh Contributor DCsunset Contributor dimitropoulos Contributor Fydon Contributor izzqz Contributor jpbernius Contributor MarsDoge Contributor pepelsbey Contributor rabchev Contributor RH-TLagrone Contributor snelling-a Contributor spenserblack Contributor spiftire Contributor ssr-yuki Contributor teddybradford Contributor the-chris-strange Contributor thehappydinoa Contributor theogf Contributor ThomasMConnors Contributor ThomasNieto Contributor tobiasdiez Contributor tueda Contributor varonix0 Contributor vitaliytv Contributor Yizack Contributor zdposter Contributor zhenzhenChange Contributor zilayo Contributor aradalvand Contributor azat-io Contributor badouralix Contributor Billzabob Contributor BoltonBailey Contributor builtbyproxy Contributor dcvikl Contributor DHayk87 Contributor drwpow Contributor edwardwilson Contributor el-ethan Contributor Eldemarkki Contributor Fcmam5 Contributor fmachadopiriz Contributor GeorchW Contributor greysk Contributor HansRobo Contributor HarryAllen1 Contributor iainbeeston Contributor IanG Contributor jakezatecky Contributor janosh Contributor jimdiroffii Contributor jmfederico Contributor jntesteves Contributor jorispoppe Contributor kseino Contributor lauraBaakman Contributor lee0c Contributor lukasfro Contributor ndthanhdev Contributor NutCr4cker12 Contributor PaperbagWriter Contributor Poikilos Contributor rdsedmundo Contributor stratusjerry Contributor TakumaKurosawa Contributor verythorough Contributor Zereges Contributor andrewmurraydavid Contributor brmonaghan Contributor ctimmortal Contributor DanielHougaard Contributor j-ans1 Contributor LucasOe Contributor nomadsherpa Contributor pbrit Contributor smaraf Contributor thenamankumar Contributor uncenter

How to create a new dictionary

Please fork this repository to add new dictionaries.

Enable Corepack

See: Corepack

corepack enable

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 pnpm to make sure everything is installed.

pnpm i
pnpm run setup

Run create-dictionary to start the Yeoman script.

pnpm create-dictionary

or

pnpm create-dictionary <name> <path/to/source/words>

Yeoman will ask you a series of questions:

FieldDescription
namethis is the dictionary. i.e. en_AU or ruby
friendly namethis is the friendly name, like Australian
descriptionshort description of the dictionary.
source filethis 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.
localethis is the two letter language code with an optional cultural code. a * mean it will match any language. More than one locale can be added by separating them with a comma. i.e. en, en_AU.
languageIdthis 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 triefor large source files (> 1MB) or hunspell files, this should be y. n will work for all programming language keyword files.
run buildprepare the word list so it can be used by cspell efficiently. You can always run the build step yourself in the dictionary directory pnpm 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.

Verify with cspell
  • Install cspell: npm install -g cspell
  • Check the global links: cspell link list
  • Check a file: cspell check <path/to/source/file.ext> [--locale=<locale>] [--language-id=<filetype>] Example: cspell check README.md --locale=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):

image

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 Logo Street Side Software