JSPM

  • Created
  • Published
  • Downloads 375
  • Score
    100M100P100Q107985F
  • License MIT

Tools to assist with the development of cSpell

Package Exports

  • cspell-tools

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

Build Status

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

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.