Skip to content

Commit 8b8bea8

Browse files
committed
Update README
1 parent 9b934c5 commit 8b8bea8

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ npm install -D textlint textlint-rule-preset-jtf-style
3636

3737
textlintの設定ファイルとなっている`.textlintrc`に次のように`jtf-style`と指定します(`textlint-rule-`を取り除いたプリセット名)。
3838

39-
```js
39+
```json5
4040
{
4141
"rules": {
4242
"preset-jtf-style": true
@@ -611,7 +611,7 @@ A. `.textlintrc` にルール毎の設定を追加することが出来ます。
611611
`1.2.2.ピリオド(.)とカンマ(,)`のルールを無効化したい場合は、`.textlintrc`に次のように`false`値を設定することで無効化出来ます。
612612
デフォルトでは`textlint-rule-preset-jtf-style`に含まれるルールが全て有効化されています。
613613

614-
```js
614+
```json5
615615
{
616616
"rules": {
617617
"preset-jtf-style": {
@@ -632,7 +632,7 @@ A. 正規表現の辞書ベースのルールが幾つかあります。
632632
その他のtextlintルールと衝突が発生しやすい辞書ベースのルールとなっています。
633633
そのため、辞書を改善していくかルール自体を無効化するアプローチを取る必要あります。
634634

635-
デフォルトでは辞書ベースのルールである次のルールが無効化されています
635+
デフォルトでは次の辞書ベースのルールは無効化されています
636636

637637
- [2.1.2.漢字](./src/2.1.2.js)
638638
- [2.1.5.カタカナ](./src/2.1.5.js)
@@ -641,7 +641,7 @@ A. 正規表現の辞書ベースのルールが幾つかあります。
641641

642642
これらのルールを有効化したい場合は、`.textlintrc`で明示的に有効化する必要があります。
643643

644-
```js
644+
```json5
645645
{
646646
"rules": {
647647
"preset-jtf-style": {
@@ -655,18 +655,20 @@ A. 正規表現の辞書ベースのルールが幾つかあります。
655655
```
656656

657657

658-
## Migration
658+
## Migration: `textlint-plugin-jtf-style` to `textlint-rule-preset-jtf-style`
659659

660-
`textlint-plugin-jtf-style` から `textlint-rule-preset-jtf-style` へ移行したい場合、
660+
`textlint-plugin-jtf-style` から `textlint-rule-preset-jtf-style` へ移行したい場合の移行手順です。
661+
662+
次のようにモジュールを切り替えます。
661663

662664
```sh
663665
npm uninstall -D textlint-plugin-jtf-style
664666
npm install -D textlint-rule-preset-jtf-style
665667
```
666668

667-
した後`.textlintrc`
669+
その後`.textlintrc`にかかれている設定を
668670

669-
```js
671+
```json5
670672
{
671673
"plugins": [
672674
"jtf-style"
@@ -682,7 +684,7 @@ npm install -D textlint-rule-preset-jtf-style
682684

683685
以下のように書き換えれば完了です。
684686

685-
```js
687+
```json5
686688
{
687689
"rules": {
688690
"preset-jtf-style": {

0 commit comments

Comments
 (0)