textlint-rule-ja-yahoo-kousei

textlint-rule-ja-yahoo-kousei

textlint rule that using Yahoo Proofreading API.

Installation

$ npm install textlint-rule-ja-yahoo-kousei

Usage

$ npm install -g textlint textlint-rule-ja-yahoo-kousei

Should get Yahoo Application ID here. And set YAHOO_APP_ID.

$ export YAHOO_APP_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx

or set in .textlintrc.

{
  "rules": {
    "textlint-rule-ja-yahoo-kousei": {
      'appID': 'xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx'
    }
  }
}

run.

$ textlint --rule textlint-rule-ja-yahoo-kousei README.md

Config

You can set words that ignore.

{
  "rules": {
    "textlint-rule-ja-yahoo-kousei": {
      'ignores': {
        '用字':['彼方']
      }
    }
  }
}

or use wildcard;

{
  "rules": {
    "textlint-rule-ja-yahoo-kousei": {
      'ignores': {
        '用字': '*'
      }
    }
  }
}

Example

TODO

Tests

$ export YAHOO_APP_ID=xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
$ npm test

License

MIT