https://github.com/textlint-rule/textlint-rule-write-good

textlint rule to check your English styles with write-good
https://github.com/textlint-rule/textlint-rule-write-good

english-grammar textlint textlint-rule

Last synced: 3 months ago
JSON representation

textlint rule to check your English styles with write-good

• Host: GitHub
• URL: https://github.com/textlint-rule/textlint-rule-write-good
• Owner: textlint-rule
• Created: 2016-03-16T15:19:41.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-11-18T22:44:46.000Z (7 months ago)
• Last Synced: 2025-03-31T07:08:59.252Z (3 months ago)
• Topics: english-grammar, textlint, textlint-rule
• Language: JavaScript
• Homepage:
• Size: 943 KB
• Stars: 17
• Watchers: 4
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
# textlint-rule-write-good

[![npm](https://img.shields.io/npm/v/textlint-rule-write-good.svg)](https://www.npmjs.com/package/textlint-rule-write-good)

[![Actions Status: test](https://github.com/textlint-rule/textlint-rule-write-good/workflows/test/badge.svg)](https://github.com/textlint-rule/textlint-rule-write-good/actions?query=workflow%3A"test")

[![Dependency Status](https://david-dm.org/textlint-rule/textlint-rule-write-good.svg)](https://david-dm.org/textlint-rule/textlint-rule-write-good)

[![devDependency Status](https://david-dm.org/textlint-rule/textlint-rule-write-good/dev-status.svg)](https://david-dm.org/textlint-rule/textlint-rule-write-good#info=devDependencies)

[textlint](https://github.com/textlint/textlint) rule

to check your English writing styles with [btford/write-good](https://github.com/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`](https://github.com/btford/write-good#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](https://github.com/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/)