# textlint-rule-proofdict

> textlint rule check text using proofdict.

Latest version **2.0.4** (published 2018-03-18) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install textlint-rule-proofdict
pnpm add textlint-rule-proofdict
yarn add textlint-rule-proofdict
bun add textlint-rule-proofdict
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 2.0.4 |
| Published | 2018-03-18 |
| First published | 2017-08-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 8 |
| Unpacked size | 46.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | azu |
| Maintainers | azu |
| Keywords | textlintrule |

## Links

- npm: https://www.npmjs.com/package/textlint-rule-proofdict
- Repository: https://github.com/proofdict/textlint-rule-proofdict
- Issues: https://github.com/proofdict/textlint-rule-proofdict/issues
- npm.io page: https://npm.io/package/textlint-rule-proofdict

## Dependencies (8)

- [debug](https://npm.io/package/debug.md) ^3.1.0
- [url-join](https://npm.io/package/url-join.md) ^4.0.0
- [proofdict](https://npm.io/package/proofdict.md) ^1.2.1
- [fetch-ponyfill](https://npm.io/package/fetch-ponyfill.md) ^6.0.0
- [@types/url-join](https://npm.io/package/@types/url-join.md) ^0.8.2
- [proofdict-tester](https://npm.io/package/proofdict-tester.md) ^1.0.0
- [textlint-rule-helper](https://npm.io/package/textlint-rule-helper.md) ^2.0.0
- [localstorage-ponyfill](https://npm.io/package/localstorage-ponyfill.md) ^1.0.1

## Alternatives

- [eslint-plugin-sonarjs](https://npm.io/package/eslint-plugin-sonarjs.md) — 2.9M weekly downloads
- [eslint-config-expo](https://npm.io/package/eslint-config-expo.md) — 1.5M weekly downloads
- [@matter/protocol](https://npm.io/package/@matter/protocol.md) — 63.5K weekly downloads
- [@eventcatalog/linter](https://npm.io/package/@eventcatalog/linter.md) — 24.8K weekly downloads
- [@inrupt/eslint-config-base](https://npm.io/package/@inrupt/eslint-config-base.md) — 4.5K weekly downloads

## Recent versions

- 2.0.4 (latest) — 2018-03-18
- 2.0.3 — 2018-03-18
- 2.0.2 — 2018-03-18
- 2.0.1 — 2018-03-18
- 2.0.0 — 2018-03-02
- 1.0.2 — 2017-08-25
- 1.0.1 — 2017-08-23

## README

# textlint-rule-proofdict [![Build Status](https://travis-ci.org/proofdict/textlint-rule-proofdict.svg?branch=master)](https://travis-ci.org/proofdict/textlint-rule-proofdict) 

[textlint](https://github.com/textlint/textlint "textlint") rule check text using [proofdict](https://proofdict.github.io/proofdict/ "proofdict").

[proofdict](https://proofdict.github.io/proofdict/ "proofdict") is a opinionated dictionary. 

## Install

Install with [npm](https://www.npmjs.com/):

    npm install textlint-rule-proofdict

## Usage

Via `.textlintrc`(Recommended)

```json
{
    "rules": {
        "proofdict": {
          "dictURL": "https://azu.github.io/proof-dictionary/"
        }
    }
}
```

Via CLI

```
textlint --rule proofdict README.md
```

## Options

```json5
{
    // If you want to use live-proofdict
    // Proofdict-style dictionary URL
    // Example: "https://azu.github.io/proofdict/"
    // If you want to specific JSON end point, please pass object.
    // `dictURL; { jsonAPI: string, ruleBase: string }`
    "dictURL": undefined,
    // If you want to use local proofdict
    // dictPath is glob style path
    // TODO: Not implement yet
    "dictPath": undefined,
    // Default: 60sec(60 * 1000ms)
    "autoUpdateInterval": 60 * 1000,
    // = Tag settings
    // Filter dictionary by whitelist or blacklist
    // Default: Enable all terms of the dictionary.
    // When set both options, this rule prefer whitelist to blacklist
    "whitelistTags": [],
    "blacklistTags": [],
};
```

### `dictURL`

`dictURL` is required option.
You must set your dictionary website url.

For example, set `https://azu.github.io/proof-dictionary/` to `dictURL`.
This url fetch dictionary data from `https://azu.github.io/proof-dictionary/dictionary.json`.

If you want to custom API end point, pass object instead of string.

```json5.
"dictURL": { 
   "jsonAPI": "https://azu.github.io/proof-dictionary/custom-dict.json",
   "ruleBase": "https://azu.github.io/proof-dictionary/item/",
}
``` 

### Whitelist/Blacklist

This rule use [proofdict](https://proofdict.github.io/proofdict/ "proofdict") as the source of dictionary.

Each dictionary items has `tag`.

For example, [WebKit](https://proofdict.github.io/proofdict/item/01BQ92YZ6QR8RJKA5Y8W2F9NMY "WebKit") has `noun` tag.

You can setting enable/disable by `whitelistTags` and `blacklistTags`

e.g.) Enable only "noun" tag.

```json
{
    "rules": {
        "proofdict": {
          "whitelistTags": ["noun"]
        }
    }
}
```

e.g.) Use items without `"opinion"` tag

```json
{
    "rules": {
        "proofdict": {
          "blacklistTags": ["opinion"]
        }
    }
}
```

## Changelog

See [Releases page](https://github.com/proofdict/textlint-rule-proofdict/releases).

## Running tests

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/proofdict/textlint-rule-proofdict/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## License

MIT © azu

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