Package Exports

cspell-tools
cspell-tools/bin.mjs

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (cspell-tools) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CSpell-Tools

Tools used to assist CSpell Development.

The Primary use of this tool is to build dictionaries used by cspell. This tool will convert a word list or a hunspell file into a file usable by cspell.

This package is an alias for @cspell/cspell-tools.

Install

npm install -g cspell-tools

Usage

cspell-tools --help

To create a word list.

cspell-tools compile keywords.txt -o ./dictionaries/

This will filter the words from keywords.txt and write them to ./dictionaries/keywords.txt.gz.

To create a trie file from a hunspell file.

cspell-tools compile-trie english.dic

This will read and expand the english.dic file based upon the rules in english.aff into a new file called english.trie.gz

For large files, this process can take a long time and us a lot of memory.

The tool cspell-trie can be used to read the contents of a .trie or .trie.gz file.

CSpell for Enterprise

Available as part of the Tidelift Subscription.

The maintainers of cspell and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. Learn more.

Brought to you by Street Side Software Logo Street Side Software