feat(rule): ignore \w言語

Author: azu

README.md

@@ -49,8 +49,9 @@ textlint --rule ja-unnatural-alphabet README.md
 
 - `allow`: `string[]`
     - 無視するアルファベットの配列
-    - デフォルト: `["a", "i", "u", "e", "o", "n"]`
+    - デフォルト: `["a", "i", "u", "e", "o", "n", "/[a-zA-Zａ-ｚＡ-Ｚ]言語/"]`
     - デフォルトでは母音とnを除外している
+    - `"/正規表現/" のような文字列もサポート
 
 ```json5
 {

package.json

@@ -34,6 +34,7 @@
     "textlint-scripts": "^1.2.2"
   },
   "dependencies": {
+    "escape-string-regexp": "^1.0.5",
     "match-index": "^1.0.1",
     "regx": "^1.0.4"
   }

src/textlint-rule-ja-unnatural-alphabet.js

@@ -1,10 +1,11 @@
 // MIT © 2017 azu
 "use strict";
+const escapeStringRegexp = require('escape-string-regexp');
 const matchCaptureGroupAll = require("match-index").matchCaptureGroupAll;
 const regx = require("regx").default;
 // IME的に入力されそうな文字列
 // 日本語 + 記号
-const japaneseRegExp = /(?:[々〇〻\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F][\uDC00-\uDFFF]|[ぁ-んァ-ヶー。、・−])/;
+const japaneseRegExp = /(?:[々〇〻\u3400-\u4DBF\u4E00-\u9FFF\uF900-\uFAFF]|[\uD840-\uD87F]|[\uFF00-\uFFEF]|[\uDC00-\uDFFF]|[ぁ-んァ-ヶー。、・−])/;
 // 半角/全角のアルファベットの正規表現
 const alphabetPattern = /([a-zA-Zａ-ｚＡ-Ｚ])/;
 /**
@@ -21,21 +22,59 @@ const matchUnnaturalAlphabet = (text) => {
     return matchCaptureGroupAll(text, unnaturalPattern);
 };
 
+/**
+ * if actual is in the `exceptGroups`, return true
+ * @param {MatchCaptureGroup[]} exceptGroups
+ * @param {MatchCaptureGroup} actual
+ * @returns {boolean}
+ */
+const isIgnoredRange = (exceptGroups, actual) => {
+    return exceptGroups.some(({ text, index }) => {
+        const endIndex = index + text.length;
+        return index <= actual.index && actual.index <= endIndex;
+    });
+};
+/***
+ *
+ * @param {string} input
+ * @param {string[]} allowAlphabets
+ * @returns {MatchCaptureGroup[]}
+ */
+const createIgnoreRanges = (input, allowAlphabets) => {
+    // str -> RegExp
+    const patterns = allowAlphabets.map(allowWord => {
+        if (!allowWord) {
+            return /^$/;
+        }
+        if (allowWord[0] === "/" && allowWord[allowWord.length - 1] === "/") {
+            const regExpString = allowWord.slice(1, allowWord.length - 1);
+            return new RegExp(`(${regExpString})`, "g");
+        }
+        const escapeString = escapeStringRegexp(allowWord);
+        return new RegExp(`(${escapeString})`, "g");
+    });
+    return patterns.reduce((total, pattern) => {
+        return total.concat(matchCaptureGroupAll(input, pattern));
+    }, []);
+};
+
 const defaultOptions = {
     // 無視するアルファベット
     // 例) ["X"]
-    // デフォルトでは母音とnを除外している
-    "allow": ["a", "i", "u", "e", "o", "n"]
+    // デフォルトでは母音とnと典型例を除外している
+    "allow": ["a", "i", "u", "e", "o", "n", "/[a-zA-Zａ-ｚＡ-Ｚ]言語/"]
 };
 const report = (context, options = {}) => {
     const { Syntax, RuleError, report, getSource } = context;
     const allowAlphabets = options.allow || defaultOptions.allow;
     return {
         [Syntax.Str](node){
             const text = getSource(node);
-            matchUnnaturalAlphabet(text).forEach(({ text, index }) => {
-                // 無視するアルファベットであるなら無視
-                if (allowAlphabets.indexOf(text) !== -1) {
+            const ignoreMatch = createIgnoreRanges(text, allowAlphabets);
+            matchUnnaturalAlphabet(text).forEach((actual) => {
+                const { text, index } = actual;
+                // 無視する単語を含んでいるなら無視
+                if (isIgnoredRange(ignoreMatch, actual)) {
                     return;
                 }
                 report(node, new RuleError(`不自然なアルファベットがあります: ${text}`, {

test/textlint-rule-ja-unnatural-alphabet-test.js

@@ -10,6 +10,8 @@ tester.run("textlint-rule-ja-unnatural-alphabet", rule, {
         "リリース",
         "aiueo",
         "This is pen.",
+        "これはC言語",
+        "これはD言語",
         {
             text: "アンドロイドNは良し",
             options: {
@@ -33,6 +35,14 @@ tester.run("textlint-rule-ja-unnatural-alphabet", rule, {
                     message: "不自然なアルファベットがあります: ｋ"
                 }
             ]
+        },
+        {
+            text: "無駄なk脳",
+            errors: [
+                {
+                    message: "不自然なアルファベットがあります: k"
+                }
+            ]
         }
     ]
 });