textlint-rule-a3rt-proofreading-v2

リクルートの提供する文章校閲APIの、Proofreading APIIを使ったtextlintプラグインです。

textlint-rule-a3rt-proofreadingがドメインの変更などで動かなっていたので、新たに参考にさせていただいて作りました。

Install

Install with npm:

npm install textlint-rule-a3rt-proofreading-v2

Usage

Installation

Via .textlintrc(Recommended)

{
  "rules": {
    "a3rt-proofreading-v2": {
      "apiKey": "./path/to/key.yaml"
    }
  }
}

Get API Key from Proofreading API

And set yaml like below.

version: 1
rules:
  apiKey: 'APIKEY'

Check rules

Via CLI

textlint --rule a3rt-proofreading-v2 README.md

Build

Builds source codes for publish to the lib folder. You can write ES2015+ source codes in src/ folder.

npm run build

Tests

Run test code in test folder. Test textlint rule by textlint-tester.

npm test

License

MIT ©