cspell-tools-cli generates dictionary files supporting some of the features in CSpell 5 that are not in CSpell 4.
Features
Case and accent checking (strict vs loose).
Complex terms like Good4Business or AA_dont_blend are kept as a single terms
instead of being broken up into separate words.
Helping out
Choose your favorite dictionary and follow the steps below.
Please, only one dictionary per PR.
Steps for general lists and programming languages
Bump the version in package.json to the next major version since we do NOT want to include the change in a CSpell 4 installation.
package.json in scripts change cspell-tools to cspell-tools-cli
Add --split if the source file contains spaces.
This is important for dictionaries like the companies dictionary.
Add --keep-raw-case to programming language dictionaries. This option tells the tool to NOT generate
lower case versions of each entry. In most cases, leaving this option off is ok.
Task Upgrade Dictionaries
cspell-tools-cli
generates dictionary files supporting some of the features in CSpell 5 that are not in CSpell 4.Features
Good4Business
orAA_dont_blend
are kept as a single terms instead of being broken up into separate words.Helping out
Steps for general lists and programming languages
version
inpackage.json
to the next major version since we do NOT want to include the change in a CSpell 4 installation.package.json
inscripts
changecspell-tools
tocspell-tools-cli
--split
if the source file contains spaces. This is important for dictionaries like thecompanies
dictionary.--keep-raw-case
to programming language dictionaries. This option tells the tool to NOT generate lower case versions of each entry. In most cases, leaving this option off is ok.pnpm run build
to build the dictionary.pnpm run test
to make sure it has worked.Steps for Natural languages
Please take a look at German
package.json
as an example.version
inpackage.json
to the next major version since we do NOT want to include the change in a CSpell 4 installation.package.json
inscripts
changecspell-tools
tocspell-tools-cli compile --trie3 -x compound ...
--trie3
- tells it to use the latesttrie
file format for optimal storage.-x compound
tells it to support theHunspell
compounds.pnpm run build
to build the dictionary - this might take a long time.pnpm run test
to make sure it has worked.Dictionaries
Command Use to generate table: