fix: string should not handled as RegExp

azu · azu · commit 4f949abb7236 · 2018-05-23T18:04:01.000+09:00
diff --git a/README.md b/README.md
@@ -84,7 +84,7 @@ RegExp-like String:
 
 ```json
 [
-    "a \\w+"
+    "/a \\w+/"
 ]
 ```
 
diff --git a/package.json b/package.json
@@ -44,6 +44,7 @@
     "tabWidth": 4
   },
   "devDependencies": {
+    "@types/escape-string-regexp": "^0.0.32",
     "@types/lodash.sortby": "^4.7.3",
     "@types/lodash.uniq": "^4.5.3",
     "@types/lodash.uniqwith": "^4.5.3",
@@ -68,6 +69,7 @@
     ]
   },
   "dependencies": {
+    "escape-string-regexp": "^1.0.5",
     "execall": "^1.0.0",
     "lodash.sortby": "^4.7.0",
     "lodash.uniq": "^4.5.0",
diff --git a/src/regexp-parse.ts b/src/regexp-parse.ts
@@ -0,0 +1,14 @@
+const REGEXP_LITERAL_PATTERN = /^\/(.*)\/([guimy]*)$/;
+export const parseRegExpString = (str: string): { source: string; flagString: string } | null => {
+    const result = str.match(REGEXP_LITERAL_PATTERN);
+    if (!result) {
+        return null;
+    }
+    return {
+        source: result[1],
+        flagString: result[2]
+    };
+};
+export const isRegExpString = (str: string): boolean => {
+    return REGEXP_LITERAL_PATTERN.test(str);
+};
diff --git a/src/regexp-string-matcher.ts b/src/regexp-string-matcher.ts
@@ -1,23 +1,12 @@
 import uniq = require("lodash.uniq");
 import uniqWith = require("lodash.uniqwith");
 import sortBy = require("lodash.sortby");
+import escapeStringRegexp = require("escape-string-regexp");
+import { isRegExpString, parseRegExpString } from "./regexp-parse";
 
 const execall = require("execall");
 const toRegex = require("to-regex");
-const REGEXP_LITERAL_PATTERN = /^\/(.*)\/([guimy]*)$/;
-const parseRegExpString = (str: string): { source: string; flagString: string } | null => {
-    const result = str.match(REGEXP_LITERAL_PATTERN);
-    if (!result) {
-        return null;
-    }
-    return {
-        source: result[1],
-        flagString: result[2]
-    };
-};
-const isRegExpString = (str: string): boolean => {
-    return REGEXP_LITERAL_PATTERN.test(str);
-};
+
 const DEFAULT_FLAGS = "g";
 
 const defaultFlags = (flagsString: string) => {
@@ -35,7 +24,7 @@ export interface matchPatternResult {
 
 const createRegExp = (patternString: string): RegExp => {
     if (patternString.length === 0) {
-        throw new Error("Emtpy string can not includes");
+        throw new Error("Empty string can not includes");
     }
     if (isRegExpString(patternString)) {
         const regExpStructure = parseRegExpString(patternString);
@@ -47,10 +36,7 @@ const createRegExp = (patternString: string): RegExp => {
         }
         throw new Error(`"${patternString}" can not parse as RegExp.`);
     } else {
-        return toRegex(patternString, {
-            flags: DEFAULT_FLAGS,
-            contains: true
-        });
+        return new RegExp(escapeStringRegexp(patternString), DEFAULT_FLAGS);
     }
 };
 
diff --git a/test/example-test.ts b/test/example-test.ts
@@ -22,10 +22,10 @@ GitHub launched in 2018-04-10.`;
     ]);
 });
 
-it("example", () => {
+it("RegExp-like string", () => {
     const inputText = `This is a pen.`;
     // RegExp like strings
-    const inputPatterns = ["a \\w+"];
+    const inputPatterns = ["/a \\w+/"];
 
     const results = matchPatterns(inputText, inputPatterns);
     assert.deepStrictEqual(results, [{ match: "a pen", startIndex: 8, endIndex: 13 }]);
diff --git a/test/snapshots/not-treat-regexp-string/input-patterns.json b/test/snapshots/not-treat-regexp-string/input-patterns.json
@@ -0,0 +1,3 @@
+[
+  "\\d+"
+]
diff --git a/test/snapshots/not-treat-regexp-string/input.txt b/test/snapshots/not-treat-regexp-string/input.txt
@@ -0,0 +1,3 @@
+GitHub is a web-based hosting service for version control using git.
+It is mostly used for computer code.
+GitHub launched in 2018-04-10.
diff --git a/test/snapshots/not-treat-regexp-string/output-for-human.md b/test/snapshots/not-treat-regexp-string/output-for-human.md
diff --git a/test/snapshots/not-treat-regexp-string/output-for-machine.json b/test/snapshots/not-treat-regexp-string/output-for-machine.json
@@ -0,0 +1 @@
+[]
diff --git a/yarn.lock b/yarn.lock
@@ -22,6 +22,10 @@
   dependencies:
     any-observable "^0.3.0"
 
+"@types/escape-string-regexp@^0.0.32":
+  version "0.0.32"
+  resolved "https://registry.yarnpkg.com/@types/escape-string-regexp/-/escape-string-regexp-0.0.32.tgz#296005808f51d27fb2a2de8d1ca080a91ee3375c"
+
 "@types/lodash.sortby@^4.7.3":
   version "4.7.3"
   resolved "https://registry.yarnpkg.com/@types/lodash.sortby/-/lodash.sortby-4.7.3.tgz#d1f7a7fd955246e685a7541ac184dc058c553eb5"

Original file line number	Diff line number	Diff line change
`@@ -84,7 +84,7 @@ RegExp-like String:`
`84`	`84`
`85`	`85`	```json
`86`	`86`	`[`
`87`		`- "a \\w+"`
	`87`	`+ "/a \\w+/"`
`88`	`88`	`]`
`89`	`89`	```
`90`	`90`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+GitHub is a web-based hosting service for version control using git.`
	`2`	`+It is mostly used for computer code.`
	`3`	`+GitHub launched in 2018-04-10.`