@jsenv/core 39.2.12 → 39.2.14

package/README.md

@@ -12,69 +12,22 @@ Jsenv is a suite of tools that can be used in projects involving JavaScript.
 It favors standards and simplicity.  
 As a result it can be enjoyed by people without much experience in tooling or seeking for simple tools without hidden complexities.
 
-If you want to try jsenv on your machine, use [#CLI](#cli).
+If you want to try jsenv on your machine, use [@jsenv/cli](./packages/related/cli/readme.md).
 
-Link to [documentation](./docs/users/users.md)
-
-# CLI
-
-The following command init jsenv on your machine.
-
-```console
-npx @jsenv/cli
-```
-
-> If you don't have `npx` command you must [install Node.js](https://nodejs.org/en/download/package-manager)
-
-The command init jsenv in a directory. It can be a new directory or an existing one.
-
-```console
-> npx @jsenv/cli
-Welcome in jsenv CLI
-? Enter a directory: ›
-```
-
-Then you'll be prompted to select a template.
-
-```console
-> npx @jsenv/cli
-✔ Enter a directory: › demo
-? Select a template: › - Use arrow-keys. Return to submit.
-❯   web
-    web-components
-    web-react
-    web-preact
-    node-package
-```
-
-A template is a project pre-configured with jsenv.  
-Selecting "web" would init [template-web/](./packages/related/cli/template-web/):
-
-```console
-> npx @jsenv/cli
-✔ Enter a directory: › demo
-✔ Select a template: › web
-✔ init jsenv in "[...]/demo/" (done in 0.01 second)
------ 2 commands to run -----
-cd demo
-npm install
------------------------------
-```
-
-<!-- For example in order to start a dev server you would rather do `npm run dev` that would be declared in [package.json#scripts.dev](./packages/related/create-jsenv/demo-web/package.json#L8) to execute [scripts/dev.mjs](./packages/related/create-jsenv/demo-web/scripts/dev.mjs). -->
+Link to [documentation](./md/users/users.md)
 
 # The best parts
 
-- Test files are [executed like standard files](./docs/users/d_test/d_test.md#14-executing-a-single-test)
-- [Isolated environment](./docs/users/d_test/d_test.md#33-isolated-environment) for each test file
-- Execute [tests in multiple browsers](./docs/users/d_test/d_test.md#32-execute-on-more-browsers>): Chrome, Safari, Firefox
-- [Large browser support during dev](./docs/users/b_dev/b_dev.md#21-browser-support>). Because some people might be happy to use an other browser than the latest chrome during dev. Moreover it is useful to reproduce bug specific to certain browsers.
-- [Large browser support after build](./docs/users/c_build/c_build.md#211-maximal-browser-support). Because some product still needs to support old versions of Firefox, Chrome and Safari.
-- [Single set of files after build](./docs/users/c_build/c_build.md#212-same-build-for-all-browsers). Because a single one is simpler to properly support in every aspects.
+- Test files are [executed like standard files](./md/users/d_test/d_test.md#14-executing-a-single-test)
+- [Isolated environment](./md/users/d_test/d_test.md#33-isolated-environment) for each test file
+- Execute [tests in multiple browsers](./md/users/d_test/d_test.md#32-execute-on-more-browsers>): Chrome, Safari, Firefox
+- [Large browser support during dev](./md/users/b_dev/b_dev.md#21-browser-support>). Because some people might be happy to use an other browser than the latest chrome during dev. Moreover it is useful to reproduce bug specific to certain browsers.
+- [Large browser support after build](./md/users/c_build/c_build.md#211-maximal-browser-support). Because some product still needs to support old versions of Firefox, Chrome and Safari.
+- [Single set of files after build](./md/users/c_build/c_build.md#212-same-build-for-all-browsers). Because a single one is simpler to properly support in every aspects.
 - Versioning during build is robust and <a href="https://bundlers.tooling.report/hashing/avoid-cascade/" target="_blank">avoids cascading hash changes</a><sup>↗</sup>
 - Advanced support of top level await, allowing to use it everywhere
 - Advanced support of web workers including worker type module
-- Unlock [js module features on a classic `<script>`](./docs/users/g_plugins/g_plugins.md#22-asjsclassic>).
+- Unlock [js module features on a classic `<script>`](./md/users/g_plugins/g_plugins.md#22-asjsclassic>).
 
 <!--
 The following commands can be used to skip the prompt

package/dist/jsenv_core.js

@@ -1401,6 +1401,38 @@ const resourceToPathname = (resource) => {
   return resource;
 };
 
+const urlToFilename$1 = (url) => {
+  const pathname = urlToPathname$1(url);
+  return pathnameToFilename(pathname);
+};
+
+const pathnameToFilename = (pathname) => {
+  const pathnameBeforeLastSlash = pathname.endsWith("/")
+    ? pathname.slice(0, -1)
+    : pathname;
+  const slashLastIndex = pathnameBeforeLastSlash.lastIndexOf("/");
+  const filename =
+    slashLastIndex === -1
+      ? pathnameBeforeLastSlash
+      : pathnameBeforeLastSlash.slice(slashLastIndex + 1);
+  return filename;
+};
+
+const urlToBasename = (url, removeAllExtensions) => {
+  const filename = urlToFilename$1(url);
+  const basename = filenameToBasename(filename);
+  {
+    return basename;
+  }
+};
+
+const filenameToBasename = (filename) => {
+  const dotLastIndex = filename.lastIndexOf(".");
+  const basename =
+    dotLastIndex === -1 ? filename : filename.slice(0, dotLastIndex);
+  return basename;
+};
+
 const urlToExtension$1 = (url) => {
   const pathname = urlToPathname$1(url);
   return pathnameToExtension$1(pathname);
@@ -1554,14 +1586,13 @@ const renderUrlOrRelativeUrlFilename = (urlOrRelativeUrl, renderer) => {
 };
 
 const setUrlFilename = (url, filename) => {
-  const urlObject = new URL(url);
-  let { origin, search, hash } = urlObject;
-  // origin is "null" for "file://" urls with Node.js
-  if (origin === "null" && urlObject.href.startsWith("file:")) {
-    origin = "file://";
-  }
-  const parentPathname = new URL("./", urlObject).pathname;
-  return `${origin}${parentPathname}${filename}${search}${hash}`;
+  const parentPathname = new URL("./", url).pathname;
+  return transformUrlPathname(url, (pathname) => {
+    if (typeof filename === "function") {
+      filename = filename(pathnameToFilename(pathname));
+    }
+    return `${parentPathname}${filename}`;
+  });
 };
 
 const transformUrlPathname = (url, transformer) => {
@@ -1773,27 +1804,6 @@ const urlIsInsideOf = (url, otherUrl) => {
   return isInside;
 };
 
-const urlToFilename$1 = (url) => {
-  const pathname = urlToPathname$1(url);
-  const pathnameBeforeLastSlash = pathname.endsWith("/")
-    ? pathname.slice(0, -1)
-    : pathname;
-  const slashLastIndex = pathnameBeforeLastSlash.lastIndexOf("/");
-  const filename =
-    slashLastIndex === -1
-      ? pathnameBeforeLastSlash
-      : pathnameBeforeLastSlash.slice(slashLastIndex + 1);
-  return filename;
-};
-
-const urlToBasename = (url) => {
-  const filename = urlToFilename$1(url);
-  const dotLastIndex = filename.lastIndexOf(".");
-  const basename =
-    dotLastIndex === -1 ? filename : filename.slice(0, dotLastIndex);
-  return basename;
-};
-
 const urlToFileSystemPath = (url) => {
   let urlString = String(url);
   if (urlString[urlString.length - 1] === "/") {
@@ -3283,6 +3293,203 @@ const writeDirectory = async (
   }
 };
 
+const mediaTypeInfos = {
+  "application/json": {
+    extensions: ["json", "map"],
+    isTextual: true,
+  },
+  "application/importmap+json": {
+    extensions: ["importmap"],
+    isTextual: true,
+  },
+  "application/manifest+json": {
+    extensions: ["webmanifest"],
+    isTextual: true,
+  },
+  "application/octet-stream": {},
+  "application/pdf": {
+    extensions: ["pdf"],
+  },
+  "application/xml": {
+    extensions: ["xml"],
+    isTextual: true,
+  },
+  "application/x-gzip": {
+    extensions: ["gz"],
+  },
+  "application/wasm": {
+    extensions: ["wasm"],
+  },
+  "application/zip": {
+    extensions: ["zip"],
+  },
+  "audio/basic": {
+    extensions: ["au", "snd"],
+  },
+  "audio/mpeg": {
+    extensions: ["mpga", "mp2", "mp2a", "mp3", "m2a", "m3a"],
+  },
+  "audio/midi": {
+    extensions: ["midi", "mid", "kar", "rmi"],
+  },
+  "audio/mp4": {
+    extensions: ["m4a", "mp4a"],
+  },
+  "audio/ogg": {
+    extensions: ["oga", "ogg", "spx"],
+  },
+  "audio/webm": {
+    extensions: ["weba"],
+  },
+  "audio/x-wav": {
+    extensions: ["wav"],
+  },
+  "font/ttf": {
+    extensions: ["ttf"],
+  },
+  "font/woff": {
+    extensions: ["woff"],
+  },
+  "font/woff2": {
+    extensions: ["woff2"],
+  },
+  "image/png": {
+    extensions: ["png"],
+  },
+  "image/gif": {
+    extensions: ["gif"],
+  },
+  "image/jpeg": {
+    extensions: ["jpg"],
+  },
+  "image/svg+xml": {
+    extensions: ["svg", "svgz"],
+    isTextual: true,
+  },
+  "text/plain": {
+    extensions: ["txt"],
+    isTextual: true,
+  },
+  "text/html": {
+    extensions: ["html"],
+    isTextual: true,
+  },
+  "text/css": {
+    extensions: ["css"],
+    isTextual: true,
+  },
+  "text/javascript": {
+    extensions: ["js", "cjs", "mjs", "ts", "jsx", "tsx"],
+    isTextual: true,
+  },
+  "text/markdown": {
+    extensions: ["md", "mdx"],
+    isTextual: true,
+  },
+  "text/x-sass": {
+    extensions: ["sass"],
+    isTextual: true,
+  },
+  "text/x-scss": {
+    extensions: ["scss"],
+    isTextual: true,
+  },
+  "text/cache-manifest": {
+    extensions: ["appcache"],
+  },
+  "video/mp4": {
+    extensions: ["mp4", "mp4v", "mpg4"],
+  },
+  "video/mpeg": {
+    extensions: ["mpeg", "mpg", "mpe", "m1v", "m2v"],
+  },
+  "video/ogg": {
+    extensions: ["ogv"],
+  },
+  "video/webm": {
+    extensions: ["webm"],
+  },
+};
+
+const CONTENT_TYPE = {
+  parse: (string) => {
+    const [mediaType, charset] = string.split(";");
+    return { mediaType: normalizeMediaType(mediaType), charset };
+  },
+
+  stringify: ({ mediaType, charset }) => {
+    if (charset) {
+      return `${mediaType};${charset}`;
+    }
+    return mediaType;
+  },
+
+  asMediaType: (value) => {
+    if (typeof value === "string") {
+      return CONTENT_TYPE.parse(value).mediaType;
+    }
+    if (typeof value === "object") {
+      return value.mediaType;
+    }
+    return null;
+  },
+
+  isJson: (value) => {
+    const mediaType = CONTENT_TYPE.asMediaType(value);
+    return (
+      mediaType === "application/json" ||
+      /^application\/\w+\+json$/.test(mediaType)
+    );
+  },
+
+  isTextual: (value) => {
+    const mediaType = CONTENT_TYPE.asMediaType(value);
+    if (mediaType.startsWith("text/")) {
+      return true;
+    }
+    const mediaTypeInfo = mediaTypeInfos[mediaType];
+    if (mediaTypeInfo && mediaTypeInfo.isTextual) {
+      return true;
+    }
+    // catch things like application/manifest+json, application/importmap+json
+    if (/^application\/\w+\+json$/.test(mediaType)) {
+      return true;
+    }
+    return false;
+  },
+
+  isBinary: (value) => !CONTENT_TYPE.isTextual(value),
+
+  asFileExtension: (value) => {
+    const mediaType = CONTENT_TYPE.asMediaType(value);
+    const mediaTypeInfo = mediaTypeInfos[mediaType];
+    return mediaTypeInfo ? `.${mediaTypeInfo.extensions[0]}` : "";
+  },
+
+  fromUrlExtension: (url) => {
+    const { pathname } = new URL(url);
+    const extensionWithDot = extname(pathname);
+    if (!extensionWithDot || extensionWithDot === ".") {
+      return "application/octet-stream";
+    }
+    const extension = extensionWithDot.slice(1);
+    const mediaTypeFound = Object.keys(mediaTypeInfos).find((mediaType) => {
+      const mediaTypeInfo = mediaTypeInfos[mediaType];
+      return (
+        mediaTypeInfo.extensions && mediaTypeInfo.extensions.includes(extension)
+      );
+    });
+    return mediaTypeFound || "application/octet-stream";
+  },
+};
+
+const normalizeMediaType = (value) => {
+  if (value === "application/javascript") {
+    return "text/javascript";
+  }
+  return value;
+};
+
 const writeFileSync = (destination, content = "") => {
   const destinationUrl = assertAndNormalizeFileUrl(destination);
   const destinationUrlObject = new URL(destinationUrl);
@@ -3552,203 +3759,6 @@ process.platform === "win32";
 
 process.platform === "win32";
 
-const mediaTypeInfos = {
-  "application/json": {
-    extensions: ["json", "map"],
-    isTextual: true,
-  },
-  "application/importmap+json": {
-    extensions: ["importmap"],
-    isTextual: true,
-  },
-  "application/manifest+json": {
-    extensions: ["webmanifest"],
-    isTextual: true,
-  },
-  "application/octet-stream": {},
-  "application/pdf": {
-    extensions: ["pdf"],
-  },
-  "application/xml": {
-    extensions: ["xml"],
-    isTextual: true,
-  },
-  "application/x-gzip": {
-    extensions: ["gz"],
-  },
-  "application/wasm": {
-    extensions: ["wasm"],
-  },
-  "application/zip": {
-    extensions: ["zip"],
-  },
-  "audio/basic": {
-    extensions: ["au", "snd"],
-  },
-  "audio/mpeg": {
-    extensions: ["mpga", "mp2", "mp2a", "mp3", "m2a", "m3a"],
-  },
-  "audio/midi": {
-    extensions: ["midi", "mid", "kar", "rmi"],
-  },
-  "audio/mp4": {
-    extensions: ["m4a", "mp4a"],
-  },
-  "audio/ogg": {
-    extensions: ["oga", "ogg", "spx"],
-  },
-  "audio/webm": {
-    extensions: ["weba"],
-  },
-  "audio/x-wav": {
-    extensions: ["wav"],
-  },
-  "font/ttf": {
-    extensions: ["ttf"],
-  },
-  "font/woff": {
-    extensions: ["woff"],
-  },
-  "font/woff2": {
-    extensions: ["woff2"],
-  },
-  "image/png": {
-    extensions: ["png"],
-  },
-  "image/gif": {
-    extensions: ["gif"],
-  },
-  "image/jpeg": {
-    extensions: ["jpg"],
-  },
-  "image/svg+xml": {
-    extensions: ["svg", "svgz"],
-    isTextual: true,
-  },
-  "text/plain": {
-    extensions: ["txt"],
-    isTextual: true,
-  },
-  "text/html": {
-    extensions: ["html"],
-    isTextual: true,
-  },
-  "text/css": {
-    extensions: ["css"],
-    isTextual: true,
-  },
-  "text/javascript": {
-    extensions: ["js", "cjs", "mjs", "ts", "jsx", "tsx"],
-    isTextual: true,
-  },
-  "text/markdown": {
-    extensions: ["md", "mdx"],
-    isTextual: true,
-  },
-  "text/x-sass": {
-    extensions: ["sass"],
-    isTextual: true,
-  },
-  "text/x-scss": {
-    extensions: ["scss"],
-    isTextual: true,
-  },
-  "text/cache-manifest": {
-    extensions: ["appcache"],
-  },
-  "video/mp4": {
-    extensions: ["mp4", "mp4v", "mpg4"],
-  },
-  "video/mpeg": {
-    extensions: ["mpeg", "mpg", "mpe", "m1v", "m2v"],
-  },
-  "video/ogg": {
-    extensions: ["ogv"],
-  },
-  "video/webm": {
-    extensions: ["webm"],
-  },
-};
-
-const CONTENT_TYPE = {
-  parse: (string) => {
-    const [mediaType, charset] = string.split(";");
-    return { mediaType: normalizeMediaType(mediaType), charset };
-  },
-
-  stringify: ({ mediaType, charset }) => {
-    if (charset) {
-      return `${mediaType};${charset}`;
-    }
-    return mediaType;
-  },
-
-  asMediaType: (value) => {
-    if (typeof value === "string") {
-      return CONTENT_TYPE.parse(value).mediaType;
-    }
-    if (typeof value === "object") {
-      return value.mediaType;
-    }
-    return null;
-  },
-
-  isJson: (value) => {
-    const mediaType = CONTENT_TYPE.asMediaType(value);
-    return (
-      mediaType === "application/json" ||
-      /^application\/\w+\+json$/.test(mediaType)
-    );
-  },
-
-  isTextual: (value) => {
-    const mediaType = CONTENT_TYPE.asMediaType(value);
-    if (mediaType.startsWith("text/")) {
-      return true;
-    }
-    const mediaTypeInfo = mediaTypeInfos[mediaType];
-    if (mediaTypeInfo && mediaTypeInfo.isTextual) {
-      return true;
-    }
-    // catch things like application/manifest+json, application/importmap+json
-    if (/^application\/\w+\+json$/.test(mediaType)) {
-      return true;
-    }
-    return false;
-  },
-
-  isBinary: (value) => !CONTENT_TYPE.isTextual(value),
-
-  asFileExtension: (value) => {
-    const mediaType = CONTENT_TYPE.asMediaType(value);
-    const mediaTypeInfo = mediaTypeInfos[mediaType];
-    return mediaTypeInfo ? `.${mediaTypeInfo.extensions[0]}` : "";
-  },
-
-  fromUrlExtension: (url) => {
-    const { pathname } = new URL(url);
-    const extensionWithDot = extname(pathname);
-    if (!extensionWithDot || extensionWithDot === ".") {
-      return "application/octet-stream";
-    }
-    const extension = extensionWithDot.slice(1);
-    const mediaTypeFound = Object.keys(mediaTypeInfos).find((mediaType) => {
-      const mediaTypeInfo = mediaTypeInfos[mediaType];
-      return (
-        mediaTypeInfo.extensions && mediaTypeInfo.extensions.includes(extension)
-      );
-    });
-    return mediaTypeFound || "application/octet-stream";
-  },
-};
-
-const normalizeMediaType = (value) => {
-  if (value === "application/javascript") {
-    return "text/javascript";
-  }
-  return value;
-};
-
 const ensureEmptyDirectory = async (source) => {
   const stats = await readEntryStat(source, {
     nullIfNotFound: true,
@@ -21777,8 +21787,10 @@ const defaultRuntimeCompat = {
  *        Use versioning on files written in the build directory
  * @param {('search_param'|'filename')} [buildParameters.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')} [buildParameters.sourcemaps="none"]
  *        Generate sourcemaps in the build directory
+ * @param {('error'|'copy'|'preserve')|function} [buildParameters.directoryReferenceEffect="error"]
+ *        What to do when a reference leads to a directory on the filesystem
  * @return {Object} buildReturnValue
  * @return {Object} buildReturnValue.buildInlineContents
  *        Contains content that is inline into build files
@@ -21825,6 +21837,8 @@ const build = async ({
   outDirectoryUrl,
   assetManifest = versioningMethod === "filename",
   assetManifestFileRelativeUrl = "asset-manifest.json",
+  returnBuildInlineContents,
+  returnBuildManifest,
   ...rest
 }) => {
   // param validation
@@ -22349,8 +22363,8 @@ build ${entryPointKeys.length} entry points`);
       }),
     );
     return {
-      buildInlineContents,
-      buildManifest,
+      ...(returnBuildInlineContents ? { buildInlineContents } : {}),
+      ...(returnBuildManifest ? { buildManifest } : {}),
     };
   };
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "39.2.12",
+  "version": "39.2.14",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {
@@ -52,7 +52,7 @@
     "monorepo:publish": "node ./scripts/monorepo/publish_packages.mjs",
     "monorepo:upgrade_versions": "node ./scripts/monorepo/upgrade_external_versions.mjs",
     "monorepo:node_modules_clear": "npx @jsenv/snapshot clear **/node_modules/",
-    "doc:build": "node ./docs/build.js",
+    "md:build": "node ./md/build.js",
     "performances": "node --expose-gc ./scripts/performance/generate_performance_report.mjs --log --once",
     "build:file_size": "node ./scripts/build/build_file_size.mjs --log",
     "prettier": "prettier --write .",
@@ -66,22 +66,22 @@
   "dependencies": {
     "@financial-times/polyfill-useragent-normaliser": "1.10.2",
     "@jsenv/abort": "4.3.0",
-    "@jsenv/ast": "6.2.10",
-    "@jsenv/filesystem": "4.9.5",
-    "@jsenv/humanize": "1.2.6",
+    "@jsenv/ast": "6.2.12",
+    "@jsenv/filesystem": "4.9.7",
+    "@jsenv/humanize": "1.2.7",
     "@jsenv/importmap": "1.2.1",
     "@jsenv/integrity": "0.0.2",
-    "@jsenv/js-module-fallback": "1.3.31",
+    "@jsenv/js-module-fallback": "1.3.33",
     "@jsenv/node-esm-resolution": "1.0.2",
-    "@jsenv/plugin-bundling": "2.7.2",
+    "@jsenv/plugin-bundling": "2.7.4",
     "@jsenv/plugin-minification": "1.5.5",
-    "@jsenv/plugin-supervisor": "1.5.11",
-    "@jsenv/plugin-transpilation": "1.4.15",
+    "@jsenv/plugin-supervisor": "1.5.13",
+    "@jsenv/plugin-transpilation": "1.4.17",
     "@jsenv/runtime-compat": "1.3.1",
-    "@jsenv/server": "15.2.16",
-    "@jsenv/sourcemap": "1.2.19",
+    "@jsenv/server": "15.2.17",
+    "@jsenv/sourcemap": "1.2.21",
     "@jsenv/url-meta": "8.5.0",
-    "@jsenv/urls": "2.4.1",
+    "@jsenv/urls": "2.5.1",
     "@jsenv/utils": "2.1.2",
     "anchor-markdown-header": "0.7.0"
   },

package/src/build/build.js

@@ -78,8 +78,10 @@ export const defaultRuntimeCompat = {
  *        Use versioning on files written in the build directory
  * @param {('search_param'|'filename')} [buildParameters.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')} [buildParameters.sourcemaps="none"]
  *        Generate sourcemaps in the build directory
+ * @param {('error'|'copy'|'preserve')|function} [buildParameters.directoryReferenceEffect="error"]
+ *        What to do when a reference leads to a directory on the filesystem
  * @return {Object} buildReturnValue
  * @return {Object} buildReturnValue.buildInlineContents
  *        Contains content that is inline into build files
@@ -126,6 +128,8 @@ export const build = async ({
   outDirectoryUrl,
   assetManifest = versioningMethod === "filename",
   assetManifestFileRelativeUrl = "asset-manifest.json",
+  returnBuildInlineContents,
+  returnBuildManifest,
   ...rest
 }) => {
   // param validation
@@ -652,8 +656,8 @@ build ${entryPointKeys.length} entry points`);
       }),
     );
     return {
-      buildInlineContents,
-      buildManifest,
+      ...(returnBuildInlineContents ? { buildInlineContents } : {}),
+      ...(returnBuildManifest ? { buildManifest } : {}),
     };
   };