hunspell-reader/README.md

A library for reading Hunspell Dictionary Files

# hunspell-reader

A library for reading Hunspell Dictionary files

## Application

This reader can be used as a tool for converting Hunspell files into a simple text file
with one word per line.

### Installation

```
npm install -g hunspell-reader
```

### Usage

It has basic command line help.

```
hunspell-reader words --help
```

Outputs:

```

  Usage: words [options] <hunspell_dic_file>

  Output all the words in the <hunspell.dic> file.

  Options:

    -h, --help           output usage information
    -o, --output <file>  output file - defaults to stdout
    -s, --sort           sort the list of words
    -u, --unique         make sure the words are unique.
    -i, --ignore_case    used with --unique and --sort
    -l, --lower_case     output in lower case
    -T, --no-transform   Do not apply the prefix and suffix transforms.  Root words only.

```

### Converting Hunspell to word list

To convert a Hunspell dictionary to a word list, you will need both the `.dic` and `.aff` files.
For example en_US comes with two files: `en_US.dic` and `en_US.aff`.
This tool assumes they are both in the same directory.

Assuming these files are in the current directory, the following command will write the words
to `en_US.txt`.

```
hunspell-reader words ./en_US.dic -o en_US.txt
```

## Library Functions

### Installation

```
npm install hunspell-reader
```

### Usage

Typescript / Javascript:

<!--- @@inject: ./example-code/example.js --->

```js
// ts-check
import { HunspellReader } from 'hunspell-reader';

const baseFile = 'en_US';
const dicFile = baseFile + '.dic';
const affFile = baseFile + '.aff';

// Initialize the reader with the Hunspell files
const reader = await HunspellReader.createFromFiles(affFile, dicFile);

// Get the words as an array
const words = [...reader];
console.log('%o', words);
```

<!--- @@inject-end: ./example-code/example.js --->

## Reference

- [Hunspell Docs](https://github.com/hunspell/hunspell/blob/master/docs/hunspell.5.md)

## CSpell for Enterprise

<!--- @@inject: ../../static/tidelift.md --->

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)

<!--- @@inject-end: ../../static/tidelift.md --->

<!--- @@inject: ../../static/footer.md --->

<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>

<!--- @@inject-end: ../../static/footer.md --->