# retext-spell-file

> retext-spell with .respell personal dictionary file support

Latest version **0.0.3** (published 2020-06-25) · BlueOak-1.0.0 license · 0 weekly downloads

## Install

```sh
npm install retext-spell-file
pnpm add retext-spell-file
yarn add retext-spell-file
bun add retext-spell-file
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-06-25 |
| First published | 2020-06-24 |
| Weekly downloads | 0 |
| License | BlueOak-1.0.0 |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 5.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | Sean Leather |
| Maintainers | prokopton |
| Keywords | unified, retext-plugin, retext, plugin, spelling, correct, checker, spell, fix, autocorrect |

## Links

- npm: https://www.npmjs.com/package/retext-spell-file
- Repository: https://github.com/stoicism-compendium/retext-spell-file
- Homepage: https://github.com/stoicism-compendium/retext-spell-file#readme
- Issues: https://github.com/stoicism-compendium/retext-spell-file/issues
- npm.io page: https://npm.io/package/retext-spell-file

## Dependencies (2)

- [find-up](https://npm.io/package/find-up.md) ^4.1.0
- [retext-spell](https://npm.io/package/retext-spell.md) ^4.0.0

## Recent versions

- 0.0.3 (latest) — 2020-06-25
- 0.0.1 — 2020-06-24

## README

# retext-spell-file

<!-- Badges -->

![test][test-badge]

<!-- Brief description -->

_**`retext-spell` with `.respell` personal dictionary file support.**_

This package provides the exact same interface and functionality as
[`retext-spell`][retext-spell] with one small but useful modification.

1. **`retext-spell`** takes a **`personal`** option, which is a string of lines,
   in which each line is an entry in an [Hunspell][hunspell] **personal
   dictionary** (a.k.a. word list).

2. **`retext-spell-file`** also takes a `personal` option. But if that
   `personal` option is falsy, it will search up the directory hierarchy for a
   file named **`.respell`** and read its (UTF-8) contents into a value that is
   passed to `retext-spell` in the `personal` option.

<!-- Sections -->

## Installation

Follow the [`retext-spell`][retext-spell] installation instructions but replace
`retext-spell` with `retext-spell-file`.

## Usage

1. Refer to the [`retext-spell`][retext-spell] usage instructions but replace
   `retext-spell` with `retext-spell-file`.
2. Leave `options.personal` undefined.
3. Add a file named `.respell` to the top level of your project.
4. Add one correctly spelled word per line to `.respell`.

For more information:

* See [hunspell(5)][hunspell-man] for the **personal dictionary format**.
* See our [`.respell`](./.respell) for an example.

## License

[Blue Oak Model License 1.0.0][license] © [Sean Leather][author]

<!-- Definitions, sorted alphabetically -->

[author]: https://github.com/spl
[hunspell-man]: https://www.manpagez.com/man/5/hunspell/
[hunspell]: https://hunspell.github.io/
[license]: ./license.md
[retext-spell]: https://github.com/retextjs/retext-spell
[test-badge]: https://github.com/stoicism-compendium/retext-spell-file/workflows/test/badge.svg

---
_Source: https://npm.io/package/retext-spell-file · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._