@cspell/cspell-tools

Version:

Tools to assist with the development of cSpell

github.com/streetsidesoftware/cspell/tree/main/packages/cspell-tools

58 lines (33 loc) • 1.85 kB

Markdown

# 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. ## Install ```sh npm install -g @cspell/cspell-tools ``` ## Usage ```sh cspell-tools-cli --help ``` To create a word list. ```sh cspell-tools-cli 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. ```sh cspell-tools-cli 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.](https://tidelift.com/subscription/pkg/npm-cspell?utm_source=npm-cspell&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)   <br/> --- <p align="center">Brought to you by<a href="https://streetsidesoftware.com" title="Street Side Software"><img width="16" alt="Street Side Software Logo" src="https://i.imgur.com/CyduuVY.png" /> Street Side Software</a></p>