Breaking Change: forceAppendPeriodオプションの追加 (#4)

azu · web-flow · commit 6d48bb864b73 · 2017-03-21T23:18:02.000+09:00
- `forceAppendPeriod`: trueの場合は自動的に--fixで句点を追加する
- デフォルトはOFFであるためBREAKING CHANGEとなる。
- 句点判定の処理をライブラリ化
diff --git a/README.md b/README.md
@@ -34,21 +34,55 @@ Via CLI
 textlint --rule ja-no-mixed-period README.md
 ```
 
+## Examples
+
+**OK**:
+
+```
+これは問題ないです。
+末尾に感嘆符はある!
+「これはセリフ」
+english only
+- 箇条書きは無視される
+```
+
+**NG**:
+
+```
+これは句点がありません
+末尾にスペースがある。           
+絵文字が末尾にある。😆
+```
+
 ## Options
 
-- `periodMark`(string):
+- `periodMark`: `string`:
     - 文末に使用する句点文字
     - デフォルト: "。"
-
+- `allowPeriodMarks`: `string[]`
+    - 句点文字として許可する文字列の配列
+    - 例外として許可したい文字列を設定する
+    - `periodMark`に指定したものは自動的に許可リストに加わる
+    - デフォルトは空 `[]`
 - `allowEmojiAtEnd`(bool):
     - 絵文字を末尾に置くことを許可するかどうか
     - デフォルト: false
+- `forceAppendPeriod`: `boolean`
+    - 句点で終わって無い場合に`periodMark`を--fix時に追加するかどうか
+    - デフォルト: false
 
 ```json
 {
     "rules": {
         "ja-no-mixed-period": {
-            "periodMark": "。"
+             // 優先する句点文字
+             "periodMark": "。",
+             // 句点文字として許可する文字列の配列
+             "allowPeriodMarks": [],
+             // 末尾に絵文字を置くことを許可するか
+             "allowEmojiAtEnd": false,
+             // 句点で終わって無い場合に`periodMark`を--fix時に追加するかどうか
+             "forceAppendPeriod": false
         }
     }
 }
diff --git a/package.json b/package.json
@@ -42,7 +42,7 @@
     "textlint-tester": "^2.0.0"
   },
   "dependencies": {
-    "emoji-regex": "^6.1.0",
+    "check-ends-with-period": "^1.0.1",
     "textlint-rule-helper": "^2.0.0"
   }
 }
diff --git a/src/textlint-rule-ja-no-mixed-period.js b/src/textlint-rule-ja-no-mixed-period.js
@@ -1,22 +1,44 @@
 // LICENSE : MIT
 "use strict";
 const RuleHelper = require("textlint-rule-helper").RuleHelper;
-const emojiRegExp = require("emoji-regex")();
 const japaneseRegExp = /(?:[々〇〻\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F][\uDC00-\uDFFF]|[ぁ-んァ-ヶ])/;
-const exceptionMarkRegExp = /[!?！？\)）」』]/;
-const defaultPeriodMark = /[。\.]/;
+/***
+ * 典型的な句点のパターン
+ * これは`periodMark`と交換しても違和感がないものを登録
+ * @type {RegExp}
+ */
+const classicPeriodMarkPattern = /[。\.]/;
+const checkEndsWithPeriod = require("check-ends-with-period");
 const defaultOptions = {
     // 優先する句点文字
     periodMark: "。",
+    // 句点文字として許可する文字列の配列
+    // 例外として許可したい文字列を設定する
+    // `periodMark`に指定したものは自動的に許可リストに加わる
+    allowPeriodMarks: [],
     // 末尾に絵文字を置くことを許可するか
-    allowEmojiAtEnd: false
+    allowEmojiAtEnd: false,
+    // 句点で終わって無い場合に`periodMark`を--fix時に追加するかどうか
+    // デフォルトでは自動的に追加しない
+    forceAppendPeriod: false
 };
 const reporter = (context, options = {}) => {
-    const {Syntax, RuleError, report, fixer, getSource} = context;
+    const { Syntax, RuleError, report, fixer, getSource } = context;
     const helper = new RuleHelper(context);
-    const periodMark = options.periodMark || defaultOptions.periodMark;
-    const allowEmojiAtEnd = options.allowEmojiAtEnd !== undefined ? options.allowEmojiAtEnd : defaultOptions.allowEmojiAtEnd;
-    const ignoredNodeTypes = [Syntax.ListItem, Syntax.Link, Syntax.Code, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis];
+    // 優先する句点記号
+    const preferPeriodMark = options.periodMark || defaultOptions.periodMark;
+    // 優先する句点記号は常に句点として許可される
+    const allowPeriodMarks = (options.allowPeriodMarks || defaultOptions.allowPeriodMarks).concat(preferPeriodMark);
+    const allowEmojiAtEnd = options.allowEmojiAtEnd !== undefined
+        ? options.allowEmojiAtEnd
+        : defaultOptions.allowEmojiAtEnd;
+    const forceAppendPeriod = options.forceAppendPeriod !== undefined
+        ? options.forceAppendPeriod
+        : defaultOptions.forceAppendPeriod;
+
+    const ignoredNodeTypes = [
+        Syntax.ListItem, Syntax.Link, Syntax.Code, Syntax.Image, Syntax.BlockQuote, Syntax.Emphasis
+    ];
     return {
         [Syntax.Paragraph](node){
             if (helper.isChildNode(node, ignoredNodeTypes)) {
@@ -27,52 +49,50 @@ const reporter = (context, options = {}) => {
                 return;
             }
             const lastStrText = getSource(lastNode);
+            if (lastStrText.length === 0) {
+                return;
+            }
             // 日本語が含まれていない文章は無視する
             if (!japaneseRegExp.test(lastStrText)) {
                 return;
             }
-            // サロゲートペアを考慮した文字列長・文字アクセス
-            const characters = [...lastStrText];
-            const lastIndex = characters.length - 1;
-            const lastChar = characters[lastIndex];
-            if (lastChar === undefined) {
+            const { valid, periodMark, index } = checkEndsWithPeriod(lastStrText, {
+                periodMarks: allowPeriodMarks,
+                allowEmoji: allowEmojiAtEnd
+            });
+            // 問題が無い場合は何もしない
+            if (valid) {
                 return;
             }
-            // 文末がスペースである場合
-            // TODO: fixに対応したい
-            if (/\s/.test(lastChar)) {
-                report(lastNode, new RuleError(`文末が"${periodMark}"で終わっていません。末尾に不要なスペースがあります。`, {
-                    index: lastIndex
+            // 文末がスペースである場合はスペースを削除する
+            if (/\s/.test(periodMark)) {
+                report(lastNode, new RuleError(`文末が"${preferPeriodMark}"で終わっていません。末尾に不要なスペースがあります。`, {
+                    index,
+                    fix: fixer.replaceTextRange([index, index + periodMark.length], "")
                 }));
                 return
             }
-            // 末尾の"文字"が句点以外で末尾に使われる文字であるときは無視する
-            // 例外: 感嘆符
-            // 例外: 「」 () （）『』
-            // http://ncode.syosetu.com/n8977bb/12/
-            // https://ja.wikipedia.org/wiki/%E7%B5%82%E6%AD%A2%E7%AC%A6
-            if (exceptionMarkRegExp.test(lastChar)) {
-                return;
-            }
-            if (allowEmojiAtEnd && emojiRegExp.test(lastChar)) {
-                return;
-            }
-            if (lastChar === periodMark) {
-                return;
-            }
-            // "." であるなら "。"に変換
-            // そうでない場合は末尾に"。"を追加する
-            let fix = null;
-            if (defaultPeriodMark.test(lastChar)) {
-                fix = fixer.replaceTextRange([lastIndex, lastIndex + 1], periodMark);
+            // 典型的なパターンは自動的に`preferPeriodMark`に置き換える
+            // 例) "." であるなら "。"に変換
+            if (classicPeriodMarkPattern.test(periodMark)) {
+                report(lastNode, new RuleError(`文末が"${preferPeriodMark}"で終わっていません。`, {
+                    index: index,
+                    fix: fixer.replaceTextRange([index, index + preferPeriodMark.length], preferPeriodMark)
+                }));
             } else {
-                fix = fixer.replaceTextRange([lastIndex + 1, lastIndex + 1], periodMark);
+                // 句点を忘れているパターン
+                if (forceAppendPeriod) {
+                    // `forceAppendPeriod`のオプションがtrueならば、自動で句点を追加する。
+                    report(lastNode, new RuleError(`文末が"${preferPeriodMark}"で終わっていません。`, {
+                        index: index,
+                        fix: fixer.replaceTextRange([index + 1, index + 1], preferPeriodMark)
+                    }));
+                } else {
+                    report(lastNode, new RuleError(`文末が"${preferPeriodMark}"で終わっていません。`, {
+                        index: index
+                    }));
+                }
             }
-            report(lastNode, new RuleError(`文末が"${periodMark}"で終わっていません。`, {
-                index: lastIndex,
-                fix
-            }));
-
         }
     }
 };
diff --git a/test/textlint-rule-ja-no-mixed-period-test.js b/test/textlint-rule-ja-no-mixed-period-test.js
@@ -8,6 +8,7 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
         "1行目。  \nHard Breakを入れるパターン。",
         "1行目  空白はあるけど末尾に句点はある。",
         // 例外: 感嘆符などが末尾にある場合は問題なし
+        "「これはセリフ」",
         "末尾に句点はある!",
         "english only",
         // 例外のNode type
@@ -18,17 +19,26 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
         `__強調表示も同じく__`,
         `> 引用も無視される`,
         {
-          text: "絵文字が末尾にある。😆",
-          options: {
-            allowEmojiAtEnd: true
-          },
+            text: "絵文字が末尾にある。😆",
+            options: {
+                allowEmojiAtEnd: true
+            },
         },
+        {
+            text: "これはOK",
+            options: {
+                allowPeriodMarks: ["OK"]
+            },
+        }
     ],
     invalid: [
         // single match
         {
             text: "これは句点がありません",
             output: "これは句点がありません。",
+            options: {
+                forceAppendPeriod: true
+            },
             errors: [
                 {
                     message: `文末が"。"で終わっていません。`,
@@ -41,6 +51,9 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
         {
             text: "これは句点がありません\n\nこれは句点がありません",
             output: "これは句点がありません。\n\nこれは句点がありません。",
+            options: {
+                forceAppendPeriod: true
+            },
             errors: [
                 {
                     message: `文末が"。"で終わっていません。`,
@@ -56,18 +69,33 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
         },
         {
             text: "末尾にスペースがある。 ",
+            output: "末尾にスペースがある。",
             errors: [
                 {
                     message: `文末が"。"で終わっていません。末尾に不要なスペースがあります。`,
                     line: 1,
-                    column: 12
+                    column: 12 // space
+                }
+            ]
+        },
+        {
+            text: "末尾にスペースがある。           ",
+            output: "末尾にスペースがある。",
+            errors: [
+                {
+                    message: `文末が"。"で終わっていません。末尾に不要なスペースがあります。`,
+                    line: 1,
+                    column: 12 // space の開始位置
                 }
             ]
         },
         // multiple hit items in a line
         {
             text: "これは句点がありません、これは句点がありません",
             output: "これは句点がありません、これは句点がありません。",
+            options: {
+                forceAppendPeriod: true
+            },
             errors: [
                 {
                     message: `文末が"。"で終わっていません。`,
@@ -81,7 +109,8 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
             text: "これはダメ",
             output: "これはダメ.",
             options: {
-                periodMark: "."
+                periodMark: ".",
+                forceAppendPeriod: true
             },
             errors: [
                 {

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@`
`42`	`42`	`"textlint-tester": "^2.0.0"`
`43`	`43`	`},`
`44`	`44`	`"dependencies": {`
`45`		`- "emoji-regex": "^6.1.0",`
	`45`	`+ "check-ends-with-period": "^1.0.1",`
`46`	`46`	`"textlint-rule-helper": "^2.0.0"`
`47`	`47`	`}`
`48`	`48`	`}`