Skip to content

Commit b30b5ce

Browse files
committed
docs(readme): add faq about 3.3
1 parent 84b2e03 commit b30b5ce

File tree

1 file changed

+36
-0
lines changed

1 file changed

+36
-0
lines changed

README.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -655,6 +655,42 @@ A. 正規表現の辞書ベースのルールが幾つかあります。
655655
}
656656
```
657657

658+
Q. 半角かっこの外側のスペースを禁止したい・必須にしたい
659+
660+
A. オプションで半角かっこの外側のスペースの扱いを変更することが出来ます。
661+
662+
[3.3.かっこ類と隣接する文字の間のスペースの有無](./src/3.3.js)のオプションを設定することで、半角かっこの外側のスペースの扱いを変更することができます。
663+
664+
`allowOutsideHalfParentheses` は半角かっこの外側の半角スペースを許容するオプションです。
665+
デフォルトは `true` です。
666+
`false` に設定することで、半角かっこの外側のスペースを禁止できます。
667+
668+
```json5
669+
{
670+
"rules": {
671+
"preset-jtf-style": {
672+
"3.3.かっこ類と隣接する文字の間のスペースの有無": {
673+
"allowOutsideHalfParentheses": false
674+
}
675+
}
676+
}
677+
}
678+
```
679+
680+
`requireOutsideHalfParentheses` は半角かっこの外側の半角スペースを必須にするオプションです。
681+
デフォルトは `false` です。
682+
683+
```json5
684+
{
685+
"rules": {
686+
"preset-jtf-style": {
687+
"3.3.かっこ類と隣接する文字の間のスペースの有無": {
688+
"requireOutsideHalfParentheses": true
689+
}
690+
}
691+
}
692+
}
693+
```
658694

659695
## Migration: `textlint-plugin-jtf-style` to `textlint-rule-preset-jtf-style`
660696

0 commit comments

Comments
 (0)