https://github.com/textlint-rule/textlint-rule-max-comma
textlint rule is that limit maximum comma(,) count of sentence.
https://github.com/textlint-rule/textlint-rule-max-comma
Last synced: 4 months ago
JSON representation
textlint rule is that limit maximum comma(,) count of sentence.
- Host: GitHub
- URL: https://github.com/textlint-rule/textlint-rule-max-comma
- Owner: textlint-rule
- License: mit
- Created: 2016-05-01T16:19:03.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2023-11-26T00:58:49.000Z (over 1 year ago)
- Last Synced: 2025-02-07T06:08:16.848Z (5 months ago)
- Language: JavaScript
- Homepage:
- Size: 186 KB
- Stars: 2
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# textlint-rule-max-comma [](https://github.com/azu/textlint-rule-max-comma/actions?query=workflow%3A"test")
[textlint](http://textlint.github.io/ "textlint") rule is that limit maximum comma(,) count of sentence.
## Installation
npm install textlint-rule-max-comma
## Usage
$ npm install -D textlint textlint-rule-max-comma
$ npx textlint --rule max-comma README.md
# 11:0 error This sentence exceeds the maximum count of comma. Maximum is 4.
## Options
- `max`: maximum number of `,`
- Default: `4`
- It means that report an error if the sentence include 5 or more `,`
Configure `"max"` value of the `.textlintrc` file.
```json
{
"rules": {
"max-comma": {
"max" : 4
}
}
}
```
## Tests
npm test
## Related
- [textlint-rule-max-ten](https://github.com/textlint-ja/textlint-rule-max-ten)
- Japanese comma(`、`) edition
## 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