@jsenv/file-size-impact 12.2.0 → 13.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "12.2.0",
+  "version": "13.0.0",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {
@@ -18,28 +18,24 @@
   "type": "module",
   "exports": {
     ".": {
-      "import": "./main.js"
+      "import": "./src/main.js"
     },
     "./*": "./*"
   },
-  "main": "./main.js",
+  "main": "./src/main.js",
   "files": [
-    "/src/",
-    "/main.js"
+    "/src/"
   ],
   "scripts": {
-    "eslint": "npx eslint . --ext=.js,.mjs",
-    "snapshot": "node ./test/comment/generate_comment_snapshot_file.mjs",
-    "test": "node ./script/test/test.mjs",
-    "test-with-coverage": "npm run test -- --coverage",
-    "file-size": "node ./script/file_size/file_size.mjs --log",
-    "prettier": "prettier --write ."
+    "snapshot": "node ./tests/comment/generate_comment_snapshot_file.mjs",
+    "test": "node ./scripts/test.mjs",
+    "file-size": "node ./scripts/file_size.mjs --log"
   },
   "dependencies": {
-    "@jsenv/dynamic-import-worker": "1.0.1",
-    "@jsenv/filesystem": "3.1.0",
-    "@jsenv/github-pull-request-impact": "1.6.11",
-    "@jsenv/logger": "4.0.1",
-    "pretty-bytes": "6.0.0"
+    "@jsenv/dynamic-import-worker": "1.1.0",
+    "@jsenv/filesystem": "4.1.0",
+    "@jsenv/github-pull-request-impact": "1.7.0",
+    "@jsenv/log": "2.1.0",
+    "@jsenv/urls": "1.2.6"
   }
 }

package/readme.md

@@ -108,10 +108,7 @@ import {
 await reportFileSizeImpact({
   ...readGitHubWorkflowEnv(),
   buildCommand: "npm run dist",
-  fileSizeReportModulePath: new URL(
-    "./file_size.mjs#fileSizeReport",
-    import.meta.url,
-  ),
+  fileSizeReportUrl: new URL("./file_size.mjs#fileSizeReport", import.meta.url),
 })
 ```
 
@@ -327,10 +324,7 @@ await reportFileSizeImpact({
 
   installCommand: "npm install",
   buildCommand: "npm run build",
-  fileSizeReportModulePath: new URL(
-    "./file_size.mjs#fileSizeReport",
-    import.meta.url,
-  ),
+  fileSizeReportUrl: new URL("./file_size.mjs#fileSizeReport", import.meta.url),
   filesOrdering: "size_impact",
 })
 ```

package/src/generateFileSizeReport.js

@@ -1,11 +1,10 @@
+import { fileURLToPath } from "node:url"
 import {
   assertAndNormalizeDirectoryUrl,
   bufferToEtag,
-  resolveUrl,
   readFile,
-  urlToFileSystemPath,
 } from "@jsenv/filesystem"
-import { createDetailedMessage, createLogger } from "@jsenv/logger"
+import { createDetailedMessage, createLogger } from "@jsenv/log"
 
 import { transform as rawTransform } from "./rawTransformation.js"
 import { jsenvTrackingConfig } from "./jsenvTrackingConfig.js"
@@ -81,7 +80,8 @@ const groupTrackingResultToGroupReport = async (
   const manifestRelativeUrls = Object.keys(manifestMetaMap)
   await Promise.all(
     manifestRelativeUrls.map(async (manifestRelativeUrl) => {
-      const manifestFileUrl = resolveUrl(manifestRelativeUrl, rootDirectoryUrl)
+      const manifestFileUrl = new URL(manifestRelativeUrl, rootDirectoryUrl)
+        .href
       const manifestFileContent = await readFile(manifestFileUrl, {
         as: "string",
       })
@@ -95,7 +95,7 @@ const groupTrackingResultToGroupReport = async (
               `JSON.parse error while trying to parse a manifest file`,
               {
                 "error stack": e.stack,
-                "manifest file": urlToFileSystemPath(manifestFileUrl),
+                "manifest file": fileURLToPath(manifestFileUrl),
               },
             ),
           )
@@ -114,7 +114,7 @@ const groupTrackingResultToGroupReport = async (
   // so we won't benefit from concurrency (it might even make things worse)
   await trackedRelativeUrls.reduce(async (previous, fileRelativeUrl) => {
     await previous
-    const fileUrl = resolveUrl(fileRelativeUrl, rootDirectoryUrl)
+    const fileUrl = new URL(fileRelativeUrl, rootDirectoryUrl).href
     const fileBuffer = await readFile(fileUrl, { as: "buffer" })
     const sizeMap = await getFileSizeMap(fileBuffer, {
       transformations,

package/src/internal/applyTrackingConfig.js

@@ -1,7 +1,5 @@
-import {
-  urlToFileSystemPath,
-  collectDirectoryMatchReport,
-} from "@jsenv/filesystem"
+import { fileURLToPath } from "node:url"
+import { collectDirectoryMatchReport } from "@jsenv/filesystem"
 
 export const applyTrackingConfig = async (
   trackingConfig,
@@ -30,21 +28,18 @@ const applyTracking = async (
   tracking,
   { rootDirectoryUrl, manifestConfig },
 ) => {
-  const structuredMetaMap = {
-    track: tracking,
-    ...(manifestConfig ? { manifest: manifestConfig } : {}),
-  }
-
   let directoryMatchReport
-
   try {
     directoryMatchReport = await collectDirectoryMatchReport({
       directoryUrl: rootDirectoryUrl,
-      structuredMetaMap,
+      associations: {
+        track: tracking,
+        ...(manifestConfig ? { manifest: manifestConfig } : {}),
+      },
       predicate: (meta) => Boolean(meta.track) || Boolean(meta.manifest),
     })
   } catch (e) {
-    const directoryPath = urlToFileSystemPath(rootDirectoryUrl)
+    const directoryPath = fileURLToPath(rootDirectoryUrl)
     if (e.code === "ENOENT" && e.path === directoryPath) {
       console.warn(`${directoryPath} does not exists`)
       return []

package/src/internal/compareTwoFileSizeReports.js

@@ -40,7 +40,11 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
       beforeMerge: null,
       afterMerge: {
         relativeUrl: afterMergeRelativeUrl,
-        manifestKey: manifestKeyFromRelativeUrl(afterMergeRelativeUrl, afterMergeMappings) || null,
+        manifestKey:
+          manifestKeyFromRelativeUrl(
+            afterMergeRelativeUrl,
+            afterMergeMappings,
+          ) || null,
         ...afterMergeFileMap[afterMergeRelativeUrl],
       },
     }
@@ -50,12 +54,19 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
       beforeMerge: {
         relativeUrl: beforeMergeRelativeUrl,
         manifestKey:
-          manifestKeyFromRelativeUrl(beforeMergeRelativeUrl, beforeMergeMappings) || null,
+          manifestKeyFromRelativeUrl(
+            beforeMergeRelativeUrl,
+            beforeMergeMappings,
+          ) || null,
         ...beforeMergeFileMap[beforeMergeRelativeUrl],
       },
       afterMerge: {
         relativeUrl: afterMergeRelativeUrl,
-        manifestKey: manifestKeyFromRelativeUrl(afterMergeRelativeUrl, afterMergeMappings) || null,
+        manifestKey:
+          manifestKeyFromRelativeUrl(
+            afterMergeRelativeUrl,
+            afterMergeMappings,
+          ) || null,
         ...afterMergeFileMap[afterMergeRelativeUrl],
       },
     }
@@ -64,7 +75,10 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
     return {
       beforeMerge: {
         relativeUrl: beforeMergeRelativeUrl,
-        manifestKey: manifestKeyFromRelativeUrl(beforeMergeRelativeUrl, beforeMergeMappings),
+        manifestKey: manifestKeyFromRelativeUrl(
+          beforeMergeRelativeUrl,
+          beforeMergeMappings,
+        ),
         ...beforeMergeFileMap[beforeMergeRelativeUrl],
       },
       afterMerge: null,
@@ -78,14 +92,16 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
     )
 
     if (afterMergeManifestKey) {
-      const existsInBeforeMergeManifest =
-        Object.keys(beforeMergeMappings).includes(afterMergeManifestKey)
+      const existsInBeforeMergeManifest = Object.keys(
+        beforeMergeMappings,
+      ).includes(afterMergeManifestKey)
       if (existsInBeforeMergeManifest) {
         // the manifest key also appears in the manifest before merge.
         // It means that even if both file have different relative urls,
         // they are considered the same.
         // This is to support file generated with a dynamic name
-        const beforeMergeRelativeUrl = beforeMergeMappings[afterMergeManifestKey]
+        const beforeMergeRelativeUrl =
+          beforeMergeMappings[afterMergeManifestKey]
         const beforeMerge = beforeMergeFileMap[beforeMergeRelativeUrl]
         if (beforeMerge) {
           groupComparison[afterMergeRelativeUrl] = getUpdateInfo({
@@ -113,8 +129,9 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
       beforeMergeMappings,
     )
     if (beforeMergeManifestKey) {
-      const existsInAfterMergeManifest =
-        Object.keys(afterMergeMappings).includes(beforeMergeManifestKey)
+      const existsInAfterMergeManifest = Object.keys(
+        afterMergeMappings,
+      ).includes(beforeMergeManifestKey)
       if (existsInAfterMergeManifest) {
         // file also referenced in after merge manifest
         // let's first see if the file still exists
@@ -137,7 +154,9 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
     // at this point there is no file for an eventual file mapping from manifest
     // AND no file for the real relative url after merge
     // -> the file is gone
-    groupComparison[beforeMergeRelativeUrl] = getRemoveInfo({ beforeMergeRelativeUrl })
+    groupComparison[beforeMergeRelativeUrl] = getRemoveInfo({
+      beforeMergeRelativeUrl,
+    })
   })
 
   const fileImpactMap = sortFileStructure(groupComparison)
@@ -149,7 +168,8 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
 }
 
 const sortFileStructure = (fileStructure) => {
-  const relativeUrlSortedArray = Object.keys(fileStructure).sort(comparePathnames)
+  const relativeUrlSortedArray =
+    Object.keys(fileStructure).sort(comparePathnames)
   const fileStructureSorted = {}
   relativeUrlSortedArray.forEach((relativeUrl) => {
     fileStructureSorted[relativeUrl] = fileStructure[relativeUrl]

package/src/internal/formatFileSizeReportForLog.js

@@ -9,7 +9,8 @@ export const formatFileSizeReportForLog = (fileSizeReport) => {
 
     const mappings = manifestToMappings(manifestMap)
     const fileMessages = Object.keys(fileMap).map((fileRelativeUrl) => {
-      const fileDisplayed = manifestKeyFromRelativeUrl(fileRelativeUrl, mappings) || fileRelativeUrl
+      const fileDisplayed =
+        manifestKeyFromRelativeUrl(fileRelativeUrl, mappings) || fileRelativeUrl
       const file = fileMap[fileRelativeUrl]
       const { sizeMap } = file
       const sizeNames = Object.keys(sizeMap)

package/src/internal/formatSize.js

@@ -1,8 +1,8 @@
-import bytes from "pretty-bytes"
+import { byteAsFileSize } from "@jsenv/log"
 
 export const formatSize = (sizeNumber, { diff = false } = {}) => {
   const sizeNumberAbsolute = Math.abs(sizeNumber)
-  let sizeString = bytes(sizeNumberAbsolute)
+  let sizeString = byteAsFileSize(sizeNumberAbsolute)
   if (diff) {
     if (sizeNumber < 0) {
       sizeString = `-${sizeString}`

package/src/internal/format_percentage.js

@@ -1,31 +1,8 @@
-export const formatPercentage = (number) => {
-  const absoluteValue = Math.abs(number)
-  const valueRounded = roundNumber(
-    absoluteValue,
-    determineDecimals(absoluteValue),
-  )
-  return `${number < 0 ? `-` : "+"}${valueRounded}%`
-}
+import { setRoundedPrecision } from "@jsenv/log"
 
-const determineDecimals = (number) => {
-  if (number < 0.001) {
-    return 4
-  }
-  if (number < 0.01) {
-    return 3
-  }
-  if (number < 0.1) {
-    return 2
-  }
-  if (number < 1) {
-    return 1
-  }
-  return 0
-}
-
-const roundNumber = (value, maxDecimals) => {
-  const expValue = Math.pow(10, maxDecimals)
-  const roundedValue = Math.round(expValue * value) / expValue
-  const valueAsString = roundedValue.toFixed(maxDecimals)
-  return parseFloat(valueAsString)
+export const formatPercentage = (number) => {
+  return `${number < 0 ? `-` : "+"}${setRoundedPrecision(number, {
+    decimals: 0,
+    decimalsWhenSmall: 1,
+  })}%`
 }

package/src/internal/helper.js

@@ -5,7 +5,8 @@ export const anchor = (text, id) => {
 
 export const isAdded = ({ beforeMerge }) => !beforeMerge
 
-export const isDeleted = ({ beforeMerge, afterMerge }) => beforeMerge && !afterMerge
+export const isDeleted = ({ beforeMerge, afterMerge }) =>
+  beforeMerge && !afterMerge
 
 export const isModified = ({ beforeMerge, afterMerge }) =>
   beforeMerge && afterMerge && beforeMerge.hash !== afterMerge.hash

package/src/internal/manifest.js

@@ -1,14 +1,21 @@
-import { resolveUrl, urlToRelativeUrl } from "@jsenv/filesystem"
+import { urlToRelativeUrl } from "@jsenv/urls"
 
 export const manifestToMappings = (manifestMap) => {
   const mappings = {}
   Object.keys(manifestMap).forEach((manifestRelativeUrl) => {
     const manifest = manifestMap[manifestRelativeUrl]
-    const manifestAbstractUrl = resolveUrl(manifestRelativeUrl, ABSTRACT_DIRECTORY_URL)
+    const manifestAbstractUrl = new URL(
+      manifestRelativeUrl,
+      ABSTRACT_DIRECTORY_URL,
+    ).href
     Object.keys(manifest).forEach((manifestKey) => {
       const manifestValue = manifest[manifestKey]
-      const manifestKeyAsAbstractUrl = resolveUrl(manifestKey, manifestAbstractUrl)
-      const manifestValueAsAbstractUrl = resolveUrl(manifestValue, manifestAbstractUrl)
+      const manifestKeyAsAbstractUrl = new URL(manifestKey, manifestAbstractUrl)
+        .href
+      const manifestValueAsAbstractUrl = new URL(
+        manifestValue,
+        manifestAbstractUrl,
+      ).href
       const manifestKeyAsRelativeUrl = urlToRelativeUrl(
         manifestKeyAsAbstractUrl,
         ABSTRACT_DIRECTORY_URL,

package/src/internal/orderBySizeImpact.js

@@ -3,8 +3,10 @@ export const orderBySizeImpact = (fileByFileImpact, sizeNames) => {
   const files = Object.keys(fileByFileImpact)
   const firstSizeName = sizeNames[0]
   files.sort((leftFile, rightFile) => {
-    const leftFileSizeImpact = fileByFileImpact[leftFile].sizeImpactMap[firstSizeName]
-    const rightFileSizeImpact = fileByFileImpact[rightFile].sizeImpactMap[firstSizeName]
+    const leftFileSizeImpact =
+      fileByFileImpact[leftFile].sizeImpactMap[firstSizeName]
+    const rightFileSizeImpact =
+      fileByFileImpact[rightFile].sizeImpactMap[firstSizeName]
     if (leftFileSizeImpact === 0) {
       return 1
     }

package/src/internal/renderImpactTable.js

@@ -48,7 +48,10 @@ const renderSizeImpactTableHeader = (transformationKeys) => {
   const headerLine = [
     `<th nowrap>Files</th>`,
     ...transformationKeys.map(
-      (sizeName) => `<th nowrap>${sizeName === "raw" ? `new size` : `new ${sizeName} size`}</th>`,
+      (sizeName) =>
+        `<th nowrap>${
+          sizeName === "raw" ? `new size` : `new ${sizeName} size`
+        }</th>`,
     ),
     `<th></th>`,
   ]
@@ -88,15 +91,17 @@ const renderSizeImpactTableBody = ({
     }
 
     remainingFilesToDisplay--
-    const fileAbstractRelativeUrl = fileAbstractRelativeUrlFromFileImpact(fileImpact)
-    const fileRelativeUrlFormatted = (fileImpact.formatFileRelativeUrl || formatFileRelativeUrl)(
-      fileAbstractRelativeUrl,
-    )
+    const fileAbstractRelativeUrl =
+      fileAbstractRelativeUrlFromFileImpact(fileImpact)
+    const fileRelativeUrlFormatted = (
+      fileImpact.formatFileRelativeUrl || formatFileRelativeUrl
+    )(fileAbstractRelativeUrl)
     const fileRelativeUrlDisplayed = truncateFileRelativeUrl(
       fileRelativeUrlFormatted,
       fileRelativeUrlMaxLength,
     )
-    const { sizeMapBeforeMerge, sizeMapAfterMerge } = fileByFileImpact[fileRelativeUrl]
+    const { sizeMapBeforeMerge, sizeMapAfterMerge } =
+      fileByFileImpact[fileRelativeUrl]
     const fileCellFormatted = formatFileCell({
       fileRelativeUrl,
       fileRelativeUrlDisplayed,

package/src/internal/size_map.js

@@ -15,7 +15,8 @@ export const getSizeMapsOneFile = ({ sizeNames, beforeMerge, afterMerge }) => {
     } else {
       sizeMapBeforeMerge[sizeName] = beforeMerge.sizeMap[sizeName]
       sizeMapAfterMerge[sizeName] = afterMerge.sizeMap[sizeName]
-      sizeImpactMap[sizeName] = afterMerge.sizeMap[sizeName] - beforeMerge.sizeMap[sizeName]
+      sizeImpactMap[sizeName] =
+        afterMerge.sizeMap[sizeName] - beforeMerge.sizeMap[sizeName]
     }
   })
 
@@ -26,7 +27,11 @@ export const getSizeMapsOneFile = ({ sizeNames, beforeMerge, afterMerge }) => {
   }
 }
 
-export const getSizeMapsForManyFiles = ({ sizeNames, fileByFileImpact, files }) => {
+export const getSizeMapsForManyFiles = ({
+  sizeNames,
+  fileByFileImpact,
+  files,
+}) => {
   const sizeMapBeforeMerge = {}
   const sizeMapAfterMerge = {}
 
@@ -34,7 +39,8 @@ export const getSizeMapsForManyFiles = ({ sizeNames, fileByFileImpact, files })
     let sizeBeforeMerge = 0
     let sizeAfterMerge = 0
     files.forEach((fileRelativeUrl) => {
-      const { sizeMapBeforeMerge, sizeMapAfterMerge } = fileByFileImpact[fileRelativeUrl]
+      const { sizeMapBeforeMerge, sizeMapAfterMerge } =
+        fileByFileImpact[fileRelativeUrl]
       sizeBeforeMerge += sizeMapBeforeMerge[sizeName] || 0
       sizeAfterMerge += sizeMapAfterMerge[sizeName] || 0
     })

package/src/main.js

@@ -0,0 +1,8 @@
+export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
+
+export { jsenvTrackingConfig } from "./jsenvTrackingConfig.js"
+export { transform as raw } from "./rawTransformation.js"
+export { transform as gzip } from "./gzipTransformation.js"
+export { transform as brotli } from "./brotliTransformation.js"
+export { generateFileSizeReport } from "./generateFileSizeReport.js"
+export { reportFileSizeImpact } from "./reportFileSizeImpact.js"

package/src/reportFileSizeImpact.js

@@ -1,7 +1,7 @@
-import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
 import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
-
+import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
 import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
+
 import { formatComment } from "./internal/formatComment.js"
 import { jsenvCommentParameters } from "./internal/jsenvCommentParameters.js"
 
@@ -18,7 +18,7 @@ export const reportFileSizeImpact = async ({
   pullRequestNumber,
   installCommand = "npm install",
   buildCommand = "npm run-script build",
-  fileSizeReportModulePath,
+  fileSizeReportUrl,
 
   // We could just to ...jsenvCommentParameters but explicitely passing params
   // helps autocompletion in vscode for dev using the function.
@@ -37,17 +37,12 @@ export const reportFileSizeImpact = async ({
   commitInGeneratedByInfo,
 }) => {
   rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-  let fileSizeReportModuleUrl
-  if (fileSizeReportModulePath === "string") {
-    fileSizeReportModuleUrl = new URL(
-      fileSizeReportModulePath,
-      rootDirectoryUrl,
-    ).href
-  } else if (fileSizeReportModulePath instanceof URL) {
-    fileSizeReportModuleUrl = fileSizeReportModulePath.href
+  if (fileSizeReportUrl === "string") {
+    fileSizeReportUrl = new URL(fileSizeReportUrl, rootDirectoryUrl).href
+  } else if (fileSizeReportUrl instanceof URL) {
   } else {
     throw new TypeError(
-      `fileSizeReportModulePath must be a string or an url but received ${fileSizeReportModulePath}`,
+      `fileSizeReportUrl must be a string or an url but received ${fileSizeReportUrl}`,
     )
   }
 
@@ -82,9 +77,7 @@ export const reportFileSizeImpact = async ({
     collectInfo: async ({ execCommandInRootDirectory }) => {
       if (installCommand) await execCommandInRootDirectory(installCommand)
       if (buildCommand) await execCommandInRootDirectory(buildCommand)
-      const fileSizeReport = await importOneExportFromFile(
-        fileSizeReportModuleUrl,
-      )
+      const fileSizeReport = await importOneExportFromFile(fileSizeReportUrl)
       return { version: 1, data: fileSizeReport }
     },
     commentIdentifier: `<!-- Generated by @jsenv/file-size-impact -->`,

package/main.js

@@ -1,8 +0,0 @@
-export { jsenvTrackingConfig } from "./src/jsenvTrackingConfig.js"
-export { transform as raw } from "./src/rawTransformation.js"
-export { transform as gzip } from "./src/gzipTransformation.js"
-export { transform as brotli } from "./src/brotliTransformation.js"
-export { generateFileSizeReport } from "./src/generateFileSizeReport.js"
-
-export { readGitHubWorkflowEnv } from "@jsenv/github-pull-request-impact"
-export { reportFileSizeImpact } from "./src/reportFileSizeImpact.js"