https://github.com/textlint-rule/textlint-rule-ginger

textlint rule to check your English grammar with Ginger Proofreading
https://github.com/textlint-rule/textlint-rule-ginger

english-grammar textlint textlint-rule

Last synced: 2 months ago
JSON representation

textlint rule to check your English grammar with Ginger Proofreading

• Host: GitHub
• URL: https://github.com/textlint-rule/textlint-rule-ginger
• Owner: textlint-rule
• Created: 2016-03-16T14:41:44.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2022-06-07T12:29:51.000Z (about 3 years ago)
• Last Synced: 2025-04-23T01:15:08.991Z (2 months ago)
• Topics: english-grammar, textlint, textlint-rule
• Language: JavaScript
• Homepage:
• Size: 81.1 KB
• Stars: 6
• Watchers: 3
• Forks: 3
• Open Issues: 9
• Metadata Files:
  • Readme: ReadMe.md

Awesome Lists containing this project

README

        
# textlint-rule-ginger

[![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/)

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

[![Build Status](https://travis-ci.org/textlint-rule/textlint-rule-ginger.svg?branch=master)](https://travis-ci.org/textlint-rule/textlint-rule-ginger)

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

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

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

to check your English grammar with [Ginger Proofreading](http://www.gingersoftware.com/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](https://github.com/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](https://github.com/textlint/regexp-string-matcher#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/)