textlint-rule-write-good

textlint rule to check your English style with write good

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
textlint-rule-write-good
1732.0.03 years ago8 years agoMinified + gzip package size for textlint-rule-write-good in KB

Readme

textlint-rule-write-good
npm Actions Status: test Dependency Status devDependency Status
textlint rule to check your English writing styles with btford/write-good.

Installation

$ npm install textlint-rule-write-good

Usage

$ npm install textlint textlint-rule-write-good
$ textlint --rule textlint-rule-write-good some-text-to-proofread.txt

Options

All checks except for eprime are enabled by default.
You can disable each type of checks by passing false in .textlintrc.
{
  "rules": {
    "write-good": {
      "passive": false,
      "thereIs": false
    }
  }
}

For available checks, please refer to btford/write-good#checks.

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/)