Skip to content

Commit fdb437d

Browse files
committed
docs: デフォルト無効となっているルールについてを追記
close #22
1 parent a77ee23 commit fdb437d

File tree

1 file changed

+26
-6
lines changed

1 file changed

+26
-6
lines changed

README.md

Lines changed: 26 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -164,15 +164,15 @@ npm run-script経由で実行すれば、`node_modules/.bin/`は省略出来ま
164164
<td></td>
165165
</tr>
166166
<tr>
167-
<td><a href="src/2.1.5.js">2.1.5.js</a> (辞書ベース)</td>
167+
<td><a href="src/2.1.5.js">2.1.5.js</a> (辞書ベース/デフォルト無効)</td>
168168
<td>14</td>
169169
<td>カタカナ</td>
170170
<td>全角。半角カタカナは特殊用途を除いて使わない。</td>
171171
<td></td>
172172
<td></td>
173173
</tr>
174174
<tr>
175-
<td><a href="src/2.1.6.js">2.1.6.js</a> (辞書ベース)</td>
175+
<td><a href="src/2.1.6.js">2.1.6.js</a> (辞書ベース/デフォルト無効)</td>
176176
<td>14</td>
177177
<td>カタカナの長音</td>
178178
<td>原則として省略しない。</td>
@@ -212,7 +212,7 @@ npm run-script経由で実行すれば、`node_modules/.bin/`は省略出来ま
212212
<td></td>
213213
</tr>
214214
<tr>
215-
<td><a href="src/2.2.1.js">2.2.1.js</a> (辞書ベース)</td>
215+
<td><a href="src/2.2.1.js">2.2.1.js</a> (辞書ベース/デフォルト無効)</td>
216216
<td>17</td>
217217
<td>ひらがなと漢字の使い分け</td>
218218
<td>参考文献に従う。</td>
@@ -612,10 +612,30 @@ Q. 辞書ベースのルールの質がよくない
612612

613613
A. 正規表現の辞書ベースのルールが幾つかあります。
614614

615-
誤爆が一番起きやすいのは恐らく辞書ベースの部分なので、
616-
辞書を改善していくかルール自体を無効化するアプローチを取る必要あります。
615+
その他のtextlintルールと衝突が発生しやすい辞書ベースのルールとなっています。
616+
そのため、辞書を改善していくかルール自体を無効化するアプローチを取る必要あります。
617+
618+
デフォルトでは辞書ベースのルールである次のルールが無効化されています。
619+
620+
- [2.1.5.カタカナ](./src/2.1.5.js)
621+
- [2.1.6.カタカナの長音](./src/2.1.6.js)
622+
- [2.2.1.ひらがなと漢字の使い分け](./src/2.2.1.js)
623+
624+
これらのルールを有効化したい場合は、`.textlintrc`で明示的に有効化する必要があります。
625+
626+
```js
627+
{
628+
"plugins": [
629+
"jtf-style"
630+
],
631+
"rules": {
632+
"jtf-style/2.1.5.カタカナ": true,
633+
"jtf-style/2.1.6.カタカナの長音": true,
634+
"jtf-style/2.2.1.ひらがなと漢字の使い分け": true
635+
}
636+
}
637+
```
617638

618-
[kuromoji.js](https://github.com/takuyaa/kuromoji.js "kuromoji.js")で形態素解析などをすることで改善できるかもしれません。
619639

620640
## Contributing
621641

0 commit comments

Comments
 (0)