textlint-rule / textlint-rule-en-max-word-count

textlint rule that specify the maximum word count of a sentence.

textlint-rule-en-max-word-count

textlint rule that specify the maximum word count of a sentence.

Installation

npm install textlint-rule-en-max-word-count

Usage

Via .textlintrc(Recommended)

{
    "rules": {
        "en-max-word-count": {
            "max" : 50
        }
    }
}

Via CLI

textlint --rule en-max-word-count README.md

Options

.textlintrc options.

{
    "rules": {
        "en-max-word-count": {
            // max count of words and report error if exceed
            "max" : 50
        }
    }
}

Example

OK 💚

max: 4

This is a pen.

NG ❎

max: 4

So, this is a pen.

// => Exceeds the maximum word count of 4.

Tests

 npm test

Contributing

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