textlint-rule-ginger


textlint rule
to check your English grammar with Ginger Proofreading.

Installation

``
$ npm install textlint-rule-ginger
`

Usage

`
$ npm install textlint textlint-rule-ginger
$ textlint --rule textlint-rule-ginger text-to-proofread.txt
`

Options

* skipPatterns: string[]
* Set skip pattern that is detected by @textlint/regexp-string-matcher

You can set regexp-like string as skip patterns.

For more details about regexp-like string, please see RegExp-like String

`json
{
"rule": {
"ginger": {
"skipPatterns": ["/JavaScript/i"]
}
}
}
`

Tests

`
npm test
`

Contribution

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

License

MIT License (http://nodaguti.mit-license.org/)