@jsenv/core 32.0.1 → 32.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/core",
-  "version": "32.0.1",
+  "version": "32.1.0",
   "description": "Tool to develop, test and build js projects",
   "license": "MIT",
   "author": {
@@ -69,16 +69,16 @@
     "@jsenv/abort": "4.2.4",
     "@jsenv/ast": "3.0.3",
     "@jsenv/babel-plugins": "1.1.5",
-    "@jsenv/filesystem": "4.2.1",
+    "@jsenv/filesystem": "4.2.2",
     "@jsenv/importmap": "1.2.1",
     "@jsenv/integrity": "0.0.1",
     "@jsenv/log": "3.3.4",
     "@jsenv/node-esm-resolution": "1.0.1",
-    "@jsenv/plugin-bundling": "2.1.1",
-    "@jsenv/server": "15.0.1",
+    "@jsenv/plugin-bundling": "2.1.2",
+    "@jsenv/server": "15.0.2",
     "@jsenv/sourcemap": "1.0.9",
     "@jsenv/uneval": "1.6.0",
-    "@jsenv/url-meta": "8.0.0",
+    "@jsenv/url-meta": "8.1.0",
     "@jsenv/urls": "1.2.8",
     "@jsenv/utils": "2.0.1",
     "@paralleldrive/cuid2": "2.2.0",
@@ -112,7 +112,7 @@
     "eslint-plugin-html": "7.1.0",
     "eslint-plugin-import": "2.27.5",
     "eslint-plugin-react": "7.32.2",
-    "playwright": "1.31.2",
-    "prettier": "2.8.6"
+    "playwright": "1.32.1",
+    "prettier": "2.8.7"
   }
 }

package/src/build/build.js

@@ -53,7 +53,7 @@ import {
   findHtmlNode,
 } from "@jsenv/ast"
 
-import { determineJsenvInternalDirectoryUrl } from "../jsenv_internal_directory.js"
+import { lookupPackageDirectory } from "../lookup_package_directory.js"
 import { watchSourceFiles } from "../watch_source_files.js"
 import { createUrlGraph } from "../kitchen/url_graph.js"
 import { createKitchen } from "../kitchen/kitchen.js"
@@ -153,7 +153,7 @@ export const build = async ({
 
   directoryToClean,
   writeOnFileSystem = true,
-  writeGeneratedFiles = false,
+  outDirectoryUrl,
   assetManifest = versioningMethod === "filename",
   assetManifestFileRelativeUrl = "asset-manifest.json",
   ...rest
@@ -170,6 +170,21 @@ export const build = async ({
       sourceDirectoryUrl,
       "sourceDirectoryUrl",
     )
+    buildDirectoryUrl = assertAndNormalizeDirectoryUrl(
+      buildDirectoryUrl,
+      "buildDirectoryUrl",
+    )
+    if (outDirectoryUrl === undefined) {
+      const packageDirectoryUrl = lookupPackageDirectory(sourceDirectoryUrl)
+      if (packageDirectoryUrl) {
+        outDirectoryUrl = `${packageDirectoryUrl}.jsenv/`
+      }
+    } else {
+      outDirectoryUrl = assertAndNormalizeDirectoryUrl(
+        outDirectoryUrl,
+        "outDirectoryUrl",
+      )
+    }
 
     if (typeof entryPoints !== "object" || entryPoints === null) {
       throw new TypeError(`entryPoints must be an object, got ${entryPoints}`)
@@ -193,10 +208,6 @@ export const build = async ({
         )
       }
     })
-    buildDirectoryUrl = assertAndNormalizeDirectoryUrl(
-      buildDirectoryUrl,
-      "buildDirectoryUrl",
-    )
     if (!["filename", "search_param"].includes(versioningMethod)) {
       throw new TypeError(
         `versioningMethod must be "filename" or "search_param", got ${versioning}`,
@@ -227,8 +238,6 @@ export const build = async ({
       directoryToClean = new URL(assetsDirectory, buildDirectoryUrl).href
     }
   }
-  const jsenvInternalDirectoryUrl =
-    determineJsenvInternalDirectoryUrl(sourceDirectoryUrl)
 
   const asFormattedBuildUrl = (generatedUrl, reference) => {
     if (base === "./") {
@@ -299,7 +308,6 @@ build ${entryPointKeys.length} entry points`)
       signal,
       logLevel,
       rootDirectoryUrl: sourceDirectoryUrl,
-      jsenvInternalDirectoryUrl,
       urlGraph: rawGraph,
       build: true,
       runtimeCompat,
@@ -342,8 +350,9 @@ build ${entryPointKeys.length} entry points`)
       ],
       sourcemaps,
       sourcemapsSourcesContent,
-      writeGeneratedFiles,
-      outDirectoryUrl: new URL("build/", jsenvInternalDirectoryUrl),
+      outDirectoryUrl: outDirectoryUrl
+        ? new URL("build/", outDirectoryUrl)
+        : undefined,
     })
 
     const buildUrlsGenerator = createBuildUrlsGenerator({
@@ -373,7 +382,6 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
     const finalGraphKitchen = createKitchen({
       logLevel,
       rootDirectoryUrl: buildDirectoryUrl,
-      jsenvInternalDirectoryUrl,
       urlGraph: finalGraph,
       build: true,
       runtimeCompat,
@@ -663,8 +671,9 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
       sourcemaps,
       sourcemapsSourcesContent,
       sourcemapsSourcesRelative: !versioning,
-      writeGeneratedFiles,
-      outDirectoryUrl: new URL("postbuild/", jsenvInternalDirectoryUrl),
+      outDirectoryUrl: outDirectoryUrl
+        ? new URL("postbuild/", outDirectoryUrl)
+        : undefined,
     })
     const finalEntryUrls = []
 
@@ -673,8 +682,8 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
         disabled: logger.levels.debug || !logger.levels.info,
       })
       try {
-        if (writeGeneratedFiles) {
-          await ensureEmptyDirectory(new URL(`build/`, sourceDirectoryUrl))
+        if (outDirectoryUrl) {
+          await ensureEmptyDirectory(new URL(`build/`, outDirectoryUrl))
         }
         const rawUrlGraphLoader = createUrlGraphLoader(
           rawGraphKitchen.kitchenContext,
@@ -918,10 +927,8 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
           disabled: logger.levels.debug || !logger.levels.info,
         })
         try {
-          if (writeGeneratedFiles) {
-            await ensureEmptyDirectory(
-              new URL(`postbuild/`, jsenvInternalDirectoryUrl),
-            )
+          if (outDirectoryUrl) {
+            await ensureEmptyDirectory(new URL(`postbuild/`, outDirectoryUrl))
           }
           const finalUrlGraphLoader = createUrlGraphLoader(
             finalGraphKitchen.kitchenContext,
@@ -1149,7 +1156,6 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
           const versioningKitchen = createKitchen({
             logLevel: logger.level,
             rootDirectoryUrl: buildDirectoryUrl,
-            jsenvInternalDirectoryUrl,
             urlGraph: finalGraph,
             build: true,
             runtimeCompat,
@@ -1265,8 +1271,9 @@ ${ANSI.color(buildUrl, ANSI.MAGENTA)}
             sourcemaps,
             sourcemapsSourcesContent,
             sourcemapsSourcesRelative: true,
-            writeGeneratedFiles,
-            outDirectoryUrl: new URL("postbuild/", jsenvInternalDirectoryUrl),
+            outDirectoryUrl: outDirectoryUrl
+              ? new URL("postbuild/", outDirectoryUrl)
+              : undefined,
           })
           const versioningUrlGraphLoader = createUrlGraphLoader(
             versioningKitchen.kitchenContext,

package/src/dev/file_service.js

@@ -4,7 +4,6 @@ import { bufferToEtag } from "@jsenv/filesystem"
 import { moveUrl, asUrlWithoutSearch } from "@jsenv/urls"
 import { URL_META } from "@jsenv/url-meta"
 
-import { determineJsenvInternalDirectoryUrl } from "../jsenv_internal_directory.js"
 import { watchSourceFiles } from "../watch_source_files.js"
 import { explorerHtmlFileUrl } from "@jsenv/core/src/plugins/explorer/jsenv_plugin_explorer.js"
 import { createUrlGraph } from "@jsenv/core/src/kitchen/url_graph.js"
@@ -40,7 +39,7 @@ export const createFileService = ({
   sourcemaps,
   sourcemapsSourcesProtocol,
   sourcemapsSourcesContent,
-  writeGeneratedFiles,
+  outDirectoryUrl,
 }) => {
   const clientFileChangeCallbackList = []
   const clientFilesPruneCallbackList = []
@@ -90,8 +89,6 @@ export const createFileService = ({
       })
     })
     const clientRuntimeCompat = { [runtimeName]: runtimeVersion }
-    const jsenvInternalDirectoryUrl =
-      determineJsenvInternalDirectoryUrl(sourceDirectoryUrl)
 
     let mainFileUrl
     if (sourceMainFilePath === undefined) {
@@ -105,7 +102,6 @@ export const createFileService = ({
       signal,
       logLevel,
       rootDirectoryUrl: sourceDirectoryUrl,
-      jsenvInternalDirectoryUrl,
       urlGraph,
       dev: true,
       runtimeCompat,
@@ -143,11 +139,9 @@ export const createFileService = ({
       sourcemaps,
       sourcemapsSourcesProtocol,
       sourcemapsSourcesContent,
-      writeGeneratedFiles,
-      outDirectoryUrl: new URL(
-        `${runtimeName}@${runtimeVersion}/`,
-        jsenvInternalDirectoryUrl,
-      ),
+      outDirectoryUrl: outDirectoryUrl
+        ? new URL(`${runtimeName}@${runtimeVersion}/`, outDirectoryUrl)
+        : undefined,
     })
     urlGraph.createUrlInfoCallbackRef.current = (urlInfo) => {
       const { watch } = URL_META.applyAssociations({

package/src/dev/start_dev_server.js

@@ -9,6 +9,7 @@ import {
 } from "@jsenv/server"
 import { convertFileSystemErrorToResponseProperties } from "@jsenv/server/src/internal/convertFileSystemErrorToResponseProperties.js"
 
+import { lookupPackageDirectory } from "../lookup_package_directory.js"
 import { createServerEventsDispatcher } from "@jsenv/core/src/plugins/server_events/server_events_dispatcher.js"
 import { defaultRuntimeCompat } from "@jsenv/core/src/build/build.js"
 import { createFileService } from "./file_service.js"
@@ -62,9 +63,7 @@ export const startDevServer = async ({
   sourcemaps = "inline",
   sourcemapsSourcesProtocol,
   sourcemapsSourcesContent,
-  // no real need to write files during github workflow
-  // and mitigates https://github.com/actions/runner-images/issues/3885
-  writeGeneratedFiles = !process.env.CI,
+  outDirectoryUrl,
   ...rest
 }) => {
   // params type checking
@@ -79,6 +78,17 @@ export const startDevServer = async ({
       sourceDirectoryUrl,
       "sourceDirectoryUrl",
     )
+    if (outDirectoryUrl === undefined) {
+      const packageDirectoryUrl = lookupPackageDirectory(sourceDirectoryUrl)
+      if (packageDirectoryUrl) {
+        outDirectoryUrl = `${packageDirectoryUrl}.jsenv/`
+      }
+    } else {
+      outDirectoryUrl = assertAndNormalizeDirectoryUrl(
+        outDirectoryUrl,
+        "outDirectoryUrl",
+      )
+    }
   }
 
   const logger = createLogger({ logLevel })
@@ -182,7 +192,7 @@ export const startDevServer = async ({
           sourcemaps,
           sourcemapsSourcesProtocol,
           sourcemapsSourcesContent,
-          writeGeneratedFiles,
+          outDirectoryUrl,
         }),
         handleWebsocket: (websocket, { request }) => {
           if (request.headers["sec-websocket-protocol"] === "jsenv") {

package/src/kitchen/errors.js

@@ -31,6 +31,12 @@ export const createResolveUrlError = ({
       reason: `no plugin has handled the specifier during "resolveUrl" hook`,
     })
   }
+  if (error.code === "DIRECTORY_REFERENCE_NOT_ALLOWED") {
+    error.message = createDetailedMessage(error.message, {
+      "reference trace": reference.trace.message,
+    })
+    return error
+  }
   return createFailedToResolveUrlError({
     reason: `An error occured during specifier resolution`,
     ...detailsFromValueThrown(error),
@@ -114,6 +120,9 @@ export const createTransformUrlContentError = ({
   urlInfo,
   error,
 }) => {
+  if (error.code === "DIRECTORY_REFERENCE_NOT_ALLOWED") {
+    return error
+  }
   const createFailedToTransformError = ({
     code = error.code || "TRANSFORM_URL_CONTENT_ERROR",
     reason,

package/src/kitchen/kitchen.js

@@ -28,7 +28,6 @@ export const createKitchen = ({
   logLevel,
 
   rootDirectoryUrl,
-  jsenvInternalDirectoryUrl,
   urlGraph,
   dev = false,
   build = false,
@@ -43,7 +42,6 @@ export const createKitchen = ({
   sourcemapsSourcesProtocol,
   sourcemapsSourcesContent,
   sourcemapsSourcesRelative,
-  writeGeneratedFiles,
   outDirectoryUrl,
 }) => {
   const logger = createLogger({ logLevel })
@@ -51,7 +49,6 @@ export const createKitchen = ({
     signal,
     logger,
     rootDirectoryUrl,
-    jsenvInternalDirectoryUrl,
     urlGraph,
     dev,
     build,
@@ -112,6 +109,7 @@ export const createKitchen = ({
     assert,
     assertNode,
     typePropertyNode,
+    leadsToADirectory = false,
     debug = false,
   }) => {
     if (typeof specifier !== "string") {
@@ -165,6 +163,7 @@ export const createKitchen = ({
       assert,
       assertNode,
       typePropertyNode,
+      leadsToADirectory,
       mutation: null,
       debug,
     }
@@ -658,7 +657,7 @@ ${ANSI.color(normalizedReturnValue, ANSI.YELLOW)}
     )
   }
   const cook = memoizeCook(async (urlInfo, context) => {
-    if (!writeGeneratedFiles || !outDirectoryUrl) {
+    if (!outDirectoryUrl) {
       await _cook(urlInfo, context)
       return
     }

package/src/kitchen/url_graph/url_info_transformations.js

@@ -92,18 +92,21 @@ export const createUrlInfoTransformer = ({
     generatedUrlObject.searchParams.delete("as_js_classic_library")
     const urlForSourcemap = generatedUrlObject.href
     urlInfo.sourcemapGeneratedUrl = generateSourcemapFileUrl(urlForSourcemap)
-    const [sourcemapReference, sourcemapUrlInfo] = injectSourcemapPlaceholder({
-      urlInfo,
-      specifier: urlInfo.sourcemapGeneratedUrl,
-    })
-    urlInfo.sourcemapReference = sourcemapReference
-    sourcemapUrlInfo.isInline = sourcemaps === "inline"
 
     // already loaded during "load" hook (happens during build)
     if (urlInfo.sourcemap) {
+      const [sourcemapReference, sourcemapUrlInfo] = injectSourcemapPlaceholder(
+        {
+          urlInfo,
+          specifier: urlInfo.sourcemapGeneratedUrl,
+        },
+      )
+      sourcemapUrlInfo.isInline = sourcemaps === "inline"
+      urlInfo.sourcemapReference = sourcemapReference
       urlInfo.sourcemap = normalizeSourcemap(urlInfo, urlInfo.sourcemap)
       return
     }
+
     // check for existing sourcemap for this content
     const sourcemapFound = SOURCEMAP.readComment({
       contentType: urlInfo.contentType,
@@ -120,6 +123,7 @@ export const createUrlInfoTransformer = ({
       })
       try {
         await context.cook(sourcemapUrlInfo, { reference: sourcemapReference })
+        sourcemapUrlInfo.isInline = sourcemaps === "inline"
         const sourcemapRaw = JSON.parse(sourcemapUrlInfo.content)
         const sourcemap = normalizeSourcemap(urlInfo, sourcemapRaw)
         urlInfo.sourcemap = sourcemap
@@ -127,6 +131,12 @@ export const createUrlInfoTransformer = ({
         logger.error(`Error while handling existing sourcemap: ${e.message}`)
         return
       }
+    } else {
+      const [, sourcemapUrlInfo] = injectSourcemapPlaceholder({
+        urlInfo,
+        specifier: urlInfo.sourcemapGeneratedUrl,
+      })
+      sourcemapUrlInfo.isInline = sourcemaps === "inline"
     }
   }
 

package/src/plugins/file_urls/jsenv_plugin_file_urls.js

@@ -46,54 +46,66 @@ export const jsenvPluginFileUrls = ({
         const pathnameUsesTrailingSlash = pathname.endsWith("/")
         urlObject.search = ""
         urlObject.hash = ""
-        const foundADirectory = stat && stat.isDirectory()
-        const foundSomething = stat && !foundADirectory
         // force trailing slash on directories
-        if (foundADirectory && !pathnameUsesTrailingSlash) {
+        if (stat && stat.isDirectory() && !pathnameUsesTrailingSlash) {
           urlObject.pathname = `${pathname}/`
         }
         // otherwise remove trailing slash if any
-        if (foundSomething && pathnameUsesTrailingSlash) {
+        if (stat && !stat.isDirectory() && pathnameUsesTrailingSlash) {
           // a warning here? (because it's strange to reference a file with a trailing slash)
           urlObject.pathname = pathname.slice(0, -1)
         }
-        if (foundADirectory && directoryReferenceAllowed) {
-          if (
-            // ignore new URL second arg
-            reference.subtype === "new_url_second_arg" ||
+
+        let url = urlObject.href
+        const shouldPreserve =
+          stat &&
+          stat.isDirectory() &&
+          // ignore new URL second arg
+          (reference.subtype === "new_url_second_arg" ||
             // ignore root file url
-            reference.url === "file:///"
-          ) {
-            reference.shouldHandle = false
+            reference.url === "file:///" ||
+            (reference.subtype === "new_url_first_arg" &&
+              reference.specifier === "./"))
+
+        if (shouldPreserve) {
+          reference.shouldHandle = false
+        } else {
+          const shouldApplyDilesystemMagicResolution =
+            reference.type === "js_import"
+          if (shouldApplyDilesystemMagicResolution) {
+            const filesystemResolution = applyFileSystemMagicResolution(url, {
+              fileStat: stat,
+              magicDirectoryIndex,
+              magicExtensions: getExtensionsToTry(
+                magicExtensions,
+                reference.parentUrl,
+              ),
+            })
+            if (filesystemResolution.stat) {
+              stat = filesystemResolution.stat
+              url = filesystemResolution.url
+            }
+          }
+          if (stat && stat.isDirectory()) {
+            const directoryAllowed =
+              reference.type === "filesystem" ||
+              (typeof directoryReferenceAllowed === "function" &&
+                directoryReferenceAllowed(reference)) ||
+              directoryReferenceAllowed
+            if (!directoryAllowed) {
+              const error = new Error("Reference leads to a directory")
+              error.code = "DIRECTORY_REFERENCE_NOT_ALLOWED"
+              throw error
+            }
           }
-          reference.data.foundADirectory = true
-          const directoryFacadeUrl = urlObject.href
-          const directoryUrlRaw = preserveSymlinks
-            ? directoryFacadeUrl
-            : resolveSymlink(directoryFacadeUrl)
-          const directoryUrl = `${directoryUrlRaw}${search}${hash}`
-          return directoryUrl
         }
-        const url = urlObject.href
-        const filesystemResolution = applyFileSystemMagicResolution(url, {
-          fileStat: stat,
-          magicDirectoryIndex,
-          magicExtensions: getExtensionsToTry(
-            magicExtensions,
-            reference.parentUrl,
-          ),
-        })
-        if (!filesystemResolution.found) {
-          reference.data.foundADirectory = foundADirectory
-          return null
+        reference.leadsToADirectory = stat && stat.isDirectory()
+        if (stat) {
+          const urlRaw = preserveSymlinks ? url : resolveSymlink(url)
+          const resolvedUrl = `${urlRaw}${search}${hash}`
+          return resolvedUrl
         }
-        reference.data.foundADirectory = filesystemResolution.isDirectory
-        const fileFacadeUrl = filesystemResolution.url
-        const fileUrlRaw = preserveSymlinks
-          ? fileFacadeUrl
-          : resolveSymlink(fileFacadeUrl)
-        const fileUrl = `${fileUrlRaw}${search}${hash}`
-        return fileUrl
+        return null
       },
     },
     {
@@ -145,28 +157,23 @@ export const jsenvPluginFileUrls = ({
           return null
         }
         const urlObject = new URL(urlInfo.url)
-        if (context.reference.data.foundADirectory) {
-          if (directoryReferenceAllowed) {
-            const directoryEntries = readdirSync(urlObject)
-            let filename
-            if (context.reference.type === "filesystem") {
-              const parentUrlInfo = context.urlGraph.getUrlInfo(
-                context.reference.parentUrl,
-              )
-              filename = `${parentUrlInfo.filename}${context.reference.specifier}/`
-            } else {
-              filename = `${urlToFilename(urlInfo.url)}/`
-            }
-            return {
-              type: "directory",
-              contentType: "application/json",
-              content: JSON.stringify(directoryEntries, null, "  "),
-              filename,
-            }
+        if (context.reference.leadsToADirectory) {
+          const directoryEntries = readdirSync(urlObject)
+          let filename
+          if (context.reference.type === "filesystem") {
+            const parentUrlInfo = context.urlGraph.getUrlInfo(
+              context.reference.parentUrl,
+            )
+            filename = `${parentUrlInfo.filename}${context.reference.specifier}/`
+          } else {
+            filename = `${urlToFilename(urlInfo.url)}/`
+          }
+          return {
+            type: "directory",
+            contentType: "application/json",
+            content: JSON.stringify(directoryEntries, null, "  "),
+            filename,
           }
-          const error = new Error("found a directory on filesystem")
-          error.code = "DIRECTORY_REFERENCE_NOT_ALLOWED"
-          throw error
         }
         const fileBuffer = readFileSync(urlObject)
         const contentType = CONTENT_TYPE.fromUrlExtension(urlInfo.url)

package/src/plugins/transpilation/as_js_classic/jsenv_plugin_as_js_classic_library.js

@@ -49,7 +49,7 @@ export const jsenvPluginAsJsClassicLibrary = ({
         jsModuleUrlInfos: [jsModuleUrlInfo],
         context: {
           ...context,
-          buildDirectoryUrl: context.outDirectoryUrl,
+          buildDirectoryUrl: new URL("./", import.meta.url),
         },
         preserveDynamicImport: true,
       })

package/src/plugins/url_analysis/webmanifest/webmanifest_urls.js

@@ -2,15 +2,6 @@ export const parseAndTransformWebmanifestUrls = async (urlInfo, context) => {
   const content = urlInfo.content
   const manifest = JSON.parse(content)
   const actions = []
-  const { start_url } = manifest
-  if (start_url) {
-    if (context.build) {
-      manifest.start_url = "/"
-    } else {
-      const parentUrl = context.reference.parentUrl
-      manifest.start_url = `${parentUrl.slice(context.rootDirectoryUrl.length)}`
-    }
-  }
   const { icons = [] } = manifest
   icons.forEach((icon) => {
     const [reference] = context.referenceUtils.found({

package/src/test/execute_test_plan.js

@@ -149,7 +149,7 @@ export const executeTestPlan = async ({
           await import(devServerModuleUrl)
           delete process.env.IMPORTED_BY_TEST_PLAN
         } catch (e) {
-          if (e.code === "MODULE_NOT_FOUND") {
+          if (e.code === "ERR_MODULE_NOT_FOUND") {
             throw new Error(
               `Cannot find file responsible to start dev server at "${devServerModuleUrl}"`,
             )

package/src/jsenv_internal_directory.js

@@ -1,18 +0,0 @@
-import { basename } from "node:path"
-
-import { lookupPackageDirectory } from "./lookup_package_directory.js"
-
-export const determineJsenvInternalDirectoryUrl = (currentUrl) => {
-  const packageDirectoryUrl = lookupPackageDirectory(currentUrl)
-  if (packageDirectoryUrl) {
-    return `${packageDirectoryUrl}.jsenv/${getDirectoryName(
-      packageDirectoryUrl,
-    )}/`
-  }
-  return `${currentUrl}.jsenv/`
-}
-
-const getDirectoryName = (directoryUrl) => {
-  const { pathname } = new URL(directoryUrl)
-  return basename(pathname)
-}