Merge pull request #27 from azu/rename-to-textlint-rule-preset-jtf-style

Rename to textlint-rule-preset-jtf-style

Author: azu

README.md

@@ -1,10 +1,10 @@
-# textlint-plugin-JTF-style [![Build Status](https://travis-ci.org/azu/textlint-plugin-JTF-style.svg?branch=master)](https://travis-ci.org/azu/textlint-plugin-JTF-style)
+# textlint-rule-preset-JTF-style [![Build Status](https://travis-ci.org/azu/textlint-rule-preset-JTF-style.svg?branch=master)](https://travis-ci.org/azu/textlint-rule-preset-JTF-style)
 
 [JTF日本語標準スタイルガイド（翻訳用）](https://www.jtf.jp/jp/style_guide/styleguide_top.html "JTF日本語標準スタイルガイド（翻訳用）") for [textlint](https://github.com/textlint/textlint "textlint").
 
 ## Installation
 
-    npm install textlint-plugin-jtf-style
+    npm install textlint-rule-preset-jtf-style
 
 ## Usage
 
@@ -14,31 +14,31 @@
 
 ### 最も手軽な方法(グローバル)
 
-npmでグローバルにインストールし、`--plugin`で利用するのが一番お手軽です。
+npmでグローバルにインストールし、`--preset`で利用するのが一番お手軽です。
 
-    npm install -g textlint textlint-plugin-jtf-style
-    textlint --plugin textlint-plugin-jtf-style README.md
+    npm install -g textlint textlint-rule-preset-jtf-style
+    textlint --preset textlint-rule-preset-jtf-style README.md
     # README.mdをLintした結果が出力されます
 
 グローバルにインストールするよりは、次のようにプロジェクト毎のディレクトリにインストールする方法を推奨します。
 
 ### `.textlintrc`を使う方法(推奨)
 
-現在のディレクトリにtextlintとtextlint-plugin-jtf-styleをインストールする方法です。
+現在のディレクトリにtextlintとtextlint-rule-preset-jtf-styleをインストールする方法です。
 (グローバルにインストールしなくていいので環境がキレイに作れます)
 
 ```
 npm init # package.jsonがないなら
-npm install -D textlint textlint-plugin-jtf-style
+npm install -D textlint textlint-rule-preset-jtf-style
 ```
 
-textlintの設定ファイルとなっている`.textlintrc`に次のように`jtf-style`と指定します(`textlint-plugin-`を取り除いたプラグイン名)。
+textlintの設定ファイルとなっている`.textlintrc`に次のように`jtf-style`と指定します(`textlint-rule-`を取り除いたプリセット名)。
 
 ```js
 {
-    "plugins": [
-        "jtf-style"
-    ]
+    "rules": {
+        "preset-jtf-style": true
+    }
 }
 ```
 
@@ -62,7 +62,7 @@ npm run-script経由で実行すれば、`node_modules/.bin/`は省略出来ま
 
 - [JTF日本語標準スタイルガイド（翻訳用）（PDFファイル）](https://www.jtf.jp/jp/style_guide/pdf/jtf_style_guide.pdf)
 
-`textlint-plugin-JTF-style`で対応するルールと実装状況は以下のとおりです。
+`textlint-rule-preset-jtf-style`で対応するルールと実装状況は以下のとおりです。
 
 辞書ベースと書かれているものは、独自の辞書をベースとしているため精度が曖昧となっています。
 
@@ -569,7 +569,7 @@ npm run-script経由で実行すれば、`node_modules/.bin/`は省略出来ま
 
 Q. このルールはスタイルガイドと合ってないのでは？
 
-A. [Issue](https://github.com/azu/textlint-plugin-JTF-style/issues/new)に詳細を書いてみるといいと思います。
+A. [Issue](https://github.com/azu/textlint-rule-preset-jtf-style/issues/new)に詳細を書いてみるといいと思います。
 
 Issueには以下の項目が書かれていると問題を解決しやすくなります。
 
@@ -591,15 +591,14 @@ A. `.textlintrc` にルール毎の設定を追加することが出来ます。
 - [textlintで日本語の文章をチェックする | Web Scratch](http://efcl.info/2015/09/10/introduce-textlint/ "textlintで日本語の文章をチェックする | Web Scratch")
 
 `1.2.2.ピリオド(.)とカンマ(,)`のルールを無効化したい場合は、`.textlintrc`に次のように`false`値を設定することで無効化出来ます。
-デフォルトでは`textlint-plugin-JTF-style`に含まれるルールが全て有効化されています。
+デフォルトでは`textlint-rule-preset-jtf-style`に含まれるルールが全て有効化されています。
 
 ```js
 {
-    "plugins": [
-        "jtf-style"
-    ],
     "rules": {
-        "jtf-style/1.2.2.ピリオド(.)とカンマ(,)": false
+        "preset-jtf-style": {
+            "1.2.2.ピリオド(.)とカンマ(,)": false
+        }
     }
 }
 ```
@@ -624,6 +623,31 @@ A. 正規表現の辞書ベースのルールが幾つかあります。
 
 これらのルールを有効化したい場合は、`.textlintrc`で明示的に有効化する必要があります。
 
+```js
+{
+    "rules": {
+        "preset-jtf-style": {
+            "2.1.2.漢字": true,
+            "2.1.5.カタカナ": true,
+            "2.1.6.カタカナの長音": true,
+            "2.2.1.ひらがなと漢字の使い分け": true
+        }
+    }
+}
+```
+
+
+## Migration
+
+`textlint-plugin-jtf-style` から `textlint-rule-preset-jtf-style` へ移行したい場合、
+
+```sh
+npm uninstall -D textlint-plugin-jtf-style
+npm install -D textlint-rule-preset-jtf-style
+```
+
+した後、`.textlintrc`を
+
 ```js
 {
     "plugins": [
@@ -638,6 +662,21 @@ A. 正規表現の辞書ベースのルールが幾つかあります。
 }
 ```
 
+以下のように書き換えれば完了です。
+
+```js
+{
+    "rules": {
+        "preset-jtf-style": {
+            "2.1.2.漢字": true,
+            "2.1.5.カタカナ": true,
+            "2.1.6.カタカナの長音": true,
+            "2.2.1.ひらがなと漢字の使い分け": true
+        }
+    }
+}
+```
+
 
 ## Contributing
 

example/.textlintrc

@@ -1,9 +1,7 @@
 {
-  "plugins": [
-    "jtf-style"
-  ],
   "rules": {
-    "jtf-style/2.1.6.カタカナの長音": false,
-    "jtf-style/4.3.1.丸かっこ（）": false
+    "preset-jtf-style": {
+      "4.3.1.丸かっこ（）": false
+    }
   }
 }

example/package.json

@@ -4,14 +4,14 @@
   "description": "",
   "main": "index.js",
   "scripts": {
-    "pretest": "npm rm textlint-plugin-jtf-style && npm i",
+    "pretest": "npm rm textlint-rule-preset-jtf-style && npm i",
     "textlint": "textlint",
     "test": "npm run textlint -- -f pretty-error ../README.md"
   },
   "author": "azu",
   "license": "MIT",
   "devDependencies": {
-    "textlint": "^3.7.1",
-    "textlint-plugin-jtf-style": "file:.."
+    "textlint": "^5.1.0",
+    "textlint-rule-preset-jtf-style": "file:.."
   }
 }

package.json

@@ -1,15 +1,15 @@
 {
-  "name": "textlint-plugin-jtf-style",
+  "name": "textlint-rule-preset-jtf-style",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/azu/textlint-plugin-JTF-style.git"
+    "url": "git+https://github.com/azu/textlint-rule-preset-jtf-style.git"
   },
   "author": "azu",
   "email": "[email protected]",
-  "homepage": "https://github.com/azu/textlint-plugin-JTF-style",
+  "homepage": "https://github.com/azu/textlint-rule-preset-jtf-style",
   "license": "MIT",
   "bugs": {
-    "url": "https://github.com/azu/textlint-plugin-JTF-style/issues"
+    "url": "https://github.com/azu/textlint-rule-preset-jtf-style/issues"
   },
   "version": "1.0.1",
   "description": "JTF Style Guide for Translators Working into Japanese for textlint.",
@@ -45,5 +45,8 @@
     "sorted-joyo-kanji": "^0.2.0",
     "textlint-rule-helper": "^1.1.3",
     "textlint-rule-prh": "^2.0.0"
+  },
+  "peerDependencies": {
+    "textlint": ">= 5.1.0"
   }
 }

src/2.2.2.js

@@ -158,7 +158,7 @@ export default function (context) {
 
             // ＊数えられる数字は算用数字を使う
             // 数十万、数百億にマッチしないように"数"という文字から始まるものは除外
-            // https://github.com/azu/textlint-plugin-JTF-style/pull/23
+            // https://github.com/azu/textlint-rule-preset-jtf-style/pull/23
             matchToReplace(text, /([一二三四五六七八九十壱弐参拾百〇]+)[兆億万]/g,
                 ignoreWhenMatched(/数([一二三四五六七八九十壱弐参拾百〇]+)[兆億万]/g, toNumber)
             );