@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"
}
}
}
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.
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
Author
License
MIT © azu