Skip to content

Commit

Permalink
fix: make sure cspell-tools does not collide with old version.
Browse files Browse the repository at this point in the history
  • Loading branch information
Jason3S committed Jun 11, 2021
1 parent 640e824 commit 00e360c
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
8 changes: 4 additions & 4 deletions packages/cspell-tools/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,27 +7,27 @@ The Primary use of this tool is to build dictionaries used by cspell. This tool
## Install

```sh
npm install -g cspell-tools
npm install -g @cspell/cspell-tools
```

## Usage

```sh
cspell-tools --help
cspell-tools-cli --help
```

To create a word list.

```sh
cspell-tools compile keywords.txt -o ./dictionaries/
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 compile-trie english.dic
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`
Expand Down
2 changes: 1 addition & 1 deletion packages/cspell-tools/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
"access": "public"
},
"bin": {
"cspell-tools": "bin.js"
"cspell-tools-cli": "bin.js"
},
"scripts": {
"build": "tsc -p .",
Expand Down

0 comments on commit 00e360c

Please sign in to comment.