Installations
npm install @cspell/dict-cspell-bundle
Developer Guide
Typescript
No
Module System
ESM
Node Version
22.13.0
NPM Version
lerna/3.11.0/node@v22.13.0+x64 (linux)
Releases
@cspell/dict-npm: v5.1.24
Published on 26 Jan 2025
@cspell/dict-google: v1.0.8
Published on 26 Jan 2025
@cspell/dict-cspell-bundle: v1.0.28
Published on 26 Jan 2025
cspell-dicts: v28.8.4
Published on 26 Jan 2025
@cspell/dict-software-terms: v4.2.4
Published on 18 Jan 2025
@cspell/dict-google: v1.0.7
Published on 18 Jan 2025
Contributors
Languages
TeX (33.03%)
JavaScript (14.77%)
R (9.55%)
Python (8.75%)
Ada (7.54%)
C++ (6.23%)
F# (4.42%)
TypeScript (3.45%)
Shell (2.18%)
Makefile (1.59%)
PowerShell (1.41%)
C (1.34%)
Swift (0.95%)
Kotlin (0.83%)
Go (0.82%)
Svelte (0.77%)
jq (0.38%)
Java (0.34%)
Emacs Lisp (0.29%)
C# (0.27%)
AL (0.26%)
Dart (0.25%)
Julia (0.23%)
HCL (0.11%)
Haskell (0.07%)
CSS (0.07%)
Dockerfile (0.04%)
Perl (0.03%)
Astro (0.03%)
Developer
streetsidesoftware
Download Statistics
Total Downloads
14,588
Last Day
94
Last Week
498
Last Month
3,909
Last Year
14,588
GitHub Statistics
232 Stars
3,944 Commits
214 Forks
6 Watching
4 Branches
199 Contributors
Package Meta Information
Latest Version
1.0.28
Package Id
@cspell/dict-cspell-bundle@1.0.28
Unpacked Size
9.50 kB
Size
2.79 kB
File Count
4
NPM Version
lerna/3.11.0/node@v22.13.0+x64 (linux)
Node Version
22.13.0
Publised On
26 Jan 2025
Total Downloads
Cumulative downloads
Total Downloads
14,588
Last day
683.3%
94
Compared to previous day
Last week
-32%
498
Compared to previous week
Last month
-14.5%
3,909
Compared to previous month
Last year
0%
14,588
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
54
cspell-dicts
Various cspell dictionaries. Each dictionary is its own package. See README.md
in each directory.
Support Future Development
Natural Language Dictionaries
- Ancient Greek - Ancient Greek dictionary.
- Arabic - Arabic dictionary.
- Austrian German Dictionary - Austrian German (de-AT) Dictionary.
- Basque - Basque dictionary.
- Bulgarian - Bulgarian dictionary.
- Catalan - Catalan dictionary.
- Croatian - Croatian dictionary.
- Czech - Czech dictionary.
- Danish Dictionary - Danish (da-DK) Dictionary.
- Dutch (Netherlands) Dictionary - Dutch (Netherlands) Dictionary
- English - American - American English Dictionary 1
- English - Australian - Australian English Dictionary
- English - British - British English Dictionary 1
- English - British (Limited) - British English Dictionary with MIT License
- English - Canadian - Canadian English Dictionary
- English - Common Misspellings - Common English misspellings dictionary. 1
- English - Shared - English words shared between the various English dictionaries.
- Esperanto - Esperanto dictionary.
- Estonian - Estonian dictionary.
- Finnish - Finnish dictionary.
- Français Réforme 1990 - Français Réforme 1990 dictionary.
- French Dictionary (France) - French Dictionary (France)
- German Dictionary - German (de-DE) Dictionary.
- Greek - Greek dictionary.
- Hebrew Dictionary - Hebrew Dictionary
- Hungarian - Hungarian dictionary.
- Indonesia - Indonesia dictionary.
- Italian - Italian dictionary.
- Latin - Latin dictionary.
- Latvian - Latvian dictionary.
- Lithuanian - Lithuanian dictionary.
- Lorem-ipsum - Lorem-ipsum dictionary. 1
- Macedonian - Macedonian dictionary.
- Norwegian Bokmål - Norwegian Bokmål dictionary.
- Persian Dictionary - Persian Dictionary
- Polish Dictionary - Polish Dictionary
- Portuguese (Brazilian) Dictionary - Portuguese (Brazilian) Dictionary
- Portuguese Dictionary (Portugal) - Portuguese Dictionary (Portugal)
- Romanian - Romanian dictionary.
- Russian Dictionary (Combined) - Russian Dictionary (Combined)
- Scientific Terms GB - Scientific Terms GB dictionary.
- Serbian (Cyrillic) - Serbian (Cyrillic) dictionary.
- Serbian (Latin) - Serbian (Latin) dictionary.
- Slovak - Slovak dictionary.
- Slovenian - Slovenian dictionary.
- Spanish Dictionary (Spain) - Spanish Dictionary (Spain)
- Swedish Dictionary - Swedish Dictionary
- Swiss German Dictionary - Swiss German (de-CH) Dictionary.
- Turkish - Turkish dictionary.
- Ukrainian Dictionary - Ukrainian Dictionary
- Vietnamese - Vietnamese dictionary.
Programming Dictionaries
- .Net - .Net keywords Dictionary. 1
- Ada - Ada Language Dictionary 1
- AL - AL (Microsoft Business Central) 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
- 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
- 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
- Win32 - Win32 dictionary.
Specialized Dictionaries
- AWS - AWS dictionary. 1 2
- bash - Bash dictionary. 1
- Cities of Finland - List of cities in Finland. 2
- Common Public Licenses - Common Public Licenses dictionary. 1 2
- Company names - Company names dictionary. 1 2
- Cryptocurrencies - Cryptocurrencies dictionary. 1 2
- File Types - File types dictionary. 1 2
- Font Names - Font names dictionary. 1
- Gaming - Gaming dictionary. 1
- GIS and PostGIS - GIS and PostGIS dictionary.
- Git - CSpell configuration for GIT 1
- Google Cloud - Google Cloud Development Dictionary. 1
- Markdown - Markdown dictionary. 1
- Medical terms - Medical Terms Dictionary 2
- People Names - People Names dictionary. 2
- Pokémon - Pokémon dictionary. 2
- Redis - Redis dictionary.
- Scientific Terms US - Scientific Terms US dictionary. 2
- Software Terms - Software terms dictionary. 1 2
- Vim - Vim developers dictionary.
- Vue - CSpell configuration for VUE files 1
Dictionary Bundles
- CSpell Dictionaries Bundle - Dictionaries included with the CSpell Command Line tool.
1 Bundled with CSpell.
2 Dictionaries are enabled when packages is imported.
All Dictionaries
Package | Name | Dictionary IDs |
---|---|---|
@cspell/dict-ada1 | Ada | ada |
@cspell/dict-al1 | AL | al |
@cspell/dict-ar | Arabic | ar |
@cspell/dict-aws1 | AWS | aws2 |
@cspell/dict-bash1 | bash | |
@cspell/dict-bg-bg | Bulgarian | bg-bg |
@cspell/dict-ca | Catalan | ca |
@cspell/dict-city-names-finland | Cities of Finland | city-names-finland2 |
@cspell/dict-clojure | Clojure | clojure |
@cspell/dict-companies1 | Company names | companies2 |
@cspell/dict-cpp1 | C/C++ | cpp-legacy cpp cpp-refined |
@cspell/dict-cryptocurrencies1 | Cryptocurrencies | cryptocurrencies2 cryptocurrencies-legacy |
@cspell/dict-cs-cz | Czech | cs-cz |
@cspell/dict-csharp1 | C# | csharp |
@cspell/dict-cspell-bundle | CSpell Dictionaries Bundle | |
@cspell/dict-css1 | CSS | css |
@cspell/dict-da-dk | Danish Dictionary | da-dk |
@cspell/dict-dart1 | Dart | dart |
@cspell/dict-data-science1 | Data Science | data-science data-science-models data-science-tools |
@cspell/dict-de-at | Austrian German Dictionary | de-at |
@cspell/dict-de-ch | Swiss German Dictionary | de-ch |
@cspell/dict-de-de | German Dictionary | de-de |
@cspell/dict-django1 | Django | django |
@cspell/dict-docker1 | Docker | docker |
@cspell/dict-dotnet1 | .Net | dotnet |
@cspell/dict-el | Greek | el |
@cspell/dict-elisp | Emacs Lisp | elisp |
@cspell/dict-elixir1 | Elixir | elixir |
@cspell/dict-en_us1 | English - American | en_us |
@cspell/dict-en-au | English - Australian | en-au |
@cspell/dict-en-ca | English - Canadian | en-ca |
@cspell/dict-en-common-misspellings1 | English - Common Misspellings | en-common-misspellings en-gb-common-misspellings en-us-common-misspellings |
@cspell/dict-en-gb1 | English - British | en-gb |
@cspell/dict-en-gb-mit | English - British (Limited) | en-gb-mit |
@cspell/dict-en-shared | English - Shared | en-shared |
@cspell/dict-eo | Esperanto | eo |
@cspell/dict-es-es | Spanish Dictionary (Spain) | es-es |
@cspell/dict-et-ee | Estonian | et-ee |
@cspell/dict-eu | Basque | eu |
@cspell/dict-fa-ir | Persian Dictionary | fa-ir |
@cspell/dict-fi-fi | Finnish | fi-fi |
@cspell/dict-filetypes1 | File Types | filetypes2 |
@cspell/dict-flutter1 | Flutter | flutter |
@cspell/dict-fonts1 | Font Names | fonts |
@cspell/dict-fr-fr | French Dictionary (France) | fr-fr |
@cspell/dict-fr-reforme | Français Réforme 1990 | fr-fr-90 |
@cspell/dict-fsharp1 | F# | fsharp |
@cspell/dict-fullstack1 | Fullstack | fullstack |
@cspell/dict-gaming-terms1 | Gaming | gaming-terms game-development |
@cspell/dict-gis | GIS and PostGIS | gis |
@cspell/dict-git1 | Git | git |
@cspell/dict-golang1 | Go Language | golang |
@cspell/dict-google1 | Google Cloud | |
@cspell/dict-grc | Ancient Greek | grc |
@cspell/dict-haskell1 | Haskell | haskell |
@cspell/dict-he | Hebrew Dictionary | he |
@cspell/dict-hr-hr | Croatian | hr-hr |
@cspell/dict-html1 | HTML | html |
@cspell/dict-html-symbol-entities1 | HTML Symbol Entities | html-symbol-entities |
@cspell/dict-hu-hu | Hungarian | hu-hu |
@cspell/dict-id-id | Indonesia | id-id |
@cspell/dict-it-it | Italian | it-it |
@cspell/dict-java1 | Java | java |
@cspell/dict-julia1 | Julia | julia |
@cspell/dict-k8s1 | K8s | k8s |
@cspell/dict-kotlin1 | Kotlin | kotlin |
@cspell/dict-la | Latin | la |
@cspell/dict-latex1 | LaTeX | latex |
@cspell/dict-lorem-ipsum1 | Lorem-ipsum | lorem-ipsum |
@cspell/dict-lt-lt | Lithuanian | lt-lt |
@cspell/dict-lua1 | Lua | lua |
@cspell/dict-lv | Latvian | lv |
@cspell/dict-makefile1 | Makefile | makefile |
@cspell/dict-markdown1 | Markdown | |
@cspell/dict-medicalterms | Medical terms | medical terms2 |
@cspell/dict-mk | Macedonian | mk |
@cspell/dict-mnemonics | Mnemonics | mnemonics |
@cspell/dict-monkeyc1 | Monkey C | monkeyc |
@cspell/dict-nb-no | Norwegian Bokmål | nb-no |
@cspell/dict-nl-nl | Dutch (Netherlands) Dictionary | nl-nl |
@cspell/dict-node1 | Node.js | node |
@cspell/dict-npm1 | NPM | npm |
@cspell/dict-people-names | People Names | people-names2 |
@cspell/dict-php1 | PHP | php |
@cspell/dict-pl_pl | Polish Dictionary | pl-pl |
@cspell/dict-pokemon | Pokémon | pokemon2 |
@cspell/dict-powershell1 | PowerShell | powershell |
@cspell/dict-pt-br | Portuguese (Brazilian) Dictionary | pt-br |
@cspell/dict-pt-pt | Portuguese Dictionary (Portugal) | pt-pt |
@cspell/dict-public-licenses1 | Common Public Licenses | public-licenses2 |
@cspell/dict-python1 | Python | python python-common |
@cspell/dict-r1 | R | r |
@cspell/dict-redis | Redis | redis |
@cspell/dict-ro-ro | Romanian | ro-ro |
@cspell/dict-ru_ru | Russian Dictionary (Combined) | ru-ru |
@cspell/dict-ruby1 | Ruby | ruby |
@cspell/dict-rust1 | Rust | rust |
@cspell/dict-scala1 | Scala | scala |
@cspell/dict-scientific-terms-gb | Scientific Terms GB | scientific-terms-gb |
@cspell/dict-scientific-terms-us | Scientific Terms US | scientific-terms-us2 |
@cspell/dict-shell1 | ShellScript | bash shellscript |
@cspell/dict-sk-sk | Slovak | sk-sk |
@cspell/dict-sl-si | Slovenian | sl-si |
@cspell/dict-software-terms1 | Software Terms | software-term-suggestions2 softwareTerms2 networking-terms web-services2 computing-acronyms2 coding-compound-terms2 |
@cspell/dict-sql1 | SQL | sql |
@cspell/dict-sr-cyrl | Serbian (Cyrillic) | sr-cyrl |
@cspell/dict-sr-latn | Serbian (Latin) | sr-latn |
@cspell/dict-sv | Swedish Dictionary | sv |
@cspell/dict-svelte1 | Svelte | svelte |
@cspell/dict-swift1 | Swift | swift |
@cspell/dict-terraform1 | Terraform | terraform |
@cspell/dict-tr-tr | Turkish | tr-tr |
@cspell/dict-typescript1 | TypeScript/JavaScript | typescript |
@cspell/dict-uk-ua | Ukrainian Dictionary | uk-ua |
@cspell/dict-vi-vn | Vietnamese | vi-vn |
@cspell/dict-vim | Vim | vim |
@cspell/dict-vue1 | Vue | |
@cspell/dict-win32 | Win32 | win32 |
1 Bundled with CSpell.
2 Dictionaries are enabled when packages is imported.
Sorted by Dictionary Name IDs
Name ID | Description | Locale | File Type |
---|---|---|---|
ada 1 | Ada Language Dictionary | - | ada |
al 1 | AL Keywords Dictionary | - | al |
ar | Arabic dictionary. | ar | - |
aws 1 2 | AWS dictionary. | - | - |
bash 1 | Bash dictionary. | - | bashscript |
bg-bg | Bulgarian dictionary. | bg bg-BG | - |
ca | Catalan dictionary. | ca | - |
city-names-finland 2 | List of cities in Finland. | - | - |
clojure | Clojure dictionary. | - | clojure |
coding-compound-terms 1 2 | Common codding compound terms. | - | - |
companies 1 2 | Company names dictionary. | - | - |
computing-acronyms 1 2 | Common acronyms related to computing. | - | - |
cpp 1 | C/C++ Keywords and common library functions. | - | c cpp |
cpp-legacy 1 | Legacy C/C++ Keywords and common library functions. | - | c cpp |
cpp-refined 1 | Refined list of C/C++ Keywords and common library functions. | - | c cpp |
cryptocurrencies 1 2 | Cryptocurrencies dictionary. | - | - |
cryptocurrencies-legacy 1 | Legacy Cryptocurrency dictionary. | - | - |
cs-cz | Czech dictionary. | cs | - |
csharp 1 | C# dictionary. | - | csharp |
css 1 | Css dictionary. | - | css |
da-dk | Danish (da-DK) Dictionary. | da da-DK | - |
dart 1 | Dart dictionary. | - | dart |
data-science 1 | Data Science Terms dictionary. | - | python |
data-science-models 1 | Data Science Models dictionary. | - | python |
data-science-tools 1 | Data Science Tools dictionary. | - | python |
de-at | Austrian German (de-AT) Dictionary. | de_AT | - |
de-ch | Swiss German (de-CH) Dictionary. | de de_CH | - |
de-de | German (de-DE) Dictionary. | de de_DE | - |
django 1 | List of Python Django Framework keywords. | - | html python |
docker 1 | Docker dictionary. | - | dockerfile |
dotnet 1 | .Net keywords. | - | cs |
el | Greek dictionary. | el | - |
elisp | Emacs Lisp dictionary. | - | elisp lisp |
elixir 1 | Elixir dictionary. | - | elixir |
en_us 1 | American English Dictionary | en en-US | - |
en-au | Australian English Dictionary | en-AU | - |
en-ca | Canadian English Dictionary | en-CA | - |
en-common-misspellings 1 | undefined | en | - |
en-gb 1 | British English Dictionary | en-GB | - |
en-gb-common-misspellings 1 | undefined | en-gb | - |
en-gb-mit | British English Dictionary | en-GB | - |
en-shared | English words shared between the various English dictionaries. | en | - |
en-us-common-misspellings 1 | undefined | en-us | - |
eo | Esperanto dictionary. | eo | - |
es-es | Spanish Dictionary (Spain) | es es_ES | - |
et-ee | Estonian dictionary. | et et-EE | - |
eu | Basque dictionary. | eu | - |
fa-ir | Persian Dictionary | fa fa-IR | - |
fi-fi | Finnish dictionary. | fi fi-fi | - |
filetypes 1 2 | File types dictionary. | - | - |
flutter 1 | Flutter dictionary. | - | dart |
fonts 1 | Font names dictionary. | - | - |
fr-fr | French Dictionary (France) | fr fr_FR | - |
fr-fr-90 | Français Réforme 1990 dictionary. | fr fr-90 fr-fr | - |
fsharp 1 | F# dictionary. | - | fsharp |
fullstack 1 | Common words encountered during fullstack development | - | ada c cpp csharp ... |
game-development 1 | Game development dictionary. Includes Godot, Unity, and more terms. | - | - |
gaming-terms 1 | Gaming dictionary. | - | - |
gis | GIS and PostGIS dictionary. | - | - |
git 1 | Git Terms | - | - |
golang 1 | Go Language Dictionary | - | go |
google 1 | Google Cloud Development dictionary. | - | - |
grc | Ancient Greek dictionary. | el-GRC gr grc grc_GR | - |
haskell 1 | Haskell dictionary. | - | haskell |
he | Hebrew Dictionary | he | - |
hr-hr | Croatian dictionary. | hr hr-HR | - |
html 1 | HTML dictionary. | - | html |
html-symbol-entities 1 | HTML Symbol Entities Dictionary | - | html markdown |
hu-hu | Hungarian dictionary. | hu hu-hu | - |
id-id | Indonesia dictionary. | id id-ID | - |
it-it | Italian dictionary. | it it-IT | - |
java 1 | Java dictionary. | - | java |
julia 1 | Julia Dictionary | - | julia |
k8s 1 | K8s dictionary. | - | yaml |
kotlin 1 | Kotlin dictionary. | - | kotlin |
la | Latin dictionary. | la la-VA | - |
latex 1 | LaTeX dictionary | - | latex |
lorem-ipsum 1 | Lorem-ipsum dictionary. | lorem lorem-ipsum | - |
lt-lt | Lithuanian dictionary. | lt lt-LT | - |
lua 1 | Lua dictionary. | - | lua |
lv | Latvian dictionary. | lv | - |
makefile 1 | Makefile dictionary. | - | makefile |
medical terms 2 | List of nearly 100,000 medical terms. | - | - |
mk | Macedonian dictionary. | mk mk-cyrl | - |
mnemonics | i86 Mnemonics dictionary for cspell | - | c cpp h hpp |
monkeyc 1 | Monkey C dictionary. | - | monkeyc |
nb-no | Norwegian Bokmål dictionary. | nb nb-no | - |
networking-terms 1 | Software networking terms dictionary. | - | - |
nl-nl | Dutch (Netherlands) Dictionary | nl nl-NL | - |
node 1 | Node.js dictionary. | - | javascript javascriptreact typescript typescriptreact |
npm 1 | Dictionary of Common Javascript Packages. | - | javascript javascriptreact typescript typescriptreact |
people-names 2 | People Names dictionary. | - | - |
php 1 | Php dictionary. | - | php |
pl-pl | Polish Dictionary | pl pl_PL | - |
pokemon 2 | Pokémon dictionary. | - | - |
powershell 1 | PowerShell Keyword Dictionary | - | powershell |
pt-br | Portuguese (Brazilian) Dictionary | pt pt_BR | - |
pt-pt | Portuguese Dictionary (Portugal) | pt pt_PT | - |
public-licenses 1 2 | Common Public Licenses dictionary. | - | - |
python 1 | Python Dictionary | - | python |
python-common 1 | Python Common Terms Dictionary | - | python |
r 1 | R dictionary. | - | r |
redis | Redis dictionary. | - | - |
ro-ro | Romanian dictionary. | ro ro-RO | - |
ru-ru | Russian Dictionary (Combined) | ru ru-ru | - |
ruby 1 | For ruby and ruby on rails | - | ruby |
rust 1 | Rust Keyword Dictionary | - | rust |
scala 1 | Scala dictionary. | - | scala |
scientific-terms-gb | Scientific Terms GB dictionary. | en-GB | - |
scientific-terms-us 2 | Scientific Terms US dictionary. | - | - |
shellscript 1 | ShellScript dictionary. | - | shellscript |
sk-sk | Slovak dictionary. | sk | - |
sl-si | Slovenian dictionary. | sl sl-SI | - |
software-term-suggestions 1 2 | undefined | - | - |
softwareTerms 1 2 | Software terms dictionary. | - | - |
sql 1 | SQL dictionary. | - | sql |
sr-cyrl | Serbian (Cyrillic) dictionary. | sr sr-Cyrl | - |
sr-latn | Serbian (Latin) dictionary. | sr sr-Latn | - |
sv | Swedish Dictionary | sv sv_SE | - |
svelte 1 | Svelte dictionary. | - | javascript svelte typescript |
swift 1 | Swift dictionary. | - | swift |
terraform 1 | Terraform dictionary. | - | terraform tfvars |
tr-tr | Turkish dictionary. | tr tr-TR | - |
typescript 1 | TypeScript and JavaScript dictionary. | - | astro javascript javascriptreact mdx ... |
uk-ua | Ukrainian Dictionary | uk | - |
vi-vn | Vietnamese dictionary. | vi | - |
vim | Vim dictionary. | - | - |
web-services 1 2 | Web Services and APIs dictionary. | - | - |
win32 | Win32 dictionary. | - | c cpp |
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!
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.
1pnpm i 2pnpm run setup
Run create-dictionary
to start the Yeoman script.
1pnpm create-dictionary
or
1pnpm 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. |
locale | this 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. |
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 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
1cspell 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):
Clean up
Remember to unlink when you are done:
1cspell link remove ./cspell-ext.json
npm Global Install
From the dictionary directory:
1npm install -g
From NPM repository:
1npm 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
No vulnerabilities found.
Reason
30 commit(s) and 10 issue activity found in the last 90 days -- score normalized to 10
Reason
security policy file detected
Details
- Info: security policy file detected: SECURITY.md:1
- Info: Found linked content: SECURITY.md:1
- Info: Found disclosure, vulnerability, and/or timelines in security policy: SECURITY.md:1
- Info: Found text in security policy: SECURITY.md:1
Reason
no dangerous workflow patterns detected
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Warn: project license file does not contain an FSF or OSI license.
Reason
SAST tool detected but not run on all commits
Details
- Info: SAST configuration detected: CodeQL
- Warn: 25 commits out of 30 are checked with a SAST tool
Reason
4 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: PYSEC-2014-14 / GHSA-652x-xj99-gmcc
- Warn: Project is vulnerable to: GHSA-9wx4-h78v-vm56
- Warn: Project is vulnerable to: PYSEC-2014-13 / GHSA-cfj3-7x9c-4p3h
- Warn: Project is vulnerable to: PYSEC-2018-28 / GHSA-x84v-xcm2-53pg
Reason
Found 3/7 approved changesets -- score normalized to 4
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
detected GitHub workflow tokens with excessive permissions
Details
- Info: jobLevel 'actions' permission set to 'read': .github/workflows/codeql-analysis.yml:24
- Info: jobLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:25
- Info: topLevel 'contents' permission set to 'read': .github/workflows/build-dictionaries.yml:20
- Info: topLevel 'contents' permission set to 'read': .github/workflows/codeql-analysis.yml:18
- Info: topLevel 'contents' permission set to 'read': .github/workflows/cspell-action.yml:9
- Info: topLevel 'contents' permission set to 'read': .github/workflows/lint.yml:25
- Info: topLevel 'contents' permission set to 'read': .github/workflows/publish.yml:11
- Warn: topLevel 'contents' permission set to 'write': .github/workflows/release-please.yml:10
- Info: topLevel 'contents' permission set to 'read': .github/workflows/test.yml:9
- Info: topLevel 'contents' permission set to 'read': .github/workflows/update-dependabot.yml:15
- Info: topLevel 'contents' permission set to 'read': .github/workflows/update-dependencies.yml:16
- Info: topLevel 'contents' permission set to 'read': .github/workflows/update-dictionaries.yml:12
- Info: no jobLevel write permissions found
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
dependency not pinned by hash detected -- score normalized to 0
Details
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/build-dictionaries.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/build-dictionaries.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:40: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:55: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/codeql-analysis.yml:69: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/codeql-analysis.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/cspell-action.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/cspell-action.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/cspell-action.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/cspell-action.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:31: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/lint.yml:37: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/lint.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/publish.yml:19: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/publish.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/release-please.yml:20: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/release-please.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:50: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/test.yml:28: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/test.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-dependabot.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dependabot.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-dependabot.yml:35: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dependabot.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-dependabot.yml:51: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dependabot.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-dependencies.yml:27: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dependencies.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-dependencies.yml:52: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dependencies.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-dependencies.yml:58: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dependencies.yml/main?enable=pin
- Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/update-dictionaries.yml:23: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dictionaries.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-dictionaries.yml:44: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dictionaries.yml/main?enable=pin
- Warn: third-party GitHubAction not pinned by hash: .github/workflows/update-dictionaries.yml:49: update your workflow using https://app.stepsecurity.io/secureworkflow/streetsidesoftware/cspell-dicts/update-dictionaries.yml/main?enable=pin
- Warn: containerImage not pinned by hash: dictionaries/docker/samples/Dockerfile:2: pin your Docker image by updating node:14.21.3-alpine to node:14.21.3-alpine@sha256:434215b487a329c9e867202ff89e704d3a75e554822e07f3e0c0f9e606121b33
- Info: 0 out of 14 GitHub-owned GitHubAction dependencies pinned
- Info: 0 out of 8 third-party GitHubAction dependencies pinned
- Info: 0 out of 1 containerImage dependencies pinned
Score
6.1
/10
Last Scanned on 2025-01-27
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More