Merge pull request #29 from azu/fixer-support

Fixer support

Author: azu

README.md

@@ -1,7 +1,9 @@
-# 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)
+# textlint-rule-preset-JTF-style [![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/) [![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").
 
+2016年2月22日改訂第2.2版を元にしています。
+
 ## Installation
 
     npm install textlint-rule-preset-jtf-style
@@ -52,6 +54,22 @@ npm run-script経由で実行すれば、`node_modules/.bin/`は省略出来ま
 
 - [npm で依存もタスクも一元化する - Qiita](http://qiita.com/Jxck_/items/efaff21b977ddc782971#%E3%82%BF%E3%82%B9%E3%82%AF%E3%81%AE%E5%AE%9F%E8%A1%8C "npm で依存もタスクも一元化する - Qiita")
 
+## 自動修正
+
+使用するルールの設定が終わったら、`textlint`を実行してみてください。
+沢山のエラーが表示されると思います。
+
+[![textlint rule](https://img.shields.io/badge/textlint-fixable-green.svg?style=social)](https://textlint.github.io/) 
+
+`textlint-rule-preset-JTF-style`の一部ルールは`textlint`の`--fix`にも対応しています。
+`--fix`を使うことで機械的に判断して修正出来る部分は自動修正します。
+
+```sh
+textlint --fix /path/to/target.md
+```
+
+実際にファイルを書き換えるので、必ずファイルをコピーしておくなどしてファイルを戻せるようにしてから実行してください。
+
 ### サンプル
 
 [example/](example/) に実行できるサンプルプロジェクトがあります。

example/package.json

@@ -6,12 +6,13 @@
   "scripts": {
     "pretest": "npm rm textlint-rule-preset-jtf-style && npm i",
     "textlint": "textlint",
+    "textlint:fix": "textlint --fix ../README.md",
     "test": "npm run textlint -- -f pretty-error ../README.md"
   },
   "author": "azu",
   "license": "MIT",
   "devDependencies": {
-    "textlint": "^5.1.0",
+    "textlint": "^5.5.3",
     "textlint-rule-preset-jtf-style": "file:.."
   }
 }

package.json

@@ -26,6 +26,7 @@
     "build": "babel src --out-dir lib --source-maps",
     "watch": "babel src --out-dir lib --watch --source-maps",
     "prepublish": "npm run --if-present build",
+    "pretest": "node tool/create-fixtures.js",
     "test": "mocha && npm run test:textlint",
     "test:textlint": "(cd example && npm t)"
   },
@@ -37,16 +38,18 @@
   ],
   "devDependencies": {
     "babel": "^5.8.23",
+    "glob": "^7.0.0",
     "mocha": "^2.3.3",
-    "textlint-tester": "^0.3.2"
+    "textlint": "^5.5.2-0",
+    "textlint-tester": "^0.5.1"
   },
   "dependencies": {
     "analyze-desumasu-dearu": "^2.1.2",
+    "moji": "^0.5.1",
+    "regexp.prototype.flags": "^1.1.1",
+    "regx": "^1.0.4",
     "sorted-joyo-kanji": "^0.2.0",
     "textlint-rule-helper": "^1.1.3",
-    "textlint-rule-prh": "^2.0.0"
-  },
-  "peerDependencies": {
-    "textlint": ">= 5.1.0"
+    "textlint-rule-prh": "^2.4.0"
   }
 }

src/1.1.2.js

@@ -17,8 +17,8 @@ Header
 は無視する
  */
 import {isUserWrittenNode} from "./util/node-util";
-export default function (context) {
-    let {Syntax, RuleError, report, getSource} = context;
+function mixer(context) {
+    let {Syntax, RuleError, report, getSource, fixer} = context;
     return {
         [Syntax.Header](node){
             if (!isUserWrittenNode(node, context)) {
@@ -29,9 +29,17 @@ export default function (context) {
             let matchReg = /。(\s*?)$/;
             let index = text.search(matchReg);
             if (index !== -1) {
-                report(node, new RuleError("見出しの文末には、句点(。)を付けません。", index));
+                report(node, {
+                    message: "見出しの文末には、句点(。)を付けません。",
+                    column: index,
+                    fix: fixer.removeRange([index, index + 1])
+                });
             }
             // TODO: いずれの場合も、すべての見出しを通して複数の文体をできるだけ混在させないことが重要です。
         }
     }
+}
+export default {
+    linter: mixer,
+    fixer: mixer
 }

src/1.2.1.js

@@ -1,23 +1,57 @@
 // LICENSE : MIT
 "use strict";
+import regx from 'regx';
+import {japaneseRegExp} from "./util/regexp";
+import {matchCaptureGroupAll} from "./util/match-index";
+import mergeMatches from "./util/merge-matches";
+const rx = regx("g");
 /*
 1.2.1. 句点(。)と読点(、)
 句読点には全角の「、」と「。」を使います。和文の句読点としてピリオド(.)とカンマ(,)を使用しません。
 「4.1.1 句点(。)」と「4.1.2 読点(、)」を参照してください。
  */
 import {isUserWrittenNode} from "./util/node-util";
-export default function (context) {
-    let {Syntax, RuleError, report, getSource} = context;
+
+// [,.]{日本語}
+const leftTarget = rx`
+        ([,\.])
+        ${japaneseRegExp}
+    `;
+// {日本語}[,.]
+const rightTarget = rx`
+        ${japaneseRegExp}
+        ([,\.])
+    `;
+// . => 。 の置換マップ
+const replaceSymbol = {
+    ".": "。",
+    ",": "、"
+};
+
+const reporter = (context) => {
+    let {Syntax, report, fixer, getSource} = context;
     return {
         [Syntax.Str](node){
             if (!isUserWrittenNode(node, context)) {
                 return;
             }
-            let text = getSource(node);
-            // 1.2.1. 句点(。)と読点(、)
-            if (/[,\.]([\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F][\uDC00-\uDFFF]|[ぁ-んァ-ヶ])/.test(text) || /([\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F][\uDC00-\uDFFF]|[ぁ-んァ-ヶ])[,\.]/.test(text)) {
-                report(node, new RuleError("句読点には全角の「、」と「。」を使います。和文の句読点としてピリオド(.)とカンマ(,)を使用しません。"));
-            }
+            const text = getSource(node);
+            const leftMatches = matchCaptureGroupAll(text, leftTarget);
+            const rightMatches = matchCaptureGroupAll(text, rightTarget);
+            const matches = mergeMatches(leftMatches, rightMatches);
+            matches.forEach(match => {
+                const symbol = replaceSymbol[match.text];
+                const indexOfSymbol = match.index;
+                report(node, {
+                    message: "句読点には全角の「、」と「。」を使います。和文の句読点としてピリオド(.)とカンマ(,)を使用しません。",
+                    column: indexOfSymbol,
+                    fix: fixer.replaceTextRange([indexOfSymbol, indexOfSymbol + 1], symbol)
+                });
+            })
         }
     }
+};
+export default {
+    linter: reporter,
+    fixer: reporter
 }

src/1.2.2.js

@@ -3,10 +3,17 @@
 import {isUserWrittenNode} from "./util/node-util";
 /*
 1.2.2. ピリオド(.)とカンマ(,)
-欧文で表記する組織名などの固有名詞や数字にピリオド(.)やカンマ(,)が含まれる場合は、和文中でもピリオ ド(.)とカンマ(,)を使用します。いずれの場合も半角で表記します。「4.1.3 ピリオド(.)、カンマ(,)」を参照してく ださい。
+欧文で表記する組織名などの固有名詞や数字にピリオド(.)やカンマ(,)が含まれる場合は、和文中でもピリオド(.)とカンマ(,)を使用します。
+いずれの場合も半角で表記します。「4.1.3 ピリオド(.)、カンマ(,)」を参照してく ださい。
  */
-export default function (context) {
-    let {Syntax, RuleError, report, getSource} = context;
+
+// . => 。 の置換マップ
+const replaceSymbol = {
+    "．": ".",
+    "，": ","
+};
+function report(context) {
+    let {Syntax, fixer, report, getSource} = context;
     return {
         [Syntax.Str](node){
             if (!isUserWrittenNode(node, context)) {
@@ -15,8 +22,18 @@ export default function (context) {
             let text = getSource(node);
             // 1.2.2. ピリオド(.)とカンマ(,)
             if (/[．，]/.test(text)) {
-                report(node, new RuleError("全角のピリオドとカンマは使用しません。"));
+                const index = text.search(/[．，]/);
+                const symbol = replaceSymbol[text[index]];
+                report(node, {
+                    message: "全角のピリオドとカンマは使用しません。",
+                    column: index,
+                    fix: fixer.replaceTextRange([index, index + 1], symbol)
+                });
             }
         }
     }
+}
+export default {
+    linter: report,
+    fixer: report
 }

src/2.1.10.js

@@ -6,8 +6,9 @@
 ただし桁区切りの「カンマ」は省略する場合があります。
  */
 import {isUserWrittenNode} from "./util/node-util";
-export default function (context) {
-    let {Syntax, RuleError, report, getSource} = context;
+import {matchCaptureGroupAll} from "./util/match-index";
+function reporter(context) {
+    let {Syntax, RuleError, report, fixer, getSource} = context;
     return {
         [Syntax.Str](node){
             if (!isUserWrittenNode(node, context)) {
@@ -17,17 +18,24 @@ export default function (context) {
             // 数字,で絞って
             let numberWithComma = /([\d,]+)/g;
             // 0,xxx な文字列を検出する
-            let strictMatchReg = /(^0+,\d+$)/;
+            let strictMatchReg = /^0+(,)\d+$/;
             let match;
             while (match = numberWithComma.exec(text)) {
                 // この段階では 10,000 も含まれている
                 // ^0,xxx をだけを取り出す
                 let matchedString = match[0];
-                let index = matchedString.search(strictMatchReg);
-                if (index !== -1) {
-                    report(node, new RuleError("小数点には「ピリオド」を使います。", index));
-                }
+                matchCaptureGroupAll(matchedString, strictMatchReg).forEach(subMatch => {
+                    const {index} = subMatch;
+                    report(node, new RuleError("小数点には「ピリオド」を使います。", {
+                        column: match.index + index,
+                        fix: fixer.replaceTextRange([match.index + index, match.index + index + 1], ".")
+                    }));
+                });
             }
         }
     }
+}
+export default {
+    linter: reporter,
+    fixer: reporter
 }

src/2.1.2.js

@@ -7,27 +7,24 @@
  */
 import {isUserWrittenNode} from "./util/node-util";
 import {isJoyo} from "sorted-joyo-kanji";
-
+import {kanjiRegExp}from "./util/regexp";
 // http://qiita.com/YusukeHirao/items/2f0fb8d5bbb981101be0
-function stringToArray (value) {
+function stringToArray(value) {
     return value.match(/[\uD800-\uDBFF][\uDC00-\uDFFF]|[^\uD800-\uDFFF]/g) || [];
 }
 
-// http://tama-san.com/kanji-regex/
-const kanjiReg = /(?:[々〇〻\u3400-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F][\uDC00-\uDFFF])/;
-
 export default function (context) {
     let {Syntax, RuleError, report, getSource} = context;
     return {
         [Syntax.Str](node){
             if (!isUserWrittenNode(node, context)) {
                 return;
             }
-            let text = getSource(node);
-            let strArray = stringToArray(text);
-            for(let index = 0; index < strArray.length; index++) {
-                let item = strArray[index];
-                if(kanjiReg.test(item) && !isJoyo(item)) {
+            const text = getSource(node);
+            const strArray = stringToArray(text);
+            for (let index = 0; index < strArray.length; index++) {
+                const item = strArray[index];
+                if (kanjiRegExp.test(item) && !isJoyo(item)) {
                     report(node, new RuleError("「" + item + "」は「常用漢字表」外の漢字です。", index));
                 }
             }

src/2.1.5.js

@@ -10,12 +10,25 @@ Halfwidth Katakana variants（半角片仮名）
 http://www.asahi-net.or.jp/~ax2s-kmtn/ref/unicode/uff00.html
  */
 import {isUserWrittenNode} from "./util/node-util";
+import {hanKarakanaRegExp} from "./util/regexp";
 import prh from "textlint-rule-prh";
 import path from "path";
-export default function (context) {
-    let {Syntax, RuleError, report, getSource} = context;
+import {matchCaptureGroupAll} from "./util/match-index";
+import moji from "moji";
+/**
+ * 半角カタカナを全角カタカナに変換
+ *
+ * @param {String} str 変換したい文字列
+ */
+function toZenkaku(string) {
+    return moji(string).convert('HK', 'ZK').toString();
+}
+
+
+function reporter(context) {
+    let {Syntax, fixer, report, getSource} = context;
     // 辞書ベースのカタカタ表記のチェックを行う
-    let dictRule = prh(context, {
+    let dictRule = prh.fixer(context, {
         rulePaths: [path.join(__dirname, "..", "dict", "2.1.5.yml")]
     });
     let originalStrRule = dictRule[Syntax.Str];
@@ -25,12 +38,21 @@ export default function (context) {
         if (!isUserWrittenNode(node, context)) {
             return;
         }
-        let text = getSource(node);
-        let matchReg = /[\uFF65-\uFF9F]/;
-        let index = text.search(matchReg);
-        if (index !== -1) {
-            report(node, new RuleError("カタカナは「全角」で表記します。", index));
-        }
+        const text = getSource(node);
+        const matches = matchCaptureGroupAll(text, /([\uFF65-\uFF9F]+)/g);
+        matches.forEach(match => {
+            const {index, text} = match;
+            report(node, {
+                message: "カタカナは「全角」で表記します。",
+                column: index,
+                fix: fixer.replaceTextRange([index, index + text.length], toZenkaku(text))
+            });
+
+        });
     };
     return dictRule;
+}
+export default {
+    linter: reporter,
+    fixer: reporter
 }

src/2.1.6.js

@@ -11,7 +11,7 @@ import prh from "textlint-rule-prh";
 import path from "path";
 export default function (context) {
     // 辞書ベースのカタカナ末尾の長音のチェックを行う
-    return prh(context, {
+    return prh.fixer(context, {
         rulePaths: [path.join(__dirname, "..", "dict", "2.1.6.yml")]
     });
 }