@jsenv/core 37.1.5 → 38.0.0

package/src/plugins/plugin_controller.js

@@ -23,7 +23,17 @@ const HOOK_NAMES = [
   "destroy",
 ];
 
-export const createPluginController = (kitchenContext) => {
+export const createPluginController = (
+  kitchenContext,
+  initialPuginsMeta = {},
+) => {
+  const pluginsMeta = initialPuginsMeta;
+
+  kitchenContext.getPluginMeta = (id) => {
+    const value = pluginsMeta[id];
+    return value;
+  };
+
   const plugins = [];
   // precompute a list of hooks per hookName for one major reason:
   // - When debugging, there is less iteration
@@ -42,29 +52,43 @@ export const createPluginController = (kitchenContext) => {
     if (plugin === null || typeof plugin !== "object") {
       throw new TypeError(`plugin must be objects, got ${plugin}`);
     }
+    if (!plugin.name) {
+      plugin.name = "anonymous";
+    }
     if (!testAppliesDuring(plugin) || !initPlugin(plugin)) {
       if (plugin.destroy) {
         plugin.destroy();
       }
       return;
     }
-    if (!plugin.name) {
-      plugin.name = "anonymous";
-    }
     plugins.push(plugin);
-    Object.keys(plugin).forEach((key) => {
+    for (const key of Object.keys(plugin)) {
+      if (key === "meta") {
+        const value = plugin[key];
+        if (typeof value !== "object" || value === null) {
+          console.warn(`plugin.meta must be an object, got ${value}`);
+          continue;
+        }
+        Object.assign(pluginsMeta, value);
+        // any extension/modification on plugin.meta
+        // won't be taken into account so we freeze object
+        // to throw in case it happen
+        Object.freeze(value);
+        continue;
+      }
+
       if (
         key === "name" ||
         key === "appliesDuring" ||
         key === "init" ||
-        key === "serverEvents" ||
-        key === "meta"
+        key === "serverEvents"
       ) {
-        return;
+        continue;
       }
       const isHook = HOOK_NAMES.includes(key);
       if (!isHook) {
         console.warn(`Unexpected "${key}" property on "${plugin.name}" plugin`);
+        continue;
       }
       const hookName = key;
       const hookValue = plugin[hookName];
@@ -81,7 +105,7 @@ export const createPluginController = (kitchenContext) => {
           group.push(hook);
         }
       }
-    });
+    }
   };
   const testAppliesDuring = (plugin) => {
     const { appliesDuring } = plugin;
@@ -121,7 +145,7 @@ export const createPluginController = (kitchenContext) => {
   };
   const initPlugin = (plugin) => {
     if (plugin.init) {
-      const initReturnValue = plugin.init(kitchenContext);
+      const initReturnValue = plugin.init(kitchenContext, plugin);
       if (initReturnValue === false) {
         return false;
       }
@@ -204,13 +228,12 @@ export const createPluginController = (kitchenContext) => {
   const callAsyncHooks = async (hookName, info, callback) => {
     const hooks = hookGroups[hookName];
     if (hooks) {
-      await hooks.reduce(async (previous, hook) => {
-        await previous;
+      for (const hook of hooks) {
         const returnValue = await callAsyncHook(hook, info);
         if (returnValue && callback) {
           await callback(returnValue, hook.plugin);
         }
-      }, Promise.resolve());
+      }
     }
   };
 
@@ -252,17 +275,8 @@ export const createPluginController = (kitchenContext) => {
     });
   };
 
-  const getPluginMeta = (id) => {
-    for (const plugin of plugins) {
-      const { meta } = plugin;
-      if (meta && meta[id] !== undefined) {
-        return meta[id];
-      }
-    }
-    return undefined;
-  };
-
   return {
+    pluginsMeta,
     plugins,
     pushPlugin,
     unshiftPlugin,
@@ -275,8 +289,6 @@ export const createPluginController = (kitchenContext) => {
     callAsyncHooks,
     callAsyncHooksUntil,
 
-    getPluginMeta,
-
     getLastPluginUsed: () => lastPluginUsed,
     getCurrentPlugin: () => currentPlugin,
     getCurrentHookName: () => currentHookName,

package/src/plugins/plugins.js

@@ -19,6 +19,7 @@ import { jsenvPluginAutoreload } from "./autoreload/jsenv_plugin_autoreload.js";
 import { jsenvPluginCacheControl } from "./cache_control/jsenv_plugin_cache_control.js";
 // other
 import { jsenvPluginRibbon } from "./ribbon/jsenv_plugin_ribbon.js";
+import { jsenvPluginCleanHTML } from "./clean_html/jsenv_plugin_clean_html.js";
 
 export const getCorePlugins = ({
   rootDirectoryUrl,
@@ -85,5 +86,6 @@ export const getCorePlugins = ({
       : []),
     ...(cacheControl ? [jsenvPluginCacheControl(cacheControl)] : []),
     ...(ribbon ? [jsenvPluginRibbon({ rootDirectoryUrl, ...ribbon })] : []),
+    jsenvPluginCleanHTML(),
   ];
 };

package/src/plugins/protocol_file/jsenv_plugin_protocol_file.js

@@ -92,7 +92,11 @@ export const jsenvPluginProtocolFile = ({
             url = filesystemResolution.url;
           }
         }
-        if (stat && stat.isDirectory()) {
+        if (!stat) {
+          return null;
+        }
+        reference.leadsToADirectory = stat && stat.isDirectory();
+        if (reference.leadsToADirectory) {
           const directoryAllowed =
             reference.type === "filesystem" ||
             (typeof directoryReferenceAllowed === "function" &&
@@ -104,13 +108,9 @@ export const jsenvPluginProtocolFile = ({
             throw error;
           }
         }
-        reference.leadsToADirectory = stat && stat.isDirectory();
-        if (stat) {
-          const urlRaw = preserveSymlinks ? url : resolveSymlink(url);
-          const resolvedUrl = `${urlRaw}${search}${hash}`;
-          return resolvedUrl;
-        }
-        return null;
+        const urlRaw = preserveSymlinks ? url : resolveSymlink(url);
+        const resolvedUrl = `${urlRaw}${search}${hash}`;
+        return resolvedUrl;
       },
     },
     {
@@ -120,7 +120,7 @@ export const jsenvPluginProtocolFile = ({
         filesystem: (reference) => {
           const ownerUrlInfo = reference.ownerUrlInfo;
           const baseUrl =
-            ownerUrlInfo && ownerUrlInfo.type === "directory"
+            ownerUrlInfo.type === "directory"
               ? ensurePathnameTrailingSlash(ownerUrlInfo.url)
               : ownerUrlInfo.url;
           return new URL(reference.specifier, baseUrl).href;
@@ -164,19 +164,28 @@ export const jsenvPluginProtocolFile = ({
         const urlObject = new URL(urlInfo.url);
         if (urlInfo.firstReference.leadsToADirectory) {
           const directoryEntries = readdirSync(urlObject);
-          let filename;
-          if (urlInfo.firstReference.type === "filesystem") {
-            filename = `${urlInfo.firstReference.ownerUrlInfo.filename}${urlInfo.firstReference.specifier}/`;
-          } else {
-            filename = `${urlToFilename(urlInfo.url)}/`;
+          if (!urlInfo.filenameHint) {
+            if (urlInfo.firstReference.type === "filesystem") {
+              urlInfo.filenameHint = `${
+                urlInfo.firstReference.ownerUrlInfo.filenameHint
+              }${urlToFilename(urlInfo.url)}/`;
+            } else {
+              urlInfo.filenameHint = `${urlToFilename(urlInfo.url)}/`;
+            }
           }
           return {
             type: "directory",
             contentType: "application/json",
             content: JSON.stringify(directoryEntries, null, "  "),
-            filename,
           };
         }
+        if (
+          !urlInfo.dirnameHint &&
+          urlInfo.firstReference.ownerUrlInfo.type === "directory"
+        ) {
+          urlInfo.dirnameHint =
+            urlInfo.firstReference.ownerUrlInfo.filenameHint;
+        }
         const fileBuffer = readFileSync(urlObject);
         const contentType = CONTENT_TYPE.fromUrlExtension(urlInfo.url);
         const content = CONTENT_TYPE.isTextual(contentType)
@@ -192,5 +201,11 @@ export const jsenvPluginProtocolFile = ({
 };
 
 const resolveSymlink = (fileUrl) => {
-  return pathToFileURL(realpathSync(new URL(fileUrl))).href;
+  const urlObject = new URL(fileUrl);
+  const realpath = realpathSync(urlObject);
+  const realUrlObject = pathToFileURL(realpath);
+  if (urlObject.pathname.endsWith("/")) {
+    realUrlObject.pathname += `/`;
+  }
+  return realUrlObject.href;
 };

package/src/plugins/reference_analysis/directory/jsenv_plugin_directory_reference_analysis.js

@@ -4,23 +4,29 @@ export const jsenvPluginDirectoryReferenceAnalysis = () => {
   return {
     name: "jsenv:directory_reference_analysis",
     transformUrlContent: {
-      directory: (urlInfo) => {
+      directory: async (urlInfo) => {
         const originalDirectoryReference =
           findOriginalDirectoryReference(urlInfo);
         const directoryRelativeUrl = urlToRelativeUrl(
           urlInfo.url,
           urlInfo.context.rootDirectoryUrl,
         );
-        JSON.parse(urlInfo.content).forEach((directoryEntryName) => {
-          urlInfo.dependencies.found({
+        const entryNames = JSON.parse(urlInfo.content);
+        const newEntryNames = [];
+        for (const entryName of entryNames) {
+          const entryReference = urlInfo.dependencies.found({
             type: "filesystem",
             subtype: "directory_entry",
-            specifier: directoryEntryName,
+            specifier: entryName,
             trace: {
-              message: `"${directoryRelativeUrl}${directoryEntryName}" entry in directory referenced by ${originalDirectoryReference.trace.message}`,
+              message: `"${directoryRelativeUrl}${entryName}" entry in directory referenced by ${originalDirectoryReference.trace.message}`,
             },
           });
-        });
+          await entryReference.readGeneratedSpecifier();
+          const replacement = entryReference.generatedSpecifier;
+          newEntryNames.push(replacement);
+        }
+        return JSON.stringify(newEntryNames);
       },
     },
   };

package/src/plugins/reference_analysis/html/jsenv_plugin_html_reference_analysis.js

@@ -11,9 +11,8 @@ import {
   analyzeScriptNode,
   parseSrcSet,
   stringifyHtmlAst,
+  getUrlForContentInsideHtml,
 } from "@jsenv/ast";
-import { generateInlineContentUrl } from "@jsenv/urls";
-import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 
 export const jsenvPluginHtmlReferenceAnalysis = ({
   inlineContent,
@@ -146,18 +145,14 @@ const parseAndTransformHtmlReferences = async (
   const createInlineReference = (
     node,
     inlineContent,
-    { extension, type, subtype, expectedType, contentType },
+    { type, expectedType, contentType },
   ) => {
     const hotAccept = getHtmlNodeAttribute(node, "hot-accept") !== undefined;
-    const { line, column, lineEnd, columnEnd, isOriginal } =
-      getHtmlNodePosition(node, { preferOriginal: true });
-    const inlineContentUrl = generateInlineContentUrl({
-      url: urlInfo.url,
-      extension,
-      line,
-      column,
-      lineEnd,
-      columnEnd,
+    const { line, column, isOriginal } = getHtmlNodePosition(node, {
+      preferOriginal: true,
+    });
+    const inlineContentUrl = getUrlForContentInsideHtml(node, {
+      htmlUrl: urlInfo.url,
     });
     const debug = getHtmlNodeAttribute(node, "jsenv-debug") !== undefined;
     const inlineReference = urlInfo.dependencies.foundInline({
@@ -176,33 +171,6 @@ const parseAndTransformHtmlReferences = async (
       astInfo: { node },
     });
 
-    const externalSpecifierAttributeName =
-      type === "script"
-        ? "inlined-from-src"
-        : type === "style"
-        ? "inlined-from-href"
-        : null;
-    if (externalSpecifierAttributeName) {
-      const externalSpecifier = getHtmlNodeAttribute(
-        node,
-        externalSpecifierAttributeName,
-      );
-      if (externalSpecifier) {
-        // create an external ref
-        // the goal is only to have the url in the graph (and in dependencies/implicit urls for reload)
-        // not to consider the url is actually used (at least during build)
-        // maybe we can just exclude these urls in a special if during build, we'll see
-        const externalRef = createExternalReference(
-          node,
-          externalSpecifierAttributeName,
-          externalSpecifier,
-          { type, subtype, expectedType, next: inlineReference },
-        );
-        inlineReference.prev = externalRef;
-        inlineReference.original = externalRef;
-      }
-    }
-
     actions.push(async () => {
       await inlineReference.urlInfo.cook();
       mutations.push(() => {
@@ -225,14 +193,13 @@ const parseAndTransformHtmlReferences = async (
   };
   const visitTextContent = (
     node,
-    { extension, type, subtype, expectedType, contentType },
+    { type, subtype, expectedType, contentType },
   ) => {
     const inlineContent = getHtmlNodeText(node);
     if (!inlineContent) {
       return null;
     }
     return createInlineReference(node, inlineContent, {
-      extension,
       type,
       subtype,
       expectedType,
@@ -252,14 +219,17 @@ const parseAndTransformHtmlReferences = async (
       });
       if (ref) {
         finalizeCallbacks.push(() => {
-          ref.expectedType = decideLinkExpectedType(ref, urlInfo);
+          if (ref.expectedType) {
+            // might be set by other plugins, in that case respect it
+          } else {
+            ref.expectedType = decideLinkExpectedType(ref, urlInfo);
+          }
         });
       }
     },
     style: inlineContent
       ? (styleNode) => {
           visitTextContent(styleNode, {
-            extension: ".css",
             type: "style",
             expectedType: "css",
             contentType: "text/css",
@@ -307,20 +277,28 @@ const parseAndTransformHtmlReferences = async (
       }
 
       const inlineRef = visitTextContent(scriptNode, {
-        extension: extension || CONTENT_TYPE.asFileExtension(contentType),
         type: "script",
         subtype,
         expectedType: type,
         contentType,
       });
-      if (inlineRef && extension) {
+      if (inlineRef) {
         // 1. <script type="jsx"> becomes <script>
+        if (type === "js_classic" && extension !== ".js") {
+          mutations.push(() => {
+            setHtmlNodeAttributes(scriptNode, {
+              type: undefined,
+            });
+          });
+        }
         // 2. <script type="module/jsx"> becomes <script type="module">
-        mutations.push(() => {
-          setHtmlNodeAttributes(scriptNode, {
-            type: type === "js_module" ? "module" : undefined,
+        if (type === "js_module" && extension !== ".js") {
+          mutations.push(() => {
+            setHtmlNodeAttributes(scriptNode, {
+              type: "module",
+            });
           });
-        });
+        }
       }
     },
     a: (aNode) => {
@@ -412,12 +390,13 @@ const decideLinkExpectedType = (linkReference, htmlUrlInfo) => {
     }
     if (as === "script") {
       for (const referenceToOther of htmlUrlInfo.referenceToOthersSet) {
-        if (
-          referenceToOther.url === linkReference.url &&
-          referenceToOther.type === "script"
-        ) {
-          return referenceToOther.expectedType;
+        if (referenceToOther.url !== linkReference.url) {
+          continue;
+        }
+        if (referenceToOther.type !== "script") {
+          continue;
         }
+        return referenceToOther.expectedType;
       }
       return undefined;
     }

package/src/plugins/reference_analysis/js/jsenv_plugin_js_reference_analysis.js

@@ -1,8 +1,6 @@
 import { createMagicSource } from "@jsenv/sourcemap";
-import { parseJsUrls } from "@jsenv/ast";
-import { generateInlineContentUrl } from "@jsenv/urls";
+import { parseJsUrls, getUrlForContentInsideJs } from "@jsenv/ast";
 import { JS_QUOTES } from "@jsenv/utils/src/string/js_quotes.js";
-import { CONTENT_TYPE } from "@jsenv/utils/src/content_type/content_type.js";
 
 import { isWebWorkerUrlInfo } from "@jsenv/core/src/kitchen/web_workers.js";
 
@@ -38,13 +36,8 @@ const parseAndTransformJsReferences = async (
   const sequentialActions = [];
 
   const onInlineReference = (inlineReferenceInfo) => {
-    const inlineUrl = generateInlineContentUrl({
+    const inlineUrl = getUrlForContentInsideJs(inlineReferenceInfo, {
       url: urlInfo.url,
-      extension: CONTENT_TYPE.asFileExtension(inlineReferenceInfo.contentType),
-      line: inlineReferenceInfo.line,
-      column: inlineReferenceInfo.column,
-      lineEnd: inlineReferenceInfo.lineEnd,
-      columnEnd: inlineReferenceInfo.columnEnd,
     });
     let { quote } = inlineReferenceInfo;
     if (quote === "`" && !canUseTemplateLiterals) {

package/src/plugins/reference_analysis/jsenv_plugin_reference_analysis.js

@@ -38,22 +38,29 @@ const jsenvPluginInlineContentFetcher = () => {
       if (!urlInfo.isInline) {
         return null;
       }
-      const { firstReference } = urlInfo;
-      const { prev } = firstReference;
+      // - we must use last reference because
+      //   when updating the file, first reference is the previous version
+      // - we cannot use urlInfo.lastReference because it can be the reference created by "http_request"
+      let lastInlineReference;
+      for (const reference of urlInfo.referenceFromOthersSet) {
+        if (reference.isInline) {
+          lastInlineReference = reference;
+        }
+      }
+      const { prev } = lastInlineReference;
       if (prev && !prev.isInline) {
         // got inlined, cook original url
-        if (firstReference.content === undefined) {
+        if (lastInlineReference.content === undefined) {
           const originalUrlInfo = prev.urlInfo;
           await originalUrlInfo.cook();
-          firstReference.content = originalUrlInfo.content;
-          firstReference.contentType = originalUrlInfo.contentType;
+          lastInlineReference.content = originalUrlInfo.content;
+          lastInlineReference.contentType = originalUrlInfo.contentType;
         }
       }
-
       return {
         originalContent: urlInfo.originalContent,
-        content: firstReference.content,
-        contentType: firstReference.contentType,
+        content: lastInlineReference.content,
+        contentType: lastInlineReference.contentType,
       };
     },
   };