@jsenv/core 31.0.0 → 31.1.0

package/dist/main.js

@@ -20,6 +20,7 @@ import { parseHtmlString, stringifyHtmlAst, getHtmlNodeAttribute, visitHtmlNodes
 import { createRequire } from "node:module";
 import babelParser from "@babel/parser";
 import { bundleJsModules } from "@jsenv/plugin-bundling";
+import { replacePlaceholders } from "@jsenv/plugin-placeholders";
 import v8, { takeCoverage } from "node:v8";
 import wrapAnsi from "wrap-ansi";
 import stripAnsi from "strip-ansi";
@@ -9225,7 +9226,13 @@ ${ANSI.color(normalizedReturnValue, ANSI.YELLOW)}
       } = urlInfo;
       if (generatedUrl && generatedUrl.startsWith("file:")) {
         if (urlInfo.type === "directory") ; else if (urlInfo.content === null) ; else {
-          writeFileSync(new URL(generatedUrl), urlInfo.content);
+          let contentIsInlined = urlInfo.isInline;
+          if (contentIsInlined && context.supervisor && urlGraph.getUrlInfo(urlInfo.inlineUrlSite.url).type === "html") {
+            contentIsInlined = false;
+          }
+          if (!contentIsInlined) {
+            writeFileSync(new URL(generatedUrl), urlInfo.content);
+          }
           const {
             sourcemapGeneratedUrl,
             sourcemap
@@ -17971,6 +17978,30 @@ const babelPluginMetadataImportMetaScenarios = () => {
   };
 };
 
+/*
+ * Source code can contain the following
+ * - __dev__
+ * - __build__
+ * A global will be injected with true/false when needed
+ */
+const jsenvPluginGlobalScenarios = () => {
+  const transformIfNeeded = (urlInfo, context) => {
+    return replacePlaceholders(urlInfo, {
+      false: context.dev,
+      true: context.build
+    });
+  };
+  return {
+    name: "jsenv:global_scenario",
+    appliesDuring: "*",
+    transformUrlContent: {
+      js_classic: transformIfNeeded,
+      js_module: transformIfNeeded,
+      html: transformIfNeeded
+    }
+  };
+};
+
 const jsenvPluginCssTranspilation = () => {
   return {
     name: "jsenv:css_transpilation",
@@ -20303,7 +20334,7 @@ const getCorePlugins = ({
     runtimeCompat,
     clientMainFileUrl,
     urlResolution
-  }), jsenvPluginUrlVersion(), jsenvPluginCommonJsGlobals(), jsenvPluginImportMetaScenarios(), jsenvPluginNodeRuntime({
+  }), jsenvPluginUrlVersion(), jsenvPluginCommonJsGlobals(), jsenvPluginImportMetaScenarios(), jsenvPluginGlobalScenarios(), jsenvPluginNodeRuntime({
     runtimeCompat
   }), jsenvPluginImportMetaHot(), ...(clientAutoreload ? [jsenvPluginAutoreload({
     ...clientAutoreload,
@@ -22256,6 +22287,7 @@ const createFileService = ({
   logLevel,
   serverStopCallbacks,
   serverEventsDispatcher,
+  contextCache,
   rootDirectoryUrl,
   runtimeCompat,
   plugins,
@@ -22319,7 +22351,6 @@ const createFileService = ({
     }
   });
   serverStopCallbacks.push(stopWatchingClientFiles);
-  const contextCache = new Map();
   const getOrCreateContext = request => {
     const {
       runtimeName,
@@ -22380,6 +22411,7 @@ const createFileService = ({
         cacheControl,
         ribbon
       })],
+      supervisor,
       minification: false,
       sourcemaps,
       sourcemapsSourcesProtocol,
@@ -22849,6 +22881,7 @@ const startDevServer = async ({
   serverStopCallbacks.push(() => {
     serverEventsDispatcher.destroy();
   });
+  const contextCache = new Map();
   const server = await startServer({
     signal,
     stopOnExit: false,
@@ -22877,6 +22910,7 @@ const startDevServer = async ({
         logLevel,
         serverStopCallbacks,
         serverEventsDispatcher,
+        contextCache,
         rootDirectoryUrl,
         runtimeCompat,
         plugins,
@@ -22967,7 +23001,8 @@ const startDevServer = async ({
     origin: server.origin,
     stop: () => {
       server.stop();
-    }
+    },
+    contextCache
   };
 };
 
@@ -23965,7 +24000,7 @@ const descriptionFormatters = {
   }) => {
     return ANSI.color(`${UNICODE.FAILURE_RAW} execution ${index + 1} of ${total} timeout after ${executionParams.allocatedMs}ms`, EXECUTION_COLORS.timedout);
   },
-  efailedrrored: ({
+  failed: ({
     index,
     total
   }) => {
@@ -26153,30 +26188,46 @@ const startBuildServer = async ({
   },
   buildServerAutoreload = false,
   buildServerMainFile = getCallerPosition().url,
-  cooldownBetweenFileEvents
+  cooldownBetweenFileEvents,
+  ...rest
 }) => {
-  const logger = createLogger({
-    logLevel
-  });
-  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl);
-  buildDirectoryUrl = assertAndNormalizeDirectoryUrl(buildDirectoryUrl);
-  if (buildIndexPath) {
-    if (typeof buildIndexPath !== "string") {
-      throw new TypeError(`buildIndexPath must be a string, got ${buildIndexPath}`);
+  // params validation
+  {
+    const unexpectedParamNames = Object.keys(rest);
+    if (unexpectedParamNames.length > 0) {
+      throw new TypeError(`${unexpectedParamNames.join(",")}: there is no such param`);
     }
-    if (buildIndexPath[0] === "/") {
-      buildIndexPath = buildIndexPath.slice(1);
-    } else {
-      const buildIndexUrl = new URL(buildIndexPath, buildDirectoryUrl).href;
-      if (!buildIndexUrl.startsWith(buildDirectoryUrl)) {
-        throw new Error(`buildIndexPath must be relative, got ${buildIndexPath}`);
-      }
-      buildIndexPath = buildIndexUrl.slice(buildDirectoryUrl.length);
+    const rootDirectoryUrlValidation = validateDirectoryUrl(rootDirectoryUrl);
+    if (!rootDirectoryUrlValidation.valid) {
+      throw new TypeError(`rootDirectoryUrl ${rootDirectoryUrlValidation.message}, got ${rootDirectoryUrl}`);
     }
-    if (!existsSync(new URL(buildIndexPath, buildDirectoryUrl))) {
-      buildIndexPath = null;
+    rootDirectoryUrl = rootDirectoryUrlValidation.value;
+    const buildDirectoryUrlValidation = validateDirectoryUrl(buildDirectoryUrl);
+    if (!buildDirectoryUrlValidation.valid) {
+      throw new TypeError(`buildDirectoryUrl ${buildDirectoryUrlValidation.message}, got ${buildDirectoryUrlValidation}`);
+    }
+    buildDirectoryUrl = buildDirectoryUrlValidation.value;
+    if (buildIndexPath) {
+      if (typeof buildIndexPath !== "string") {
+        throw new TypeError(`buildIndexPath must be a string, got ${buildIndexPath}`);
+      }
+      if (buildIndexPath[0] === "/") {
+        buildIndexPath = buildIndexPath.slice(1);
+      } else {
+        const buildIndexUrl = new URL(buildIndexPath, buildDirectoryUrl).href;
+        if (!buildIndexUrl.startsWith(buildDirectoryUrl)) {
+          throw new Error(`buildIndexPath must be relative, got ${buildIndexPath}`);
+        }
+        buildIndexPath = buildIndexUrl.slice(buildDirectoryUrl.length);
+      }
+      if (!existsSync(new URL(buildIndexPath, buildDirectoryUrl))) {
+        buildIndexPath = null;
+      }
     }
   }
+  const logger = createLogger({
+    logLevel
+  });
   const operation = Abort.startOperation();
   operation.addAbortSignal(signal);
   if (handleSIGINT) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "31.0.0",
+  "version": "31.1.0",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {
@@ -75,6 +75,7 @@
     "@jsenv/log": "3.3.4",
     "@jsenv/node-esm-resolution": "1.0.1",
     "@jsenv/plugin-bundling": "2.0.0",
+    "@jsenv/plugin-globals": "1.1.0",
     "@jsenv/server": "15.0.0",
     "@jsenv/sourcemap": "1.0.9",
     "@jsenv/uneval": "1.6.0",
@@ -113,6 +114,6 @@
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-react": "7.32.2",
     "playwright": "1.31.2",
-    "prettier": "2.8.4"
+    "prettier": "2.8.6"
   }
 }

package/src/build/start_build_server.js

@@ -23,7 +23,7 @@ import {
   jsenvServiceErrorHandler,
 } from "@jsenv/server"
 import {
-  assertAndNormalizeDirectoryUrl,
+  validateDirectoryUrl,
   registerDirectoryLifecycle,
 } from "@jsenv/filesystem"
 import { Abort, raceProcessTeardownEvents } from "@jsenv/abort"
@@ -62,32 +62,55 @@ export const startBuildServer = async ({
   buildServerAutoreload = false,
   buildServerMainFile = getCallerPosition().url,
   cooldownBetweenFileEvents,
+  ...rest
 }) => {
-  const logger = createLogger({ logLevel })
-  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-  buildDirectoryUrl = assertAndNormalizeDirectoryUrl(buildDirectoryUrl)
-  if (buildIndexPath) {
-    if (typeof buildIndexPath !== "string") {
+  // params validation
+  {
+    const unexpectedParamNames = Object.keys(rest)
+    if (unexpectedParamNames.length > 0) {
+      throw new TypeError(
+        `${unexpectedParamNames.join(",")}: there is no such param`,
+      )
+    }
+    const rootDirectoryUrlValidation = validateDirectoryUrl(rootDirectoryUrl)
+    if (!rootDirectoryUrlValidation.valid) {
+      throw new TypeError(
+        `rootDirectoryUrl ${rootDirectoryUrlValidation.message}, got ${rootDirectoryUrl}`,
+      )
+    }
+    rootDirectoryUrl = rootDirectoryUrlValidation.value
+    const buildDirectoryUrlValidation = validateDirectoryUrl(buildDirectoryUrl)
+    if (!buildDirectoryUrlValidation.valid) {
       throw new TypeError(
-        `buildIndexPath must be a string, got ${buildIndexPath}`,
+        `buildDirectoryUrl ${buildDirectoryUrlValidation.message}, got ${buildDirectoryUrlValidation}`,
       )
     }
-    if (buildIndexPath[0] === "/") {
-      buildIndexPath = buildIndexPath.slice(1)
-    } else {
-      const buildIndexUrl = new URL(buildIndexPath, buildDirectoryUrl).href
-      if (!buildIndexUrl.startsWith(buildDirectoryUrl)) {
-        throw new Error(
-          `buildIndexPath must be relative, got ${buildIndexPath}`,
+    buildDirectoryUrl = buildDirectoryUrlValidation.value
+
+    if (buildIndexPath) {
+      if (typeof buildIndexPath !== "string") {
+        throw new TypeError(
+          `buildIndexPath must be a string, got ${buildIndexPath}`,
         )
       }
-      buildIndexPath = buildIndexUrl.slice(buildDirectoryUrl.length)
-    }
-    if (!existsSync(new URL(buildIndexPath, buildDirectoryUrl))) {
-      buildIndexPath = null
+      if (buildIndexPath[0] === "/") {
+        buildIndexPath = buildIndexPath.slice(1)
+      } else {
+        const buildIndexUrl = new URL(buildIndexPath, buildDirectoryUrl).href
+        if (!buildIndexUrl.startsWith(buildDirectoryUrl)) {
+          throw new Error(
+            `buildIndexPath must be relative, got ${buildIndexPath}`,
+          )
+        }
+        buildIndexPath = buildIndexUrl.slice(buildDirectoryUrl.length)
+      }
+      if (!existsSync(new URL(buildIndexPath, buildDirectoryUrl))) {
+        buildIndexPath = null
+      }
     }
   }
 
+  const logger = createLogger({ logLevel })
   const operation = Abort.startOperation()
   operation.addAbortSignal(signal)
   if (handleSIGINT) {

package/src/dev/file_service.js

@@ -20,6 +20,7 @@ export const createFileService = ({
   logLevel,
   serverStopCallbacks,
   serverEventsDispatcher,
+  contextCache,
 
   rootDirectoryUrl,
   runtimeCompat,
@@ -82,7 +83,6 @@ export const createFileService = ({
   })
   serverStopCallbacks.push(stopWatchingClientFiles)
 
-  const contextCache = new Map()
   const getOrCreateContext = (request) => {
     const { runtimeName, runtimeVersion } = parseUserAgentHeader(
       request.headers["user-agent"],
@@ -150,6 +150,7 @@ export const createFileService = ({
           ribbon,
         }),
       ],
+      supervisor,
       minification: false,
       sourcemaps,
       sourcemapsSourcesProtocol,

package/src/dev/start_dev_server.js

@@ -173,6 +173,7 @@ export const startDevServer = async ({
   serverStopCallbacks.push(() => {
     serverEventsDispatcher.destroy()
   })
+  const contextCache = new Map()
   const server = await startServer({
     signal,
     stopOnExit: false,
@@ -208,6 +209,7 @@ export const startDevServer = async ({
           logLevel,
           serverStopCallbacks,
           serverEventsDispatcher,
+          contextCache,
 
           rootDirectoryUrl,
           runtimeCompat,
@@ -304,5 +306,6 @@ export const startDevServer = async ({
     stop: () => {
       server.stop()
     },
+    contextCache,
   }
 }

package/src/kitchen/kitchen.js

@@ -673,7 +673,17 @@ ${ANSI.color(normalizedReturnValue, ANSI.YELLOW)}
           // (error hapenning before urlInfo.content can be set, or 404 for instance)
           // in that case we can't write anything
         } else {
-          writeFileSync(new URL(generatedUrl), urlInfo.content)
+          let contentIsInlined = urlInfo.isInline
+          if (
+            contentIsInlined &&
+            context.supervisor &&
+            urlGraph.getUrlInfo(urlInfo.inlineUrlSite.url).type === "html"
+          ) {
+            contentIsInlined = false
+          }
+          if (!contentIsInlined) {
+            writeFileSync(new URL(generatedUrl), urlInfo.content)
+          }
           const { sourcemapGeneratedUrl, sourcemap } = urlInfo
           if (sourcemapGeneratedUrl && sourcemap) {
             writeFileSync(

package/src/plugins/global_scenarios/jsenv_plugin_global_scenarios.js

@@ -0,0 +1,27 @@
+/*
+ * Source code can contain the following
+ * - __dev__
+ * - __build__
+ * A global will be injected with true/false when needed
+ */
+
+import { replacePlaceholders } from "@jsenv/plugin-placeholders"
+
+export const jsenvPluginGlobalScenarios = () => {
+  const transformIfNeeded = (urlInfo, context) => {
+    return replacePlaceholders(urlInfo, {
+      __DEV__: context.dev,
+      __BUILD__: context.build,
+    })
+  }
+
+  return {
+    name: "jsenv:global_scenario",
+    appliesDuring: "*",
+    transformUrlContent: {
+      js_classic: transformIfNeeded,
+      js_module: transformIfNeeded,
+      html: transformIfNeeded,
+    },
+  }
+}

package/src/plugins/plugins.js

@@ -8,6 +8,7 @@ import { jsenvPluginInline } from "./inline/jsenv_plugin_inline.js"
 import { jsenvPluginSupervisor } from "./supervisor/jsenv_plugin_supervisor.js"
 import { jsenvPluginCommonJsGlobals } from "./commonjs_globals/jsenv_plugin_commonjs_globals.js"
 import { jsenvPluginImportMetaScenarios } from "./import_meta_scenarios/jsenv_plugin_import_meta_scenarios.js"
+import { jsenvPluginGlobalScenarios } from "./global_scenarios/jsenv_plugin_global_scenarios.js"
 import { jsenvPluginTranspilation } from "./transpilation/jsenv_plugin_transpilation.js"
 import { jsenvPluginNodeRuntime } from "./node_runtime/jsenv_plugin_node_runtime.js"
 // autoreload
@@ -89,6 +90,7 @@ export const getCorePlugins = ({
     jsenvPluginUrlVersion(),
     jsenvPluginCommonJsGlobals(),
     jsenvPluginImportMetaScenarios(),
+    jsenvPluginGlobalScenarios(),
 
     jsenvPluginNodeRuntime({ runtimeCompat }),
 

package/src/test/logs_file_execution.js

@@ -221,7 +221,7 @@ const descriptionFormatters = {
       EXECUTION_COLORS.timedout,
     )
   },
-  efailedrrored: ({ index, total }) => {
+  failed: ({ index, total }) => {
     return ANSI.color(
       `${UNICODE.FAILURE_RAW} execution ${index + 1} of ${total} failed`,
       EXECUTION_COLORS.failed,