Skip to content

Commit f87c43c

Browse files
committed
docs(readme): add options
1 parent 7a38824 commit f87c43c

File tree

1 file changed

+16
-5
lines changed

1 file changed

+16
-5
lines changed

README.md

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,30 @@
1717

1818
### Options
1919

20-
```
20+
`.textlintrc` options.
21+
22+
```js
2123
{
2224
"rules": {
2325
"no-doubled-joshi": {
24-
// 出現回数 >= かつ
25-
"max-count": 2,
26-
// 助詞同士距離 <= ならエラー
27-
"interval-of-tokens" : 2
26+
// 助詞のtoken同士の距離が2以下ならエラー
27+
"min_interval" : 2
2828
}
2929
}
3030
}
3131
```
3232

33+
- `min_interval` : 助詞の最低間隔値
34+
- 指定した間隔値以下で同じ助詞が出現した場合エラーが出力されます。
35+
36+
37+
> ********好き
38+
39+
この場合の、********の間隔値は1
40+
41+
> ****母は私****父と知り合い
42+
43+
この場合の、********の間隔値は2
3344

3445
## Tests
3546

0 commit comments

Comments
 (0)