@jsenv/ast 4.0.3 → 5.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/ast",
-  "version": "4.0.3",
+  "version": "5.0.0",
   "description": "Parse and transform HTML,CSS and JS",
   "license": "MIT",
   "repository": {
@@ -33,12 +33,12 @@
     "test": "node --conditions=development ./scripts/test.mjs"
   },
   "dependencies": {
-    "@babel/parser": "7.22.4",
-    "acorn": "8.8.2",
+    "@babel/parser": "7.22.7",
+    "acorn": "8.10.0",
     "acorn-import-assertions": "1.9.0",
     "acorn-walk": "8.2.0",
     "parse5": "7.1.2",
-    "postcss": "8.4.24",
+    "postcss": "8.4.25",
     "postcss-value-parser": "4.2.0"
   }
 }

package/src/html/html_node.js

@@ -1,6 +1,9 @@
 import { parseFragment } from "parse5";
 
-import { setHtmlNodeAttributes } from "./html_node_attributes.js";
+import {
+  getHtmlNodeAttribute,
+  setHtmlNodeAttributes,
+} from "./html_node_attributes.js";
 import { findHtmlNode } from "./html_search.js";
 import { analyzeScriptNode } from "./html_analysis.js";
 import {
@@ -56,9 +59,43 @@ export const injectHtmlNodeAsEarlyAsPossible = (
     "jsenv-injected-by": jsenvPluginName,
   });
   const isScript = node.nodeName === "script";
-
   if (isScript) {
-    const isJsModule = analyzeScriptNode(node).type === "js_module";
+    const { type } = analyzeScriptNode(node);
+    const headNode = findChild(htmlAst, (node) => node.nodeName === "html")
+      .childNodes[0];
+
+    // <script type="importmap">
+    // - after any <link>
+    // - but before first <link rel="modulepreload">
+    // - and before <script type="module">
+    const isImportmap = type === "importmap";
+    if (isImportmap) {
+      let after = headNode.childNodes[0];
+      for (const child of headNode.childNodes) {
+        if (child.nodeName === "link") {
+          if (getHtmlNodeAttribute(child, "rel") === "modulepreload") {
+            return insertHtmlNodeBefore(node, child);
+          }
+          after = child;
+          continue;
+        }
+        if (
+          child.nodeName === "script" &&
+          analyzeScriptNode(child).type === "module"
+        ) {
+          return insertHtmlNodeBefore(node, child);
+        }
+      }
+      if (after) {
+        return insertHtmlNodeAfter(node, after);
+      }
+      return injectHtmlNode(htmlAst, node);
+    }
+    // <script type="module">
+    // - after <script type="importmap">
+    // - and after any <link>
+    // - and before first <script type="module">
+    const isJsModule = type === "js_module";
     if (isJsModule) {
       const firstImportmapScript = findHtmlNode(htmlAst, (node) => {
         return (
@@ -66,47 +103,46 @@ export const injectHtmlNodeAsEarlyAsPossible = (
           analyzeScriptNode(node).type === "importmap"
         );
       });
-
       if (firstImportmapScript) {
-        const importmapParent = firstImportmapScript.parentNode;
-        const importmapSiblings = importmapParent.childNodes;
-        const nextSiblings = importmapSiblings.slice(
-          importmapSiblings.indexOf(firstImportmapScript) + 1,
-        );
-        let after = firstImportmapScript;
-        for (const nextSibling of nextSiblings) {
-          if (nextSibling.nodeName === "script") {
-            insertHtmlNodeBefore(node, nextSibling);
-            return;
-          }
-          if (nextSibling.nodeName === "link") {
-            after = nextSibling;
-          }
+        return insertHtmlNodeAfter(node, firstImportmapScript);
+      }
+      let after = headNode.childNodes[0];
+      for (const child of headNode.childNodes) {
+        if (child.nodeName === "link") {
+          after = child;
+          continue;
         }
-        insertHtmlNodeAfter(node, after);
-        return;
+        if (
+          child.nodeName === "script" &&
+          analyzeScriptNode(child).type === "module"
+        ) {
+          return insertHtmlNodeBefore(node, child);
+        }
+      }
+      if (after) {
+        return insertHtmlNodeAfter(node, after);
       }
+      return injectHtmlNode(htmlAst, node);
     }
-    const headNode = findChild(htmlAst, (node) => node.nodeName === "html")
-      .childNodes[0];
+    // <script> or <script type="text/jsx">, ...
+    // - after any <link>
+    // - before any <script>
     let after = headNode.childNodes[0];
     for (const child of headNode.childNodes) {
-      if (child.nodeName === "script") {
-        insertHtmlNodeBefore(node, child);
-        return;
-      }
       if (child.nodeName === "link") {
         after = child;
+        continue;
+      }
+      if (child.nodeName === "script") {
+        return insertHtmlNodeBefore(node, child);
       }
     }
     if (after) {
-      insertHtmlNodeAfter(node, after);
+      return insertHtmlNodeAfter(node, after);
     }
-    return;
+    return injectHtmlNode(htmlAst, node);
   }
-
-  injectHtmlNode(htmlAst, node);
-  return;
+  return injectHtmlNode(htmlAst, node);
 };
 
 export const insertHtmlNodeBefore = (nodeToInsert, futureNextSibling) => {

package/src/js/js_static_analysis/import_export.js

@@ -3,7 +3,7 @@ import { isStringLiteralNode } from "./helpers.js";
 export const analyzeImportDeclaration = (node, { onUrl }) => {
   const specifierNode = node.source;
   const assertionInfo = extractImportAssertionsInfo(node);
-  onUrl({
+  const info = {
     type: "js_import",
     subtype: "import_static",
     specifier: specifierNode.value,
@@ -11,9 +11,17 @@ export const analyzeImportDeclaration = (node, { onUrl }) => {
     end: specifierNode.end,
     line: specifierNode.loc.start.line,
     column: specifierNode.loc.start.column,
-    expectedType: assertionInfo ? assertionInfo.assert.type : "js_module",
-    ...assertionInfo,
-  });
+    expectedType: "js_module",
+    astInfo: { node: specifierNode },
+  };
+  if (assertionInfo) {
+    const { importAttributes, importNode, importTypeAttributeNode } =
+      assertionInfo;
+    info.expectedType = importAttributes.type;
+    info.importAttributes = importAttributes;
+    Object.assign(info.astInfo, { importNode, importTypeAttributeNode });
+  }
+  onUrl(info);
 };
 export const analyzeImportExpression = (node, { onUrl }) => {
   const specifierNode = node.source;
@@ -21,18 +29,25 @@ export const analyzeImportExpression = (node, { onUrl }) => {
     return;
   }
   const assertionInfo = extractImportAssertionsInfo(node);
-
-  onUrl({
+  const info = {
     type: "js_import",
     subtype: "import_dynamic",
+    expectedType: "js_module",
     specifier: specifierNode.value,
     start: specifierNode.start,
     end: specifierNode.end,
     line: specifierNode.loc.start.line,
     column: specifierNode.loc.start.column,
-    expectedType: assertionInfo ? assertionInfo.assert.type : "js_module",
-    ...assertionInfo,
-  });
+    astInfo: { node: specifierNode },
+  };
+  if (assertionInfo) {
+    const { importAttributes, importNode, importTypeAttributeNode } =
+      assertionInfo;
+    info.expectedType = importAttributes.type;
+    info.importAttributes = importAttributes;
+    Object.assign(info.astInfo, { importNode, importTypeAttributeNode });
+  }
+  onUrl(info);
 };
 export const analyzeExportNamedDeclaration = (node, { onUrl }) => {
   const specifierNode = node.source;
@@ -52,6 +67,7 @@ export const analyzeExportNamedDeclaration = (node, { onUrl }) => {
     end: specifierNode.end,
     line: specifierNode.loc.start.line,
     column: specifierNode.loc.start.column,
+    astInfo: { node: specifierNode },
   });
 };
 export const analyzeExportAllDeclaration = (node, { onUrl }) => {
@@ -64,6 +80,7 @@ export const analyzeExportAllDeclaration = (node, { onUrl }) => {
     end: specifierNode.end,
     line: specifierNode.loc.start.line,
     column: specifierNode.loc.start.column,
+    astInfo: { node: specifierNode },
   });
 };
 
@@ -88,10 +105,11 @@ const extractImportAssertionsInfo = (node) => {
       return null;
     }
     return {
-      assertNode: typeAssertionNode,
-      assert: {
+      importAttributes: {
         type: typeNode.value,
       },
+      importNode: node,
+      importTypeAttributeNode: typeAssertionNode,
     };
   }
   // dynamic import
@@ -127,9 +145,10 @@ const extractImportAssertionsInfo = (node) => {
     return null;
   }
   return {
-    assertNode: firstArgNode,
-    assert: {
+    importAttributes: {
       type: typePropertyValue.value,
     },
+    importNode: node,
+    importTypeAttributeNode: typePropertyNode,
   };
 };

package/src/js/js_static_analysis/import_meta_resolve.js

@@ -14,7 +14,6 @@ export const analyzeImportMetaResolveCall = (node, { onUrl }) => {
   const firstArg = node.arguments[0];
   if (firstArg && isStringLiteralNode(firstArg)) {
     onUrl({
-      node,
       type: "js_import",
       subtype: "import_meta_resolve",
       specifier: firstArg.value,
@@ -22,6 +21,7 @@ export const analyzeImportMetaResolveCall = (node, { onUrl }) => {
       end: firstArg.end,
       line: firstArg.loc.start.line,
       column: firstArg.loc.start.column,
+      astInfo: { node },
     });
   }
 };

package/src/js/js_static_analysis/json_parse.js

@@ -16,7 +16,6 @@ export const analyzeJSONParseCall = (node, { onInlineContent }) => {
   const contentInfo = extractContentInfo(nodeHoldingContent);
   if (contentInfo) {
     onInlineContent({
-      node: nodeHoldingContent,
       type: "json_parse_first_arg",
       contentType: "application/json",
       start: nodeHoldingContent.start,
@@ -28,6 +27,7 @@ export const analyzeJSONParseCall = (node, { onInlineContent }) => {
       nodeType: contentInfo.nodeType,
       quote: contentInfo.quote,
       content: contentInfo.content,
+      astInfo: { node: nodeHoldingContent },
     });
   }
 };

package/src/js/js_static_analysis/new_blob.js

@@ -38,7 +38,6 @@ export const analyzeNewBlobCall = (node, { onInlineContent }) => {
   const contentInfo = extractContentInfo(nodeHoldingContent);
   if (contentInfo) {
     onInlineContent({
-      node: nodeHoldingContent,
       type: "new_blob_first_arg",
       contentType,
       start: nodeHoldingContent.start,
@@ -50,6 +49,7 @@ export const analyzeNewBlobCall = (node, { onInlineContent }) => {
       nodeType: contentInfo.nodeType,
       quote: contentInfo.quote,
       content: contentInfo.content,
+      astInfo: { node: nodeHoldingContent },
     });
   }
 };

package/src/js/js_static_analysis/new_inline_content.js

@@ -32,7 +32,6 @@ export const analyzeNewInlineContentCall = (node, { onInlineContent }) => {
   const contentInfo = extractContentInfo(nodeHoldingContent);
   if (contentInfo) {
     onInlineContent({
-      node: nodeHoldingContent,
       type: "new_inline_content_first_arg",
       contentType,
       start: nodeHoldingContent.start,
@@ -44,6 +43,7 @@ export const analyzeNewInlineContentCall = (node, { onInlineContent }) => {
       nodeType: contentInfo.nodeType,
       quote: contentInfo.quote,
       content: contentInfo.content,
+      astInfo: { node: nodeHoldingContent },
     });
   }
 };

package/src/js/js_static_analysis/new_url.js

@@ -21,6 +21,7 @@ export const analyzeNewUrlCall = (node, { isJsModule, onUrl }) => {
         end: specifierNode.end,
         line: specifierNode.loc.start.line,
         column: specifierNode.loc.start.column,
+        astInfo: { node: specifierNode },
       });
     }
     return;
@@ -53,6 +54,7 @@ export const analyzeNewUrlCall = (node, { isJsModule, onUrl }) => {
           baseUrlType,
           baseUrl:
             baseUrlType === "StringLiteral" ? secondArgNode.value : undefined,
+          astInfo: { node: firstArgNode },
         });
       }
       if (baseUrlType === "StringLiteral") {
@@ -65,6 +67,7 @@ export const analyzeNewUrlCall = (node, { isJsModule, onUrl }) => {
           end: specifierNode.end,
           line: specifierNode.loc.start.line,
           column: specifierNode.loc.start.column,
+          astInfo: { node: specifierNode },
         });
       }
     }

package/src/js/js_static_analysis/system.js

@@ -38,6 +38,7 @@ const analyzeSystemRegisterDeps = (node, { onUrl }) => {
         end: specifierNode.end,
         line: specifierNode.loc.start.line,
         column: specifierNode.loc.start.column,
+        astInfo: { node: specifierNode },
       });
     }
   });
@@ -69,6 +70,7 @@ export const analyzeSystemImportCall = (node, { onUrl }) => {
       end: specifierNode.end,
       line: specifierNode.loc.start.line,
       column: specifierNode.loc.start.column,
+      astInfo: { node: specifierNode },
     });
   }
 };
@@ -101,6 +103,7 @@ export const analyzeSystemResolveCall = (node, { onUrl }) => {
       end: specifierNode.end,
       line: specifierNode.loc.start.line,
       column: specifierNode.loc.start.column,
+      astInfo: { node: specifierNode },
     });
   }
 };

package/src/js/js_static_analysis/web_worker.js

@@ -26,6 +26,7 @@ export const analyzeImportScriptCalls = (node, { onUrl }) => {
         end: specifierNode.end,
         line: specifierNode.loc.start.line,
         column: specifierNode.loc.start.column,
+        astInfo: { node: specifierNode },
       });
     }
   });

package/src/js/js_static_analysis/web_worker_entry_point.js

@@ -122,38 +122,41 @@ const analyzeWorkerCallArguments = (
       subtype: referenceSubtype,
       expectedType,
       expectedSubtype,
-      typePropertyNode,
       specifier: specifierNode.value,
       start: specifierNode.start,
       end: specifierNode.end,
       line: specifierNode.loc.start.line,
       column: specifierNode.loc.start.column,
+      astInfo: {
+        node,
+        typePropertyNode,
+      },
     });
     return;
   }
   if (isNewUrlCall(firstArgNode)) {
     analyzeNewUrlCall(firstArgNode, {
       isJsModule,
-      onUrl: (mention) => {
-        Object.assign(mention, {
+      onUrl: (info) => {
+        info.astInfo.typePropertyNode = typePropertyNode;
+        Object.assign(info, {
           expectedType,
           expectedSubtype,
-          typePropertyNode,
         });
-        onUrl(mention);
+        onUrl(info);
       },
     });
     return;
   }
   if (isJsModule && isImportMetaResolveCall(firstArgNode)) {
     analyzeImportMetaResolveCall(firstArgNode, {
-      onUrl: (mention) => {
-        Object.assign(mention, {
+      onUrl: (info) => {
+        info.astInfo.typePropertyNode = typePropertyNode;
+        Object.assign(info, {
           expectedType,
           expectedSubtype,
-          typePropertyNode,
         });
-        onUrl(mention);
+        onUrl(info);
       },
     });
     return;

package/src/js/parse_js_urls.js

@@ -48,19 +48,22 @@ import {
   analyzeJSONParseCall,
 } from "./js_static_analysis/json_parse.js";
 
-export const parseJsUrls = async ({
+export const parseJsUrls = ({
   js,
   url,
+  ast,
   isJsModule = false,
   isWebWorker = false,
   inlineContent = true,
 } = {}) => {
   const jsUrls = [];
-  const jsAst = await parseJsWithAcorn({
-    js,
-    url,
-    isJsModule,
-  });
+  if (ast === undefined) {
+    ast = parseJsWithAcorn({
+      js,
+      url,
+      isJsModule,
+    });
+  }
   const onUrl = (jsUrl) => {
     jsUrls.push(jsUrl);
   };
@@ -70,7 +73,7 @@ export const parseJsUrls = async ({
       ...inlineContentInfo,
     });
   };
-  ancestor(jsAst, {
+  ancestor(ast, {
     ImportDeclaration: (node) => {
       analyzeImportDeclaration(node, { onUrl });
     },

package/src/js/parse_js_with_acorn.js

@@ -1,10 +1,11 @@
+import { Parser, getLineInfo } from "acorn";
+import { importAssertions } from "acorn-import-assertions";
+
 import { createJsParseError } from "./js_parse_error.js";
 
-let AcornParser;
-let _getLineInfo;
+export const parseJsWithAcorn = ({ js, url, isJsModule }) => {
+  const AcornParser = Parser.extend(importAssertions);
 
-export const parseJsWithAcorn = async ({ js, url, isJsModule }) => {
-  await initAcornParser();
   try {
     // https://github.com/acornjs/acorn/tree/master/acorn#interface
     const jsAst = AcornParser.parse(js, {
@@ -16,10 +17,11 @@ export const parseJsWithAcorn = async ({ js, url, isJsModule }) => {
     return jsAst;
   } catch (e) {
     if (e && e.name === "SyntaxError") {
-      const { line, column } = _getLineInfo(js, e.raisedAt);
+      const { line, column } = getLineInfo(js, e.raisedAt);
       throw createJsParseError({
         message: e.message,
         reasonCode: e.message,
+        content: js,
         url,
         line,
         column,
@@ -28,14 +30,3 @@ export const parseJsWithAcorn = async ({ js, url, isJsModule }) => {
     throw e;
   }
 };
-
-const initAcornParser = async () => {
-  if (AcornParser) {
-    return;
-  }
-  const { Parser, getLineInfo } = await import("acorn");
-  const { importAssertions } = await import("acorn-import-assertions");
-
-  AcornParser = Parser.extend(importAssertions);
-  _getLineInfo = getLineInfo;
-};

package/src/js/visit_js_ast_until.js

@@ -0,0 +1,30 @@
+import { simple } from "acorn-walk";
+
+const stop = {};
+
+export const visitJsAstUntil = (ast, visitors) => {
+  const visitorsMapped = {};
+  let returnValue = null;
+  Object.keys(visitors).forEach((key) => {
+    visitorsMapped[key] = (node, ...args) => {
+      const visitorReturnValue = visitors[key](node, ...args);
+      if (visitorReturnValue === true) {
+        returnValue = node;
+        throw stop;
+      }
+      if (typeof visitorReturnValue === "object" && returnValue !== null) {
+        returnValue = visitorReturnValue;
+        throw stop;
+      }
+    };
+  });
+  try {
+    simple(ast, visitorsMapped);
+    return returnValue;
+  } catch (e) {
+    if (e === stop) {
+      return returnValue;
+    }
+    throw e;
+  }
+};

package/src/main.js

@@ -42,3 +42,4 @@ export { applyBabelPlugins } from "./js/apply_babel_plugins.js";
 export { injectJsImport } from "./js/babel_utils.js";
 export { parseJsWithAcorn } from "./js/parse_js_with_acorn.js";
 export { parseJsUrls } from "./js/parse_js_urls.js";
+export { visitJsAstUntil } from "./js/visit_js_ast_until.js";