@textlint-rule/textlint-rule-gramma

textlint rule for gramma/LanguageTool/GrammarBot.

This rule is frontend of gramma.

Install

Install with npm:

npm install @textlint-rule/textlint-rule-gramma

Usage

Via .textlintrc(Recommended)

{
  "rules": {
    "@textlint-rule/gramma": true
  }
}

Via CLI

textlint --rule @textlint-rule/gramma README.md

Options

Same to gramma's options. It means that send your text to remote server like grammarbot.io or languagetool.org by default.

• api_url - url to a non-default API server
• api_key - server API key
• dictionary - an array of words that should be whitelisted
• language - language code to specify the text language
• rules - object defining which rules should be disabled

Example, use local server.

{
  "rules": {
    "@textlint-rule/gramma": {
      "api_url": "http://localhost:8081/v2/check"
    }
  }
}

📝 You need to start local API server by following before linting text.

npm install gramma --global
npx gramma server install
npx gramma servert start
# stop server
# npx gramma servert stop

Changelog

See Releases page.

Running tests

yarn install
yarn bootstrap
yarn test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

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
• twitter/azu_re

License

MIT © azu