feat: support captures (#10)

BREAKING CHANGE: Drop to support Node.js 12

Author: azu

README.md

@@ -38,15 +38,15 @@ GitHub launched in 2018-04-10.`;
 const inputPatterns = [
     "git", // => /git/g
     "/github/i", // => /github/ig
-    "/\\d{4}-\\d{2}-\\d{2}/" // => /\d{4}-\d{2}-\d{2}/g
+    "/(\\d{4})-(\\d{2})-(\\d{2})/" // => /\d{4}-\d{2}-\d{2}/g
 ];
 
 const results = matchPatterns(inputText, inputPatterns);
 assert.deepStrictEqual(results, [
-    { match: "GitHub", startIndex: 1, endIndex: 7 },
-    { match: "git", startIndex: 65, endIndex: 68 },
-    { match: "GitHub", startIndex: 107, endIndex: 113 },
-    { match: "2018-04-10", startIndex: 126, endIndex: 136 }
+    { match: "GitHub", startIndex: 1, endIndex: 7, captures: [] },
+    { match: "git", startIndex: 65, endIndex: 68, captures: [] },
+    { match: "GitHub", startIndex: 107, endIndex: 113, captures: [] },
+    { match: "2018-04-10", startIndex: 126, endIndex: 136, captures: ["2018", "04", "10"] }
 ]);
 ```
 
@@ -84,14 +84,14 @@ RegExp-like String:
 
 ```json
 [
-    "/a \\w+/"
+    "/a (\\w+)/"
 ]
 ```
 
 Results:
 
 ```
-[ { match: 'a pen', startIndex: 8, endIndex: 13 } ]
+[ { match: 'a pen', startIndex: 8, endIndex: 13, captures: ["pen"] } ]
 ```
 
 ## Examples

package.json

@@ -70,7 +70,6 @@
   },
   "dependencies": {
     "escape-string-regexp": "^2.0.0",
-    "execall": "^2.0.0",
     "lodash.sortby": "^4.7.0",
     "lodash.uniq": "^4.5.0",
     "lodash.uniqwith": "^4.5.0",

src/regexp-string-matcher.ts

@@ -3,8 +3,6 @@ import uniqWith from "lodash.uniqwith";
 import sortBy from "lodash.sortby";
 import escapeStringRegexp from "escape-string-regexp";
 import { isRegExpString, parseRegExpString } from "./regexp-parse";
-
-import execall from "execall";
 import toRegex from "to-regex";
 
 const DEFAULT_FLAGS = "g";
@@ -18,6 +16,9 @@ const defaultFlags = (flagsString: string) => {
 
 export interface matchPatternResult {
     match: string;
+    // captured results
+    // [$1, $2 ...]
+    captures: string[];
     startIndex: number;
     endIndex: number;
 }
@@ -55,12 +56,16 @@ export const matchPatterns = (text: string, regExpLikeStrings: string[]): matchP
             return createRegExp(patternString);
         })
         .forEach((regExp) => {
-            const execallResults = execall(regExp, text);
-            execallResults.forEach((result) => {
-                const match = result.match;
+            const results = text.matchAll(regExp);
+            Array.from(results).forEach((result) => {
+                if (result.index === undefined) {
+                    return;
+                }
+                const match = result[0];
                 const index = result.index;
                 matchPatternResults.push({
                     match: match,
+                    captures: result.slice(1), // without match all text - [$1, $2 ...]
                     startIndex: index,
                     endIndex: index + match.length
                 });

test/example-test.ts

@@ -10,23 +10,23 @@ GitHub launched in 2018-04-10.`;
     const inputPatterns = [
         "git", // => /git/g
         "/github/i", // => /github/ig
-        "/\\d{4}-\\d{2}-\\d{2}/" // => /\d{4}-\d{2}-\d{2}/g
+        "/(\\d{4})-(\\d{2})-(\\d{2})/" // => /\d{4}-\d{2}-\d{2}/g
     ];
 
     const results = matchPatterns(inputText, inputPatterns);
     assert.deepStrictEqual(results, [
-        { match: "GitHub", startIndex: 1, endIndex: 7 },
-        { match: "git", startIndex: 65, endIndex: 68 },
-        { match: "GitHub", startIndex: 107, endIndex: 113 },
-        { match: "2018-04-10", startIndex: 126, endIndex: 136 }
+        { match: "GitHub", startIndex: 1, endIndex: 7, captures: [] },
+        { match: "git", startIndex: 65, endIndex: 68, captures: [] },
+        { match: "GitHub", startIndex: 107, endIndex: 113, captures: [] },
+        { match: "2018-04-10", startIndex: 126, endIndex: 136, captures: ["2018", "04", "10"] }
     ]);
 });
 
 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 }]);
+    assert.deepStrictEqual(results, [{ match: "a pen", startIndex: 8, endIndex: 13, captures: ["pen"] }]);
 });

test/snapshot-test.ts

@@ -28,6 +28,7 @@ describe("Snapshot testing", () => {
                 .map((result) => {
                     return `
 - match text: **${result.match}**
+- captures: **${JSON.stringify(result.captures)}**
 - startIndex: **${result.startIndex}**
 - endIndex: **${result.endIndex}**
 

test/snapshots/capture-multi-regexp/input-patterns.json

@@ -0,0 +1,3 @@
+[
+  "/(\\$)(\\d+)/i"
+]

test/snapshots/capture-multi-regexp/input.txt

@@ -0,0 +1 @@
+$200 and $400

test/snapshots/capture-multi-regexp/output-for-human.md

@@ -0,0 +1,23 @@
+
+- match text: **$200**
+- captures: **["$","200"]**
+- startIndex: **0**
+- endIndex: **4**
+
+```
+**$200** and $400
+
+```
+
+
+
+- match text: **$400**
+- captures: **["$","400"]**
+- startIndex: **9**
+- endIndex: **13**
+
+```
+$200 and **$400**
+
+```
+

test/snapshots/capture-multi-regexp/output-for-machine.json

@@ -0,0 +1,20 @@
+[
+    {
+        "match": "$200",
+        "captures": [
+            "$",
+            "200"
+        ],
+        "startIndex": 0,
+        "endIndex": 4
+    },
+    {
+        "match": "$400",
+        "captures": [
+            "$",
+            "400"
+        ],
+        "startIndex": 9,
+        "endIndex": 13
+    }
+]

test/snapshots/capture-single-regexp/input-patterns.json

@@ -0,0 +1,3 @@
+[
+  "/(\\d+)/i"
+]