feat(option): add emoji support (#3)

* add emoji support

* improve handling of emoji option

* reuse unicode workaround string

Author: mt-caret

README.md

@@ -40,6 +40,10 @@ textlint --rule ja-no-mixed-period README.md
     - 文末に使用する句点文字
     - デフォルト: "。"
 
+- `allowEmojiAtEnd`(bool):
+    - 絵文字を末尾に置くことを許可するかどうか
+    - デフォルト: false
+
 ```json
 {
     "rules": {

package.json

@@ -42,6 +42,7 @@
     "textlint-tester": "^2.0.0"
   },
   "dependencies": {
+    "emoji-regex": "^6.1.0",
     "textlint-rule-helper": "^2.0.0"
   }
 }

src/textlint-rule-ja-no-mixed-period.js

@@ -1,17 +1,21 @@
 // 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 = /[。\.]/;
 const defaultOptions = {
     // 優先する句点文字
-    periodMark: "。"
+    periodMark: "。",
+    // 末尾に絵文字を置くことを許可するか
+    allowEmojiAtEnd: false
 };
 const reporter = (context, options = {}) => {
     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];
     return {
         [Syntax.Paragraph](node){
@@ -27,8 +31,10 @@ const reporter = (context, options = {}) => {
             if (!japaneseRegExp.test(lastStrText)) {
                 return;
             }
-            const lastIndex = lastStrText.length - 1;
-            const lastChar = lastStrText[lastIndex];
+            // サロゲートペアを考慮した文字列長・文字アクセス
+            const characters = [...lastStrText];
+            const lastIndex = characters.length - 1;
+            const lastChar = characters[lastIndex];
             if (lastChar === undefined) {
                 return;
             }
@@ -48,6 +54,9 @@ const reporter = (context, options = {}) => {
             if (exceptionMarkRegExp.test(lastChar)) {
                 return;
             }
+            if (allowEmojiAtEnd && emojiRegExp.test(lastChar)) {
+                return;
+            }
             if (lastChar === periodMark) {
                 return;
             }
@@ -71,4 +80,4 @@ const reporter = (context, options = {}) => {
 module.exports = {
     linter: reporter,
     fixer: reporter
-};
+};

test/textlint-rule-ja-no-mixed-period-test.js

@@ -17,6 +17,12 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
         `[リンクリファレンスも][]`,
         `__強調表示も同じく__`,
         `> 引用も無視される`,
+        {
+          text: "絵文字が末尾にある。😆",
+          options: {
+            allowEmojiAtEnd: true
+          },
+        },
     ],
     invalid: [
         // single match
@@ -84,6 +90,17 @@ tester.run("textlint-rule-ja-no-mixed-period", rule, {
                     column: 5
                 }
             ]
-        }
+        },
+        // emojis are not allowed by default
+        {
+            text: "絵文字が末尾にある。😆",
+            errors: [
+                {
+                    message: `文末が"。"で終わっていません。`,
+                    line: 1,
+                    column: 11
+                }
+            ]
+        },
     ]
-});
+});