feat(rule): support RegExp flag

azu · azu · commit 77b950896bc2 · 2017-06-24T23:22:22.000+09:00
diff --git a/README.md b/README.md
@@ -18,7 +18,8 @@ Via `.textlintrc`(Recommended)
         "whitelist": {
             "allow": [
                 "ignored-word",
-                "/\\d+/"
+                "/\\d+/",
+                "/^===/m"
             ]
         }
     }
@@ -33,18 +34,15 @@ Via `.textlintrc`(Recommended)
 ### RegExp String
 
 textlint-filter-rule-whitelist allow to use RegExp like string.
-The string is stated with `/` and ended with `/`.
+The string is stated with `/` and ended with `/` or `/flag`.
 
 ```js
 "/\\d+/"; // => /\d+/
 ```
 
-**Limitation**:
+**Note**:
 
-Currently, `/regexp/` to be `/regexp/g`.
-It means that this filter rule is not supported multiline RegExp `/regexp/m`.
-
-Welcome to Pull Request!
+Multiline pattern should be use `m` flag like `/regexp/m`.
 
 ## Changelog
 
diff --git a/package.json b/package.json
@@ -46,6 +46,7 @@
   },
   "dependencies": {
     "escape-string-regexp": "^1.0.5",
-    "execall": "^1.0.0"
+    "execall": "^1.0.0",
+    "str-to-regexp": "^1.1.3"
   }
 }
diff --git a/src/textlint-filter-rule-whitelist.js b/src/textlint-filter-rule-whitelist.js
@@ -2,30 +2,32 @@
 "use strict";
 const execall = require('execall');
 const escapeStringRegexp = require('escape-string-regexp');
+const toRegExp = require("str-to-regexp").toRegExp;
+const COMPLEX_REGEX_END = /^.+\/(\w*)$/;
 const defaultOptions = {
     // white list
     // string or RegExp string
     // e.g.
     // "string"
     // "/\\d+/"
+    // "/^===/m"
     allow: []
 };
 module.exports = function(context, options) {
-    const {Syntax, shouldIgnore, getSource} = context;
+    const { Syntax, shouldIgnore, getSource } = context;
     const allowWords = options.allow || defaultOptions.allow;
     const regExpWhiteList = allowWords.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");
+        if (allowWord[0] === "/" && COMPLEX_REGEX_END.test(allowWord)) {
+            return toRegExp(allowWord);
         }
         const escapeString = escapeStringRegexp(allowWord);
         return new RegExp(escapeString, "g");
     });
     return {
-        [Syntax.Document](node){
+        [Syntax.Document](node) {
             const text = getSource(node);
             regExpWhiteList.forEach(whiteRegExp => {
                 const matches = execall(whiteRegExp, text);
diff --git a/test/textlint-filter-rule-whitelist-test.js b/test/textlint-filter-rule-whitelist-test.js
@@ -4,6 +4,7 @@ const TextLintCore = require("textlint").TextLintCore;
 const TextLintNodeType = require("textlint").TextLintNodeType;
 import filterRule from "../src/textlint-filter-rule-whitelist";
 import reportRule from "textlint-rule-report-node-types";
+
 const assert = require("power-assert");
 describe("textlint-rule-filter-whitelist", function() {
     context("when report and filter type", function() {
@@ -23,7 +24,7 @@ describe("textlint-rule-filter-whitelist", function() {
                     allow: ["text"]
                 }
             });
-            return textlint.lintText("text").then(({messages}) => {
+            return textlint.lintText("text").then(({ messages }) => {
                 assert.equal(messages.length, 0);
             });
         });
@@ -45,7 +46,7 @@ describe("textlint-rule-filter-whitelist", function() {
                     allow: ["`\\d\+`"]
                 }
             });
-            return textlint.lintMarkdown("white `1234` text").then(({messages}) => {
+            return textlint.lintMarkdown("white `1234` text").then(({ messages }) => {
                 assert.equal(messages.length, 1);
             });
         });
@@ -65,11 +66,38 @@ describe("textlint-rule-filter-whitelist", function() {
                     allow: ["/`\\d+`/"]
                 }
             });
-            return textlint.lintMarkdown("white `1234` text").then(({messages}) => {
+            return textlint.lintMarkdown("white `1234` text").then(({ messages }) => {
                 assert.equal(messages.length, 0);
             });
         });
 
+        it("should messages is ignore by RegExp + flag", function() {
+            const textlint = new TextLintCore();
+            textlint.setupRules({
+                report: reportRule
+            }, {
+                report: {
+                    nodeTypes: [TextLintNodeType.Paragraph]
+                }
+            });
+            textlint.setupFilterRules({
+                whitelist: filterRule
+            }, {
+                whitelist: {
+                    allow: [
+                        "/^={1,4}\\s/m",
+                        "This is not error."
+                    ]
+                }
+            });
+            return textlint.lintMarkdown("This is error.=== Title").then(({ messages }) => {
+                assert.equal(messages.length, 1);
+            }).then(() => {
+                return textlint.lintMarkdown("This is not error.\n\n=== Title").then(({ messages }) => {
+                    assert.equal(messages.length, 0);
+                });
+            })
+        });
         it("should messages is ignore by RegExp", function() {
             const textlint = new TextLintCore();
             textlint.setupRules({
@@ -86,7 +114,7 @@ describe("textlint-rule-filter-whitelist", function() {
                     allow: ["/{{\.*\?}}/"]
                 }
             });
-            return textlint.lintMarkdown("{{book.console}}").then(({messages}) => {
+            return textlint.lintMarkdown("{{book.console}}").then(({ messages }) => {
                 assert.equal(messages.length, 0);
             });
         });

Original file line number	Diff line number	Diff line change
`@@ -46,6 +46,7 @@`
`46`	`46`	`},`
`47`	`47`	`"dependencies": {`
`48`	`48`	`"escape-string-regexp": "^1.0.5",`
`49`		`- "execall": "^1.0.0"`
	`49`	`+ "execall": "^1.0.0",`
	`50`	`+ "str-to-regexp": "^1.1.3"`
`50`	`51`	`}`
`51`	`52`	`}`