refactor: make SourceParser class heritable + create and use JsSource…

…Parser in … (#215) * refactor: make SourceParser class heritable + create and use JsSourceParser in runASTAnalysis * chore: kParsingOptions is only for the JS parser
NodeSecure · Jan 25, 2024 · 83aa3d5 · 83aa3d5
1 parent d26eafc
commit 83aa3d5
Show file tree

Hide file tree

Showing 5 changed files with 96 additions and 85 deletions.
diff --git a/index.js b/index.js
@@ -8,9 +8,9 @@ import isMinified from "is-minified-code";
 
 // Import Internal Dependencies
 import { SourceFile } from "./src/SourceFile.js";
-import { SourceParser } from "./src/SourceParser.js";
 import { warnings } from "./src/warnings.js";
 import { isOneLineExpressionExport } from "./src/utils/index.js";
+import { JsSourceParser } from "./src/JsSourceParser.js";
 
 export function runASTAnalysis(
   str,
@@ -22,7 +22,7 @@ export function runASTAnalysis(
     removeHTMLComments = false
   } = options;
 
-  const parser = new SourceParser(str, { removeHTMLComments });
+  const parser = new JsSourceParser(str, { removeHTMLComments });
   const body = parser.parseScript({
     isEcmaScriptModule: Boolean(module)
   });

diff --git a/src/JsSourceParser.js b/src/JsSourceParser.js
@@ -0,0 +1,61 @@
+// Import Third-party Dependencies
+import * as meriyah from "meriyah";
+
+// Import Internal Dependencies
+import { SourceParser } from "./SourceParser.js";
+
+// CONSTANTS
+const kParsingOptions = {
+  next: true,
+  loc: true,
+  raw: true,
+  jsx: true
+};
+
+export class JsSourceParser extends SourceParser {
+  /**
+   * @param {object} options
+   * @param {boolean} options.isEcmaScriptModule
+   */
+  parseScript(options = {}) {
+    const {
+      isEcmaScriptModule
+    } = options;
+
+    try {
+      const { body } = meriyah.parseScript(
+        this.source,
+        {
+          ...kParsingOptions,
+          module: isEcmaScriptModule,
+          globalReturn: !isEcmaScriptModule
+        }
+      );
+
+      return body;
+    }
+    catch (error) {
+      const isIllegalReturn = error.description.includes("Illegal return statement");
+
+      if (error.name === "SyntaxError" && (
+        error.description.includes("The import keyword") ||
+        error.description.includes("The export keyword") ||
+        isIllegalReturn
+      )) {
+        const { body } = meriyah.parseScript(
+          this.source,
+          {
+            ...kParsingOptions,
+            module: true,
+            globalReturn: isIllegalReturn
+          }
+        );
+
+        return body;
+      }
+
+      throw error;
+    }
+  }
+}
+
diff --git a/src/SourceParser.js b/src/SourceParser.js
@@ -1,14 +1,3 @@
-// Import Third-party Dependencies
-import * as meriyah from "meriyah";
-
-// CONSTANTS
-const kParsingOptions = {
-  next: true,
-  loc: true,
-  raw: true,
-  jsx: true
-};
-
 export class SourceParser {
   /**
    * @param {!string} source
@@ -42,50 +31,4 @@ export class SourceParser {
   #removeHTMLComment(str) {
     return str.replaceAll(/<!--[\s\S]*?(?:-->)/g, "");
   }
-
-  /**
-   * @param {object} options
-   * @param {boolean} options.isEcmaScriptModule
-   */
-  parseScript(options = {}) {
-    const {
-      isEcmaScriptModule
-    } = options;
-
-    try {
-      const { body } = meriyah.parseScript(
-        this.source,
-        {
-          ...kParsingOptions,
-          module: isEcmaScriptModule,
-          globalReturn: !isEcmaScriptModule
-        }
-      );
-
-      return body;
-    }
-    catch (error) {
-      const isIllegalReturn = error.description.includes("Illegal return statement");
-
-      if (error.name === "SyntaxError" && (
-        error.description.includes("The import keyword") ||
-        error.description.includes("The export keyword") ||
-        isIllegalReturn
-      )) {
-        const { body } = meriyah.parseScript(
-          this.source,
-          {
-            ...kParsingOptions,
-            module: true,
-            globalReturn: isIllegalReturn
-          }
-        );
-
-        return body;
-      }
-
-      throw error;
-    }
-  }
 }
-
diff --git a/test/JsSourceParser.spec.js b/test/JsSourceParser.spec.js
@@ -0,0 +1,33 @@
+// Import Node.js Dependencies
+import { describe, it } from "node:test";
+
+// Import Internal Dependencies
+import { JsSourceParser } from "../src/JsSourceParser.js";
+
+describe("JsSourceParser", () => {
+  describe("parseScript", () => {
+    it("should not crash even if isEcmaScriptModule 'false' is provided (import keyword)", () => {
+      new JsSourceParser("import * as foo from \"foo\";").parseScript({
+        isEcmaScriptModule: false
+      });
+    });
+
+    it("should not crash even if isEcmaScriptModule 'false' is provided (export keyword)", () => {
+      new JsSourceParser("export const foo = 5;").parseScript({
+        isEcmaScriptModule: false
+      });
+    });
+
+    it("should not crash with a source code containing JSX", () => {
+      const code = `const Dropzone = forwardRef(({ children, ...params }, ref) => {
+        const { open, ...props } = useDropzone(params);
+        useImperativeHandle(ref, () => ({ open }), [open]);
+        return <Fragment>{children({ ...props, open })}</Fragment>;
+      });`;
+
+      new JsSourceParser(code).parseScript({
+        isEcmaScriptModule: false
+      });
+    });
+  });
+});
diff --git a/test/SourceParser.spec.js b/test/SourceParser.spec.js
@@ -77,30 +77,4 @@ describe("SourceParser", () => {
       assert.strictEqual(sp.source, "\nconst yo = 'foo'\n");
     });
   });
-
-  describe("parseScript", () => {
-    it("should not crash even if isEcmaScriptModule 'false' is provided (import keyword)", () => {
-      new SourceParser("import * as foo from \"foo\";").parseScript({
-        isEcmaScriptModule: false
-      });
-    });
-
-    it("should not crash even if isEcmaScriptModule 'false' is provided (export keyword)", () => {
-      new SourceParser("export const foo = 5;").parseScript({
-        isEcmaScriptModule: false
-      });
-    });
-
-    it("should not crash with a source code containing JSX", () => {
-      const code = `const Dropzone = forwardRef(({ children, ...params }, ref) => {
-        const { open, ...props } = useDropzone(params);
-        useImperativeHandle(ref, () => ({ open }), [open]);
-        return <Fragment>{children({ ...props, open })}</Fragment>;
-      });`;
-
-      new SourceParser(code).parseScript({
-        isEcmaScriptModule: false
-      });
-    });
-  });
 });