@jsenv/core 40.0.2 → 40.0.3

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "40.0.2",
+  "version": "40.0.3",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {
@@ -78,22 +78,22 @@
   "dependencies": {
     "@financial-times/polyfill-useragent-normaliser": "1.10.2",
     "@jsenv/abort": "4.3.1",
-    "@jsenv/ast": "6.6.1",
-    "@jsenv/filesystem": "4.14.1",
+    "@jsenv/ast": "6.6.2",
+    "@jsenv/filesystem": "4.14.2",
     "@jsenv/humanize": "1.3.1",
     "@jsenv/importmap": "1.2.2",
     "@jsenv/integrity": "0.0.2",
-    "@jsenv/js-module-fallback": "1.4.1",
+    "@jsenv/js-module-fallback": "1.4.2",
     "@jsenv/node-esm-resolution": "1.1.0",
-    "@jsenv/plugin-bundling": "2.8.1",
+    "@jsenv/plugin-bundling": "2.8.2",
     "@jsenv/plugin-minification": "1.6.0",
-    "@jsenv/plugin-supervisor": "1.6.8",
-    "@jsenv/plugin-transpilation": "1.5.1",
+    "@jsenv/plugin-supervisor": "1.6.9",
+    "@jsenv/plugin-transpilation": "1.5.2",
     "@jsenv/runtime-compat": "1.3.4",
     "@jsenv/server": "16.0.2",
-    "@jsenv/sourcemap": "1.3.1",
+    "@jsenv/sourcemap": "1.3.2",
     "@jsenv/url-meta": "8.5.4",
-    "@jsenv/urls": "2.6.2",
+    "@jsenv/urls": "2.6.3",
     "@jsenv/utils": "2.2.1",
     "string-width": "7.2.0"
   },

package/src/build/build.js

@@ -20,6 +20,7 @@ import { Abort, raceProcessTeardownEvents } from "@jsenv/abort";
 import { parseHtml, stringifyHtmlAst } from "@jsenv/ast";
 import {
   assertAndNormalizeDirectoryUrl,
+  clearDirectorySync,
   ensureEmptyDirectory,
   lookupPackageDirectory,
   writeFileSync,
@@ -42,60 +43,48 @@ import {
 } from "../plugins/plugin_controller.js";
 import { getCorePlugins } from "../plugins/plugins.js";
 import { jsenvPluginReferenceAnalysis } from "../plugins/reference_analysis/jsenv_plugin_reference_analysis.js";
+import {
+  defaultRuntimeCompat,
+  getDefaultBase,
+  logsDefault,
+} from "./build_params.js";
 import { createBuildSpecifierManager } from "./build_specifier_manager.js";
 import { jsenvPluginLineBreakNormalization } from "./jsenv_plugin_line_break_normalization.js";
-
-// default runtimeCompat corresponds to
-// "we can keep <script type="module"> intact":
-// so script_type_module + dynamic_import + import_meta
-export const defaultRuntimeCompat = {
-  // android: "8",
-  chrome: "64",
-  edge: "79",
-  firefox: "67",
-  ios: "12",
-  opera: "51",
-  safari: "11.3",
-  samsung: "9.2",
-};
-const logsDefault = {
-  level: "info",
-  disabled: false,
-  animation: true,
-};
+import { jsenvPluginSubbuilds } from "./jsenv_plugin_subbuilds.js";
 
 /**
- * Generate an optimized version of source files into a directory
- * @param {Object} buildParameters
- * @param {string|url} buildParameters.sourceDirectoryUrl
+ * Generate an optimized version of source files into a directory.
+ *
+ * @param {Object} params
+ * @param {string|url} params.sourceDirectoryUrl
  *        Directory containing source files
- * @param {string|url} buildParameters.buildDirectoryUrl
+ * @param {string|url} params.buildDirectoryUrl
  *        Directory where optimized files will be written
- * @param {object} buildParameters.entryPoints
+ * @param {object} params.entryPoints
  *        Object where keys are paths to source files and values are their future name in the build directory.
  *        Keys are relative to sourceDirectoryUrl
- * @param {object} buildParameters.runtimeCompat
+ * @param {object} params.runtimeCompat
  *        Code generated will be compatible with these runtimes
- * @param {string} [buildParameters.assetsDirectory=""]
+ * @param {string} [params.assetsDirectory=""]
  *        Directory where asset files will be written
- * @param {string|url} [buildParameters.base=""]
+ * @param {string|url} [params.base=""]
  *        Urls in build file contents will be prefixed with this string
- * @param {boolean|object} [buildParameters.bundling=true]
+ * @param {boolean|object} [params.bundling=true]
  *        Reduce number of files written in the build directory
- *  @param {boolean|object} [buildParameters.minification=true]
+ *  @param {boolean|object} [params.minification=true]
  *        Minify the content of files written into the build directory
- * @param {boolean} [buildParameters.versioning=true]
+ * @param {boolean} [params.versioning=true]
  *        Use versioning on files written in the build directory
- * @param {('search_param'|'filename')} [buildParameters.versioningMethod="search_param"]
+ * @param {('search_param'|'filename')} [params.versioningMethod="search_param"]
  *        Controls how url are versioned in the build directory
- * @param {('none'|'inline'|'file'|'programmatic')} [buildParameters.sourcemaps="none"]
+ * @param {('none'|'inline'|'file'|'programmatic')} [params.sourcemaps="none"]
  *        Generate sourcemaps in the build directory
- * @param {('error'|'copy'|'preserve')|function} [buildParameters.directoryReferenceEffect="error"]
+ * @param {('error'|'copy'|'preserve')|function} [params.directoryReferenceEffect="error"]
  *        What to do when a reference leads to a directory on the filesystem
- * @return {Object} buildReturnValue
- * @return {Object} buildReturnValue.buildInlineContents
+ * @return {Promise<Object>} buildReturnValue
+ * @return {Promise<Object>} buildReturnValue.buildInlineContents
  *        Contains content that is inline into build files
- * @return {Object} buildReturnValue.buildManifest
+ * @return {Promise<Object>} buildReturnValue.buildManifest
  *        Map build file paths without versioning to versioned file paths
  */
 export const build = async ({
@@ -107,9 +96,10 @@ export const build = async ({
   entryPoints = {},
   assetsDirectory = "",
   runtimeCompat = defaultRuntimeCompat,
-  base = runtimeCompat.node ? "./" : "/",
+  base = getDefaultBase(runtimeCompat),
   ignore,
 
+  subbuilds = [],
   plugins = [],
   referenceAnalysis = {},
   nodeEsmResolution,
@@ -132,7 +122,9 @@ export const build = async ({
   watch = false,
   http = false,
 
-  directoryToClean,
+  buildDirectoryCleanPatterns = {
+    "**/*": true,
+  },
   sourcemaps = "none",
   sourcemapsSourcesContent,
   writeOnFileSystem = true,
@@ -232,13 +224,6 @@ export const build = async ({
   if (assetsDirectory && assetsDirectory[assetsDirectory.length - 1] !== "/") {
     assetsDirectory = `${assetsDirectory}/`;
   }
-  if (directoryToClean === undefined) {
-    if (assetsDirectory === undefined) {
-      directoryToClean = buildDirectoryUrl;
-    } else {
-      directoryToClean = new URL(assetsDirectory, buildDirectoryUrl).href;
-    }
-  }
 
   const operation = Abort.startOperation();
   operation.addAbortSignal(signal);
@@ -284,7 +269,6 @@ build ${entryPointKeys.length} entry points`);
         break;
       }
     }
-    const rawRedirections = new Map();
     const entryUrls = [];
     const contextSharedDuringBuild = {
       buildStep: "craft",
@@ -310,21 +294,39 @@ build ${entryPointKeys.length} entry points`);
         ? new URL("craft/", outDirectoryUrl)
         : undefined,
     });
+
+    let subbuildResults = [];
+
     const rawPluginStore = createPluginStore([
+      ...jsenvPluginSubbuilds(subbuilds, {
+        parentBuildParams: {
+          sourceDirectoryUrl,
+          buildDirectoryUrl,
+          runtimeCompat,
+          bundling,
+          minification,
+          versioning,
+          versioningMethod,
+        },
+        onCustomBuildDirectory: (subBuildRelativeUrl) => {
+          buildDirectoryCleanPatterns = {
+            ...buildDirectoryCleanPatterns,
+            [`${subBuildRelativeUrl}**/*`]: false,
+          };
+        },
+        buildStart: async (params, index) => {
+          const result = await build({
+            ...params,
+            signal,
+            handleSIGINT: false,
+          });
+          subbuildResults[index] = result;
+          return result;
+        },
+      }),
       ...plugins,
       ...(bundling ? [jsenvPluginBundling(bundling)] : []),
       ...(minification ? [jsenvPluginMinification(minification)] : []),
-      {
-        appliesDuring: "build",
-        fetchUrlContent: (urlInfo) => {
-          if (urlInfo.firstReference.original) {
-            rawRedirections.set(
-              urlInfo.firstReference.original.url,
-              urlInfo.firstReference.url,
-            );
-          }
-        },
-      },
       ...getCorePlugins({
         rootDirectoryUrl: sourceDirectoryUrl,
         runtimeCompat,
@@ -694,9 +696,7 @@ build ${entryPointKeys.length} entry points`);
       buildSpecifierManager.getBuildInfo();
     if (writeOnFileSystem) {
       const writingFiles = createBuildTask("write files in build directory");
-      if (directoryToClean) {
-        await ensureEmptyDirectory(directoryToClean);
-      }
+      clearDirectorySync(buildDirectoryUrl, buildDirectoryCleanPatterns);
       const buildRelativeUrls = Object.keys(buildFileContents);
       buildRelativeUrls.forEach((buildRelativeUrl) => {
         writeFileSync(
@@ -720,6 +720,7 @@ build ${entryPointKeys.length} entry points`);
     return {
       ...(returnBuildInlineContents ? { buildInlineContents } : {}),
       ...(returnBuildManifest ? { buildManifest } : {}),
+      ...(subbuilds.length ? { subbuilds: subbuildResults } : {}),
     };
   };
 

package/src/build/build_params.js

@@ -0,0 +1,20 @@
+// default runtimeCompat corresponds to
+// "we can keep <script type="module"> intact":
+// so script_type_module + dynamic_import + import_meta
+export const defaultRuntimeCompat = {
+  // android: "8",
+  chrome: "64",
+  edge: "79",
+  firefox: "67",
+  ios: "12",
+  opera: "51",
+  safari: "11.3",
+  samsung: "9.2",
+};
+export const logsDefault = {
+  level: "info",
+  disabled: false,
+  animation: true,
+};
+export const getDefaultBase = (runtimeCompat) =>
+  runtimeCompat.node ? "./" : "/";

package/src/build/build_specifier_manager.js

@@ -259,6 +259,10 @@ export const createBuildSpecifierManager = ({
       return placeholder;
     },
     fetchUrlContent: async (finalUrlInfo) => {
+      // not need because it will be inherit from rawUrlInfo
+      // if (urlIsInsideOf(finalUrlInfo.url, buildDirectoryUrl)) {
+      //   finalUrlInfo.type = "asset";
+      // }
       let { firstReference } = finalUrlInfo;
       if (
         firstReference.isInline &&
@@ -1018,6 +1022,12 @@ export const createBuildSpecifierManager = ({
           if (!buildUrl) {
             return;
           }
+          if (
+            urlInfo.type === "asset" &&
+            urlIsInsideOf(urlInfo.url, buildDirectoryUrl)
+          ) {
+            return;
+          }
           const buildSpecifier = buildUrlToBuildSpecifierMap.get(buildUrl);
           const buildSpecifierVersioned = versioning
             ? buildSpecifierToBuildSpecifierVersionedMap.get(buildSpecifier)

package/src/build/build_urls_generator.js

@@ -1,5 +1,5 @@
 import { ANSI } from "@jsenv/humanize";
-import { urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
+import { urlIsInsideOf, urlToFilename, urlToRelativeUrl } from "@jsenv/urls";
 
 export const createBuildUrlsGenerator = ({
   logger,
@@ -33,6 +33,10 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
     if (buildUrlFromCache) {
       return buildUrlFromCache;
     }
+    if (urlIsInsideOf(url, buildDirectoryUrl)) {
+      buildUrlCache.set(url, url);
+      return url;
+    }
     if (
       urlInfo.type === "directory" ||
       (urlInfo.type === undefined && urlInfo.typeHint === "directory")

package/src/build/jsenv_plugin_subbuilds.js

@@ -0,0 +1,71 @@
+import { urlToRelativeUrl } from "@jsenv/urls";
+import { defaultRuntimeCompat, getDefaultBase } from "./build_params.js";
+
+export const jsenvPluginSubbuilds = (
+  subBuildParamsArray,
+  { parentBuildParams, onCustomBuildDirectory, buildStart },
+) => {
+  if (subBuildParamsArray.length === 0) {
+    return [];
+  }
+  return subBuildParamsArray.map((subBuildParams, index) => {
+    const defaultChildBuildParams = {};
+    const childBuildParams = {
+      ...parentBuildParams,
+      logs: {
+        level: "warn",
+        disabled: true,
+      },
+      ...defaultChildBuildParams,
+      ...subBuildParams,
+    };
+    const subBuildDirectoryUrl = subBuildParams.buildDirectoryUrl;
+    if (subBuildDirectoryUrl) {
+      const subBuildRelativeUrl = urlToRelativeUrl(
+        subBuildDirectoryUrl,
+        parentBuildParams.buildDirectoryUrl,
+      );
+      const subbuildRuntimeCompat =
+        childBuildParams.runtimeCompat || defaultRuntimeCompat;
+      const subbuildBase =
+        subBuildParams.base || getDefaultBase(subbuildRuntimeCompat);
+      childBuildParams.base = `${subbuildBase}${subBuildRelativeUrl}`;
+      onCustomBuildDirectory(subBuildRelativeUrl);
+    }
+    const buildPromise = buildStart(childBuildParams, index);
+    const entryPointBuildUrlMap = new Map();
+    const entryPointSourceUrlSet = new Set();
+    const entryPointBuildUrlSet = new Set();
+    const childBuildEntryPoints = childBuildParams.entryPoints;
+    for (const key of Object.keys(childBuildEntryPoints)) {
+      const entryPointUrl = new URL(key, childBuildParams.sourceDirectoryUrl)
+        .href;
+      const entryPointBuildUrl = new URL(
+        childBuildEntryPoints[key],
+        childBuildParams.buildDirectoryUrl,
+      ).href;
+      entryPointBuildUrlMap.set(entryPointUrl, entryPointBuildUrl);
+      entryPointSourceUrlSet.add(entryPointUrl);
+      entryPointBuildUrlSet.add(entryPointBuildUrl);
+    }
+
+    return {
+      name: `jsenv:subbuild_${index}`,
+      redirectReference: (reference) => {
+        const entryPointBuildUrl = entryPointBuildUrlMap.get(reference.url);
+        if (!entryPointBuildUrl) {
+          return null;
+        }
+        return entryPointBuildUrl;
+      },
+      fetchUrlContent: async (urlInfo) => {
+        if (!entryPointBuildUrlSet.has(urlInfo.url)) {
+          return null;
+        }
+        await buildPromise;
+        urlInfo.typeHint = "asset"; // this ensure the rest of jsenv do not scan or modify the content of this file
+        return null;
+      },
+    };
+  });
+};

package/src/dev/start_dev_server.js

@@ -16,7 +16,7 @@ import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/in
 import { URL_META } from "@jsenv/url-meta";
 import { urlIsInsideOf, urlToRelativeUrl } from "@jsenv/urls";
 import { existsSync, readFileSync } from "node:fs";
-import { defaultRuntimeCompat } from "../build/build.js";
+import { defaultRuntimeCompat } from "../build/build_params.js";
 import { createEventEmitter } from "../helpers/event_emitter.js";
 import { watchSourceFiles } from "../helpers/watch_source_files.js";
 import { WEB_URL_CONVERTER } from "../helpers/web_url_converter.js";
@@ -33,12 +33,26 @@ import { parseUserAgentHeader } from "./user_agent.js";
 const EXECUTED_BY_TEST_PLAN = process.argv.includes("--jsenv-test");
 
 /**
- * Start a server for source files:
- * - cook source files according to jsenv plugins
- * - inject code to autoreload the browser when a file is modified
- * @param {Object} devServerParameters
- * @param {string|url} devServerParameters.sourceDirectoryUrl Root directory of the project
- * @return {Object} A dev server object
+ * Starts the development server.
+ *
+ * @param {Object} [params={}] - Configuration params for the dev server.
+ * @param {number} [params.port=3456] - Port number the server should listen on.
+ * @param {string} [params.hostname="localhost"] - Hostname to bind the server to.
+ * @param {boolean} [params.https=false] - Whether to use HTTPS.
+ *
+ * @returns {Promise<Object>} A promise that resolves to the server instance.
+ * @throws {Error} Will throw an error if the server fails to start or is called with unexpected params.
+ *
+ * @example
+ * // Start a basic dev server
+ * const server = await startDevServer();
+ * console.log(`Server started at ${server.origin}`);
+ *
+ * @example
+ * // Start a server with custom params
+ * const server = await startDevServer({
+ *   port: 8080,
+ * });
  */
 export const startDevServer = async ({
   sourceDirectoryUrl,

package/src/kitchen/fetched_content_compliance.js

@@ -12,9 +12,13 @@ export const assertFetchedContentCompliance = ({ urlInfo, content }) => {
   }
   const { expectedType } = urlInfo.firstReference;
   if (expectedType && urlInfo.type !== expectedType) {
-    throw new Error(
-      `type must be "${expectedType}", got "${urlInfo.type}" on ${urlInfo.url}`,
-    );
+    if (urlInfo.type === "asset" && urlInfo.context.build) {
+      // asset is a valid type during build
+    } else {
+      throw new Error(
+        `type must be "${expectedType}", got "${urlInfo.type}" on ${urlInfo.url}`,
+      );
+    }
   }
   const { integrity } = urlInfo.firstReference;
   if (integrity) {

package/src/kitchen/kitchen.js

@@ -681,6 +681,9 @@ const inferUrlInfoType = (urlInfo) => {
   const { type, typeHint } = urlInfo;
   const mediaType = CONTENT_TYPE.asMediaType(urlInfo.contentType);
   const { expectedType } = urlInfo.firstReference;
+  if (typeHint === "asset") {
+    return "asset";
+  }
   if (type === "sourcemap" || typeHint === "sourcemap") {
     return "sourcemap";
   }

package/src/plugins/autoreload/jsenv_plugin_autoreload_client.js

@@ -1,10 +1,7 @@
 import { injectJsenvScript, parseHtml, stringifyHtmlAst } from "@jsenv/ast";
 
 export const jsenvPluginAutoreloadClient = () => {
-  const autoreloadClientFileUrl = new URL(
-    "./client/autoreload.js",
-    import.meta.url,
-  ).href;
+  const autoreloadClientFileUrl = import.meta.resolve("./client/autoreload.js");
 
   return {
     name: "jsenv:autoreload_client",

package/src/plugins/html_syntax_error_fallback/jsenv_plugin_html_syntax_error_fallback.js

@@ -5,9 +5,8 @@ import { readFileSync } from "node:fs";
 import { jsenvCoreDirectoryUrl } from "../../jsenv_core_directory_url.js";
 
 export const jsenvPluginHtmlSyntaxErrorFallback = () => {
-  const htmlSyntaxErrorFileUrl = new URL(
+  const htmlSyntaxErrorFileUrl = import.meta.resolve(
     "./client/html_syntax_error.html",
-    import.meta.url,
   );
 
   return {
@@ -55,7 +54,9 @@ const generateHtmlForSyntaxError = (
   htmlSyntaxError,
   { htmlUrl, rootDirectoryUrl, htmlErrorContentFrame, htmlSyntaxErrorFileUrl },
 ) => {
-  const htmlForSyntaxError = String(readFileSync(htmlSyntaxErrorFileUrl));
+  const htmlForSyntaxError = String(
+    readFileSync(new URL(htmlSyntaxErrorFileUrl)),
+  );
   const htmlRelativeUrl = urlToRelativeUrl(htmlUrl, rootDirectoryUrl);
   const { line, column } = htmlSyntaxError;
   if (htmlUrl.startsWith(jsenvCoreDirectoryUrl.href)) {

package/src/plugins/import_meta_hot/jsenv_plugin_import_meta_hot.js

@@ -5,10 +5,9 @@ import { babelPluginMetadataImportMetaHot } from "./babel_plugin_metadata_import
 import { collectHotDataFromHtmlAst } from "./html_hot_dependencies.js";
 
 export const jsenvPluginImportMetaHot = () => {
-  const importMetaHotClientFileUrl = new URL(
+  const importMetaHotClientFileUrl = import.meta.resolve(
     "./client/import_meta_hot.js",
-    import.meta.url,
-  ).href;
+  );
 
   return {
     name: "jsenv:import_meta_hot",

package/src/plugins/protocol_file/jsenv_plugin_directory_listing.js

@@ -41,9 +41,8 @@ import { getDirectoryWatchPatterns } from "../../helpers/watch_source_files.js";
 import { replacePlaceholders } from "../injections/jsenv_plugin_injections.js";
 import { FILE_AND_SERVER_URLS_CONVERTER } from "./file_and_server_urls_converter.js";
 
-const htmlFileUrlForDirectory = new URL(
+const htmlFileUrlForDirectory = import.meta.resolve(
   "./client/directory_listing.html",
-  import.meta.url,
 );
 
 export const jsenvPluginDirectoryListing = ({

package/src/plugins/ribbon/jsenv_plugin_ribbon.js

@@ -6,7 +6,7 @@ export const jsenvPluginRibbon = ({
   rootDirectoryUrl,
   htmlInclude = "/**/*.html",
 }) => {
-  const ribbonClientFileUrl = new URL("./client/ribbon.js", import.meta.url);
+  const ribbonClientFileUrl = import.meta.resolve("./client/ribbon.js");
   const associations = URL_META.resolveAssociations(
     {
       ribbon: {
@@ -45,7 +45,7 @@ export const jsenvPluginRibbon = ({
           type: "script",
           subtype: "js_module",
           expectedType: "js_module",
-          specifier: ribbonClientFileUrl.href,
+          specifier: ribbonClientFileUrl,
         });
         injectJsenvScript(htmlAst, {
           type: "module",