Merge pull request #205 from docsbydoxdox/feature/use-super-regex

neogeek · web-flow · commit 20a1c555845c · 2022-10-09T02:14:04.000-04:00
[feat] Switched to using super-regex for matching.
diff --git a/.github/workflows/test.workflow.yml b/.github/workflows/test.workflow.yml
@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest]
-        node: [14.15.0, 16.10.0, 18.0.0]
+        node: [14.18.0, 16.10.0, 18.0.0]
 
     steps:
       - name: Check out repository
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/doxdox-cli/package.json b/packages/doxdox-cli/package.json
@@ -9,7 +9,7 @@
   "types": "./dist/src/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "doxdox-core": "4.0.0-preview.16",
diff --git a/packages/doxdox-core/package.json b/packages/doxdox-core/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "devDependencies": {
     "@types/jest": "29.1.2",
diff --git a/packages/doxdox-parser-custom/package.json b/packages/doxdox-parser-custom/package.json
@@ -6,10 +6,11 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
-    "comment-parser": "1.3.1"
+    "comment-parser": "1.3.1",
+    "super-regex": "0.2.0"
   },
   "peerDependencies": {
     "doxdox-core": "4.0.0-preview.16"
diff --git a/packages/doxdox-parser-custom/src/index.ts b/packages/doxdox-parser-custom/src/index.ts
@@ -6,6 +6,10 @@ import { File, Method, multiLinePatternMatch, slugify } from 'doxdox-core';
 
 import { parse as commentParse } from 'comment-parser';
 
+import { firstMatch, matches } from 'super-regex';
+
+const REGEX_TIMEOUT = 1000;
+
 const JSDOC_PATTERN = /[ \t]*\/\*\*\s*\n?([^*]*(\*[^/])?)*\*\//g;
 
 const IDENTIFIER_PATTERNS = [
@@ -36,8 +40,9 @@ export const parseString = async (
     path: string,
     content: string
 ): Promise<File> => {
-    const comments =
-        content.match(JSDOC_PATTERN) || ([] as unknown as string[]);
+    const comments = Array.from(
+        matches(JSDOC_PATTERN, content, { timeout: REGEX_TIMEOUT })
+    ).map(({ match }) => match);
 
     const methods = comments.map(comment => ({
         rawComment: comment,
@@ -71,10 +76,14 @@ export const parseString = async (
         const [firstLine] = method.code.trim().split(/\r?\n/);
 
         for (let i = 0; i < IDENTIFIER_PATTERNS.length; i += 1) {
-            const matches = firstLine.trim().match(IDENTIFIER_PATTERNS[i]);
-
-            if (matches) {
-                method.name = matches[1];
+            const results = firstMatch(
+                IDENTIFIER_PATTERNS[i],
+                firstLine.trim(),
+                { timeout: REGEX_TIMEOUT }
+            );
+
+            if (results) {
+                method.name = results.groups[0];
 
                 break;
             }
diff --git a/packages/doxdox-parser-dox/package.json b/packages/doxdox-parser-dox/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "dox": "1.0.0"
diff --git a/packages/doxdox-parser-jsdoc/package.json b/packages/doxdox-parser-jsdoc/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "jsdoc": "3.6.11",
diff --git a/packages/doxdox-parser-template/package.json b/packages/doxdox-parser-template/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "peerDependencies": {
     "doxdox-core": "4.0.0-preview.16"
diff --git a/packages/doxdox-renderer-bootstrap/package.json b/packages/doxdox-renderer-bootstrap/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "highlight.js": "11.6.0",
diff --git a/packages/doxdox-renderer-dash/package.json b/packages/doxdox-renderer-dash/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "adm-zip": "0.5.9",
diff --git a/packages/doxdox-renderer-github-wiki/package.json b/packages/doxdox-renderer-github-wiki/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "adm-zip": "0.5.9",
diff --git a/packages/doxdox-renderer-json/package.json b/packages/doxdox-renderer-json/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "peerDependencies": {
     "doxdox-core": "4.0.0-preview.16"
diff --git a/packages/doxdox-renderer-markdown/package.json b/packages/doxdox-renderer-markdown/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "markdown-table": "3.0.2"
diff --git a/packages/doxdox-renderer-pdf/package.json b/packages/doxdox-renderer-pdf/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "dependencies": {
     "highlight.js": "11.6.0",
diff --git a/packages/doxdox-renderer-template/package.json b/packages/doxdox-renderer-template/package.json
@@ -6,7 +6,7 @@
   "types": "./dist/index.d.ts",
   "type": "module",
   "engines": {
-    "node": "^14.15.0 || ^16.10.0 || >=18.0.0"
+    "node": "^14.18.0 || ^16.10.0 || >=18.0.0"
   },
   "peerDependencies": {
     "doxdox-core": "4.0.0-preview.16"
diff --git a/packages/doxdox/package.json b/packages/doxdox/package.json
