Skip to content
[Unofficial] textlint rule that using A3RT Proofreading API.
JavaScript
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci
example
src
test
.eslintrc
.gitignore
LICENSE
README.md
package-lock.json
package.json

README.md

textlint-rule-a3rt-proofreading

CircleCI

textlint rule that using A3RT Proofreading API.

A3RT Proofreading API

https://a3rt.recruit-tech.co.jp/product/proofreadingAPI/

The Proofreading API uses LSTM to detect suspicious places as sentences. The model learns the composition of the correct sentences, grammar, word flow from a large amount of Japanese job offer sentence data. Discover spelling errors in abnormality detection.

This package is A3RT's UNOFFICIAL.

Installation

$ npm i textlint-rule-a3rt-proofreading --save

Usage

Get the A3RT proofreading api key here. And set A3RT_APIKEY.

$ export A3RT_APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

or set in .textlintrc.

{
  "rules": {
    "a3rt-proofreading": {
      "apikey": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
    }
  }
}

run.

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

Config

You can set check sensitivity low / medium / high.

set in .textlintrc.

{
  "rules": {
    "a3rt-proofreading": {
      "sensitivity": "low"
    }
  }
}

Example

See example/ directory.

$ cd example/
$ npm i
$ npm run lint

Tests

$ export A3RT_APIKEY=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
$ npm test

License

MIT

You can’t perform that action at this time.