textlint-rule-max-ten
v5.0.0
Published
textlint rule that limit maxinum ten(、) count of sentence.
Downloads
135,294
Readme
textlint-rule-max-ten
textlint rule is that limit maximum ten(、) count of sentence.
一文に利用できる、
の数を制限するtextlintルール
一文の読点の数が多いと冗長で読みにくい文章となるため、読点の数を一定数以下にするルールです。 読点の数を減らすためには、句点(。)で文を区切る必要があります。
Installation
npm install textlint-rule-max-ten
Usage
$ npm install textlint textlint-rule-max-ten
$ textlint --rule max-ten README.md
# 11:0 error 一つの文で"、"を3つ以上使用しています max-ten
Options
max
: number- デフォルト: 3
- 一文に許可される読点の数 + 1となった場合にエラーとします。デフォルトでは4つの"、"が一文にあるとエラーとなります。
{
"rules": {
"max-ten": {
// 1文に利用できる最大の、の数
// max: 3の場合は4つ以上の読点でエラーとなる
"max": 3,
// 例外ルールを適応するかどうか,
"strict": false,
// 読点として扱う文字
// https://ja.wikipedia.org/wiki/%E8%AA%AD%E7%82%B9
"touten": "、",
// 句点として扱う文字
// https://ja.wikipedia.org/wiki/%E5%8F%A5%E7%82%B9
"kuten": "。"
}
}
}
読点に「,」句点に「.」を使う場合は、次のように設定します。
{
"rules": {
"max-ten": {
// 読点として扱う文字
"touten": ",",
// 句点として扱う文字
"kuten": "."
}
}
}
例外
<名詞>
、<名詞>
のように名詞に挟まれた読点はカウントしません。 箇条書きとしての区切り文字として使われているため無視します。
<名詞>(A)、<名詞>(B)、<名詞>(C)
のように名詞を説明する括弧が、
に隣接するケースも、名詞に挟まれた読点としてカウントしません。
Tests
npm test
Contributing
- Fork it!
- Create your feature branch:
git checkout -b my-new-feature
- Commit your changes:
git commit -am 'Add some feature'
- Push to the branch:
git push origin my-new-feature
- Submit a pull request :D
License
MIT