@jsenv/core 23.8.0 → 23.8.4

package/src/internal/compiling/transformResultToCompilationResult.js

@@ -1,220 +1,220 @@
-import {
-  resolveUrl,
-  urlToRelativeUrl,
-  readFile,
-  ensureWindowsDriveLetter,
-} from "@jsenv/filesystem"
-
-import {
-  replaceBackSlashesWithSlashes,
-  startsWithWindowsDriveLetter,
-  windowsFilePathToUrl,
-} from "../filePathUtils.js"
-import {
-  setJavaScriptSourceMappingUrl,
-  setCssSourceMappingUrl,
-  sourcemapToBase64Url,
-} from "../sourceMappingURLUtils.js"
-import { generateCompiledFileAssetUrl } from "./compile-directory/compile-asset.js"
-import { testFilePresence } from "./compile-directory/fs-optimized-for-cache.js"
-
-const isWindows = process.platform === "win32"
-
-export const transformResultToCompilationResult = async (
-  { contentType, code, map, metadata = {} },
-  {
-    projectDirectoryUrl,
-    originalFileContent,
-    originalFileUrl,
-    compiledFileUrl,
-    sourcemapFileUrl,
-    sourcemapEnabled = true,
-    // removing sourcesContent from map decrease the sourceMap
-    // it also means client have to fetch source from server (additional http request)
-    // some client ignore sourcesContent property such as vscode-chrome-debugger
-    // Because it's the most complex scenario and we want to ensure client is always able
-    // to find source from the sourcemap, we remove map.sourcesContent by default to test this.
-    sourcemapExcludeSources = true,
-    sourcemapMethod = "comment", // "comment", "inline"
-  },
-) => {
-  if (typeof contentType !== "string") {
-    throw new TypeError(`contentType must be a string, got ${contentType}`)
-  }
-  if (typeof projectDirectoryUrl !== "string") {
-    throw new TypeError(
-      `projectDirectoryUrl must be a string, got ${projectDirectoryUrl}`,
-    )
-  }
-  if (typeof originalFileContent !== "string") {
-    throw new TypeError(
-      `originalFileContent must be a string, got ${originalFileContent}`,
-    )
-  }
-  if (typeof originalFileUrl !== "string") {
-    throw new TypeError(
-      `originalFileUrl must be a string, got ${originalFileUrl}`,
-    )
-  }
-  if (typeof compiledFileUrl !== "string") {
-    throw new TypeError(
-      `compiledFileUrl must be a string, got ${compiledFileUrl}`,
-    )
-  }
-  if (typeof sourcemapFileUrl !== "string") {
-    throw new TypeError(
-      `sourcemapFileUrl must be a string, got ${sourcemapFileUrl}`,
-    )
-  }
-
-  const sources = []
-  const sourcesContent = []
-  const assets = []
-  const assetsContent = []
-
-  let output = code
-  if (sourcemapEnabled && map) {
-    if (map.sources.length === 0) {
-      // may happen in some cases where babel returns a wrong sourcemap
-      // there is at least one case where it happens
-      // a file with only import './whatever.js' inside
-      sources.push(originalFileUrl)
-      sourcesContent.push(originalFileContent)
-    } else {
-      map.sources.forEach((source, index) => {
-        const sourceFileUrl = resolveSourceFile({
-          source,
-          sourcemapFileUrl,
-          originalFileUrl,
-          compiledFileUrl,
-          projectDirectoryUrl,
-        })
-        if (sourceFileUrl) {
-          map.sources[index] = urlToRelativeUrl(sourceFileUrl, sourcemapFileUrl)
-          sources[index] = sourceFileUrl
-        }
-      })
-
-      if (sources.length === 0) {
-        // happens when sourcemap is generated by webpack and looks like
-        // webpack://Package./src/file.js
-        // in that case we'll don't know how to find the source file
-        sources.push(originalFileUrl)
-        sourcesContent.push(originalFileContent)
-      }
-
-      await Promise.all(
-        sources.map(async (sourceUrl, index) => {
-          const contentFromSourcemap = map.sourcesContent
-            ? map.sourcesContent[index]
-            : null
-          if (contentFromSourcemap) {
-            sourcesContent[index] = contentFromSourcemap
-          } else {
-            const contentFromFile = await readFile(sourceUrl)
-            sourcesContent[index] = contentFromFile
-          }
-        }),
-      )
-    }
-
-    if (sourcemapExcludeSources) {
-      delete map.sourcesContent
-    }
-
-    // we don't need sourceRoot because our path are relative or absolute to the current location
-    // we could comment this line because it is not set by babel because not passed during transform
-    delete map.sourceRoot
-
-    const setSourceMappingUrl =
-      contentType === "application/javascript"
-        ? setJavaScriptSourceMappingUrl
-        : setCssSourceMappingUrl
-
-    if (sourcemapMethod === "inline") {
-      output = setSourceMappingUrl(output, sourcemapToBase64Url(map))
-    } else if (sourcemapMethod === "comment") {
-      const sourcemapFileRelativePathForModule = urlToRelativeUrl(
-        sourcemapFileUrl,
-        compiledFileUrl,
-      )
-      output = setSourceMappingUrl(output, sourcemapFileRelativePathForModule)
-      assets.push(sourcemapFileUrl)
-      assetsContent.push(stringifyMap(map))
-    }
-  } else {
-    sources.push(originalFileUrl)
-    sourcesContent.push(originalFileContent)
-  }
-
-  const { coverage } = metadata
-  if (coverage) {
-    const coverageAssetFileUrl = generateCompiledFileAssetUrl(
-      compiledFileUrl,
-      "coverage.json",
-    )
-    assets.push(coverageAssetFileUrl)
-    assetsContent.push(stringifyCoverage(coverage))
-  }
-
-  const { dependencies = [] } = metadata
-
-  return {
-    contentType,
-    compiledSource: output,
-    sourcemap: map,
-    sources,
-    sourcesContent,
-    assets,
-    assetsContent,
-    dependencies,
-  }
-}
-
-const resolveSourceFile = ({
-  source,
-  sourcemapFileUrl,
-  originalFileUrl,
-  compiledFileUrl,
-  projectDirectoryUrl,
-}) => {
-  const sourceFileUrl = resolveSourceUrl({ source, sourcemapFileUrl })
-
-  if (!sourceFileUrl.startsWith(projectDirectoryUrl)) {
-    // do not track dependency outside project
-    // it means cache stays valid for those external sources
-    return null
-  }
-
-  const fileFound = testFilePresence(sourceFileUrl)
-  if (fileFound) {
-    return sourceFileUrl
-  }
-
-  // prefer original source file
-  const relativeUrl = urlToRelativeUrl(sourceFileUrl, compiledFileUrl)
-  const originalSourceUrl = resolveUrl(relativeUrl, originalFileUrl)
-  return originalSourceUrl
-}
-
-const resolveSourceUrl = ({ source, sourcemapFileUrl }) => {
-  if (isWindows) {
-    // we can receive:
-    // - "C:/Directory/file.js" path from babel
-    // - relative path like "directory\file.js" (-> we replace \ with slash)
-    if (startsWithWindowsDriveLetter(source)) {
-      return windowsFilePathToUrl(source)
-    }
-    const url = resolveUrl(
-      replaceBackSlashesWithSlashes(source),
-      sourcemapFileUrl,
-    )
-    return ensureWindowsDriveLetter(url, sourcemapFileUrl)
-  }
-
-  return resolveUrl(source, sourcemapFileUrl)
-}
-
-const stringifyMap = (object) => JSON.stringify(object, null, "  ")
-
-const stringifyCoverage = (object) => JSON.stringify(object, null, "  ")
+import {
+  resolveUrl,
+  urlToRelativeUrl,
+  readFile,
+  ensureWindowsDriveLetter,
+} from "@jsenv/filesystem"
+
+import {
+  replaceBackSlashesWithSlashes,
+  startsWithWindowsDriveLetter,
+  windowsFilePathToUrl,
+} from "../filePathUtils.js"
+import {
+  setJavaScriptSourceMappingUrl,
+  setCssSourceMappingUrl,
+  sourcemapToBase64Url,
+} from "../sourceMappingURLUtils.js"
+import { generateCompiledFileAssetUrl } from "./compile-directory/compile-asset.js"
+import { testFilePresence } from "./compile-directory/fs-optimized-for-cache.js"
+
+const isWindows = process.platform === "win32"
+
+export const transformResultToCompilationResult = async (
+  { contentType, code, map, metadata = {} },
+  {
+    projectDirectoryUrl,
+    originalFileContent,
+    originalFileUrl,
+    compiledFileUrl,
+    sourcemapFileUrl,
+    sourcemapEnabled = true,
+    // removing sourcesContent from map decrease the sourceMap
+    // it also means client have to fetch source from server (additional http request)
+    // some client ignore sourcesContent property such as vscode-chrome-debugger
+    // Because it's the most complex scenario and we want to ensure client is always able
+    // to find source from the sourcemap, we remove map.sourcesContent by default to test this.
+    sourcemapExcludeSources = true,
+    sourcemapMethod = "comment", // "comment", "inline"
+  },
+) => {
+  if (typeof contentType !== "string") {
+    throw new TypeError(`contentType must be a string, got ${contentType}`)
+  }
+  if (typeof projectDirectoryUrl !== "string") {
+    throw new TypeError(
+      `projectDirectoryUrl must be a string, got ${projectDirectoryUrl}`,
+    )
+  }
+  if (typeof originalFileContent !== "string") {
+    throw new TypeError(
+      `originalFileContent must be a string, got ${originalFileContent}`,
+    )
+  }
+  if (typeof originalFileUrl !== "string") {
+    throw new TypeError(
+      `originalFileUrl must be a string, got ${originalFileUrl}`,
+    )
+  }
+  if (typeof compiledFileUrl !== "string") {
+    throw new TypeError(
+      `compiledFileUrl must be a string, got ${compiledFileUrl}`,
+    )
+  }
+  if (typeof sourcemapFileUrl !== "string") {
+    throw new TypeError(
+      `sourcemapFileUrl must be a string, got ${sourcemapFileUrl}`,
+    )
+  }
+
+  const sources = []
+  const sourcesContent = []
+  const assets = []
+  const assetsContent = []
+
+  let output = code
+  if (sourcemapEnabled && map) {
+    if (map.sources.length === 0) {
+      // may happen in some cases where babel returns a wrong sourcemap
+      // there is at least one case where it happens
+      // a file with only import './whatever.js' inside
+      sources.push(originalFileUrl)
+      sourcesContent.push(originalFileContent)
+    } else {
+      map.sources.forEach((source, index) => {
+        const sourceFileUrl = resolveSourceFile({
+          source,
+          sourcemapFileUrl,
+          originalFileUrl,
+          compiledFileUrl,
+          projectDirectoryUrl,
+        })
+        if (sourceFileUrl) {
+          map.sources[index] = urlToRelativeUrl(sourceFileUrl, sourcemapFileUrl)
+          sources[index] = sourceFileUrl
+        }
+      })
+
+      if (sources.length === 0) {
+        // happens when sourcemap is generated by webpack and looks like
+        // webpack://Package./src/file.js
+        // in that case we'll don't know how to find the source file
+        sources.push(originalFileUrl)
+        sourcesContent.push(originalFileContent)
+      }
+
+      await Promise.all(
+        sources.map(async (sourceUrl, index) => {
+          const contentFromSourcemap = map.sourcesContent
+            ? map.sourcesContent[index]
+            : null
+          if (contentFromSourcemap) {
+            sourcesContent[index] = contentFromSourcemap
+          } else {
+            const contentFromFile = await readFile(sourceUrl)
+            sourcesContent[index] = contentFromFile
+          }
+        }),
+      )
+    }
+
+    if (sourcemapExcludeSources) {
+      delete map.sourcesContent
+    }
+
+    // we don't need sourceRoot because our path are relative or absolute to the current location
+    // we could comment this line because it is not set by babel because not passed during transform
+    delete map.sourceRoot
+
+    const setSourceMappingUrl =
+      contentType === "application/javascript"
+        ? setJavaScriptSourceMappingUrl
+        : setCssSourceMappingUrl
+
+    if (sourcemapMethod === "inline") {
+      output = setSourceMappingUrl(output, sourcemapToBase64Url(map))
+    } else if (sourcemapMethod === "comment") {
+      const sourcemapFileRelativePathForModule = urlToRelativeUrl(
+        sourcemapFileUrl,
+        compiledFileUrl,
+      )
+      output = setSourceMappingUrl(output, sourcemapFileRelativePathForModule)
+      assets.push(sourcemapFileUrl)
+      assetsContent.push(stringifyMap(map))
+    }
+  } else {
+    sources.push(originalFileUrl)
+    sourcesContent.push(originalFileContent)
+  }
+
+  const { coverage } = metadata
+  if (coverage) {
+    const coverageAssetFileUrl = generateCompiledFileAssetUrl(
+      compiledFileUrl,
+      "coverage.json",
+    )
+    assets.push(coverageAssetFileUrl)
+    assetsContent.push(stringifyCoverage(coverage))
+  }
+
+  const { dependencies = [] } = metadata
+
+  return {
+    contentType,
+    compiledSource: output,
+    sourcemap: map,
+    sources,
+    sourcesContent,
+    assets,
+    assetsContent,
+    dependencies,
+  }
+}
+
+const resolveSourceFile = ({
+  source,
+  sourcemapFileUrl,
+  originalFileUrl,
+  compiledFileUrl,
+  projectDirectoryUrl,
+}) => {
+  const sourceFileUrl = resolveSourceUrl({ source, sourcemapFileUrl })
+
+  if (!sourceFileUrl.startsWith(projectDirectoryUrl)) {
+    // do not track dependency outside project
+    // it means cache stays valid for those external sources
+    return null
+  }
+
+  const fileFound = testFilePresence(sourceFileUrl)
+  if (fileFound) {
+    return sourceFileUrl
+  }
+
+  // prefer original source file
+  const relativeUrl = urlToRelativeUrl(sourceFileUrl, compiledFileUrl)
+  const originalSourceUrl = resolveUrl(relativeUrl, originalFileUrl)
+  return originalSourceUrl
+}
+
+const resolveSourceUrl = ({ source, sourcemapFileUrl }) => {
+  if (isWindows) {
+    // we can receive:
+    // - "C:/Directory/file.js" path from babel
+    // - relative path like "directory\file.js" (-> we replace \ with slash)
+    if (startsWithWindowsDriveLetter(source)) {
+      return windowsFilePathToUrl(source)
+    }
+    const url = resolveUrl(
+      replaceBackSlashesWithSlashes(source),
+      sourcemapFileUrl,
+    )
+    return ensureWindowsDriveLetter(url, sourcemapFileUrl)
+  }
+
+  return resolveUrl(source, sourcemapFileUrl)
+}
+
+const stringifyMap = (object) => JSON.stringify(object, null, "  ")
+
+const stringifyCoverage = (object) => JSON.stringify(object, null, "  ")

package/src/internal/executing/coverage/babel_plugin_instrument.js

@@ -1,90 +1,90 @@
-import {
-  resolveUrl,
-  normalizeStructuredMetaMap,
-  urlToMeta,
-} from "@jsenv/filesystem"
-
-import { require } from "../../require.js"
-
-// https://github.com/istanbuljs/babel-plugin-istanbul/blob/321740f7b25d803f881466ea819d870f7ed6a254/src/index.js
-
-export const babelPluginInstrument = (api, options) => {
-  const { programVisitor } = require("istanbul-lib-instrument")
-
-  const { types } = api
-  const {
-    useInlineSourceMaps = false,
-    projectDirectoryUrl,
-    coverageConfig = { "./**/*": true },
-  } = options
-
-  const structuredMetaMapForCover = normalizeStructuredMetaMap(
-    {
-      cover: coverageConfig,
-    },
-    projectDirectoryUrl,
-  )
-  const shouldInstrument = (relativeUrl) => {
-    return urlToMeta({
-      url: resolveUrl(relativeUrl, projectDirectoryUrl),
-      structuredMetaMap: structuredMetaMapForCover,
-    }).cover
-  }
-
-  return {
-    name: "transform-instrument",
-    visitor: {
-      Program: {
-        enter(path) {
-          const { file } = this
-          const { opts } = file
-
-          const relativeUrl = optionsToRelativeUrl(opts)
-          if (!relativeUrl) {
-            console.warn("file without relativeUrl", relativeUrl)
-            return
-          }
-          if (!shouldInstrument(relativeUrl)) return
-
-          this.__dv__ = null
-
-          let inputSourceMap
-
-          if (useInlineSourceMaps) {
-            // https://github.com/istanbuljs/babel-plugin-istanbul/commit/a9e15643d249a2985e4387e4308022053b2cd0ad#diff-1fdf421c05c1140f6d71444ea2b27638R65
-            inputSourceMap =
-              opts.inputSourceMap || file.inputMap
-                ? file.inputMap.sourcemap
-                : null
-          } else {
-            inputSourceMap = opts.inputSourceMap
-          }
-
-          this.__dv__ = programVisitor(
-            types,
-            opts.filenameRelative || opts.filename,
-            {
-              coverageVariable: "__coverage__",
-              inputSourceMap,
-            },
-          )
-          this.__dv__.enter(path)
-        },
-
-        exit(path) {
-          if (!this.__dv__) {
-            return
-          }
-          const object = this.__dv__.exit(path)
-          // object got two properties: fileCoverage and sourceMappingURL
-          this.file.metadata.coverage = object.fileCoverage
-        },
-      },
-    },
-  }
-}
-
-const optionsToRelativeUrl = ({ filenameRelative }) => {
-  if (filenameRelative) return filenameRelative
-  return ""
-}
+import {
+  resolveUrl,
+  normalizeStructuredMetaMap,
+  urlToMeta,
+} from "@jsenv/filesystem"
+
+import { require } from "../../require.js"
+
+// https://github.com/istanbuljs/babel-plugin-istanbul/blob/321740f7b25d803f881466ea819d870f7ed6a254/src/index.js
+
+export const babelPluginInstrument = (api, options) => {
+  const { programVisitor } = require("istanbul-lib-instrument")
+
+  const { types } = api
+  const {
+    useInlineSourceMaps = false,
+    projectDirectoryUrl,
+    coverageConfig = { "./**/*": true },
+  } = options
+
+  const structuredMetaMapForCover = normalizeStructuredMetaMap(
+    {
+      cover: coverageConfig,
+    },
+    projectDirectoryUrl,
+  )
+  const shouldInstrument = (relativeUrl) => {
+    return urlToMeta({
+      url: resolveUrl(relativeUrl, projectDirectoryUrl),
+      structuredMetaMap: structuredMetaMapForCover,
+    }).cover
+  }
+
+  return {
+    name: "transform-instrument",
+    visitor: {
+      Program: {
+        enter(path) {
+          const { file } = this
+          const { opts } = file
+
+          const relativeUrl = optionsToRelativeUrl(opts)
+          if (!relativeUrl) {
+            console.warn("file without relativeUrl", relativeUrl)
+            return
+          }
+          if (!shouldInstrument(relativeUrl)) return
+
+          this.__dv__ = null
+
+          let inputSourceMap
+
+          if (useInlineSourceMaps) {
+            // https://github.com/istanbuljs/babel-plugin-istanbul/commit/a9e15643d249a2985e4387e4308022053b2cd0ad#diff-1fdf421c05c1140f6d71444ea2b27638R65
+            inputSourceMap =
+              opts.inputSourceMap || file.inputMap
+                ? file.inputMap.sourcemap
+                : null
+          } else {
+            inputSourceMap = opts.inputSourceMap
+          }
+
+          this.__dv__ = programVisitor(
+            types,
+            opts.filenameRelative || opts.filename,
+            {
+              coverageVariable: "__coverage__",
+              inputSourceMap,
+            },
+          )
+          this.__dv__.enter(path)
+        },
+
+        exit(path) {
+          if (!this.__dv__) {
+            return
+          }
+          const object = this.__dv__.exit(path)
+          // object got two properties: fileCoverage and sourceMappingURL
+          this.file.metadata.coverage = object.fileCoverage
+        },
+      },
+    },
+  }
+}
+
+const optionsToRelativeUrl = ({ filenameRelative }) => {
+  if (filenameRelative) return filenameRelative
+  return ""
+}