@jsenv/file-size-impact 12.1.9 → 12.1.12

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "12.1.9",
+  "version": "12.1.12",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {
@@ -29,7 +29,6 @@
   ],
   "scripts": {
     "eslint": "npx eslint . --ext=.js,.mjs",
-    "importmap": "node ./script/importmap/importmap.mjs",
     "snapshot": "node ./test/comment/generate_comment_snapshot_file.mjs",
     "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
@@ -38,19 +37,9 @@
   },
   "dependencies": {
     "@jsenv/dynamic-import-worker": "1.0.1",
-    "@jsenv/filesystem": "2.7.1",
-    "@jsenv/github-pull-request-impact": "1.6.10",
+    "@jsenv/filesystem": "3.1.0",
+    "@jsenv/github-pull-request-impact": "1.6.11",
     "@jsenv/logger": "4.0.1",
-    "pretty-bytes": "5.6.0"
-  },
-  "devDependencies": {
-    "@jsenv/assert": "2.4.1",
-    "@jsenv/core": "25.3.0",
-    "@jsenv/eslint-config": "16.0.9",
-    "@jsenv/importmap-eslint-resolver": "5.2.5",
-    "@jsenv/importmap-node-module": "5.1.3",
-    "eslint": "8.7.0",
-    "eslint-plugin-import": "2.25.4",
-    "prettier": "2.5.1"
+    "pretty-bytes": "6.0.0"
   }
 }

package/readme.md

@@ -35,7 +35,7 @@ import { generateFileSizeReport } from "@jsenv/file-size-impact"
 
 export const fileSizeReport = await generateFileSizeReport({
   log: process.argv.includes("--log"),
-  projectDirectoryUrl: new URL("./", import.meta.url),
+  rootDirectoryUrl: new URL("./", import.meta.url),
   trackingConfig: {
     dist: {
       "./dist/**/*": true,
@@ -145,7 +145,7 @@ When outside a GitHub workflow, you cannot use _readGitHubWorkflowEnv()_. It mea
 
 reportFileSizeImpact({
 - ...readGitHubWorkflowEnv(),
-+ projectDirectoryUrl: process.env.TRAVIS_BUILD_DIR,
++ rootDirectoryUrl: process.env.TRAVIS_BUILD_DIR,
 + repositoryOwner: process.env.TRAVIS_REPO_SLUG.split("/")[0],
 + repositoryName: process.env.TRAVIS_REPO_SLUG.split("/")[1],
 + pullRequestNumber: process.env.TRAVIS_PULL_REQUEST,
@@ -179,7 +179,7 @@ _generateFileSizeReport_ is an async function scanning filesystem to compute a l
 import { generateFileSizeReport, raw, gzip } from "@jsenv/file-size-impact"
 
 const fileSizeReport = await generateFileSizeReport({
-  projectDirectoryUrl: new URL("./", import.meta.url),
+  rootDirectoryUrl: new URL("./", import.meta.url),
   trackingConfig: {
     dist: {
       "./dist/**/*.js": true,
@@ -314,7 +314,7 @@ import { reportFileSizeImpact, raw } from "@jsenv/file-size-impact"
 await reportFileSizeImpact({
   logLevel: "info",
 
-  projectDirectoryUrl: "file:///directory",
+  rootDirectoryUrl: "file:///directory",
   githubToken: "xxx",
   repositoryOwner: "jsenv",
   repositoryName: "file-size-impact",
@@ -334,9 +334,9 @@ _logLevel_ parameter controls verbosity of logs during the function execution. T
 
 You likely don't need to modify this parameter except to get verbose logs using `"debug"`. The list of available values for _logLevel_ can be found on [@jsenv/logger documentation](https://github.com/jsenv/jsenv-logger#loglevel).
 
-## projectDirectoryUrl
+## rootDirectoryUrl
 
-_projectDirectoryUrl_ parameter is a string leading to your project root directory. This parameter is **required**.
+_rootDirectoryUrl_ parameter is a string leading to your project root directory. This parameter is **required**.
 
 ## installCommand
 
@@ -348,7 +348,7 @@ _buildCommand_ parameter is a string representing the command to run in order to
 
 ## fileSizeModulePath
 
-_fileSizeModulePath_ is a string parameter representing an url relative to [projectDirectoryUrl](#projectDirectoryUrl) leading a module file. This file must contain a _generateFileSizeReport_ export.
+_fileSizeModulePath_ is a string parameter representing an url relative to [rootDirectoryUrl](#rootDirectoryUrl) leading a module file. This file must contain a _generateFileSizeReport_ export.
 
 ## filesOrdering
 
@@ -407,7 +407,7 @@ _gitHubWorkflowEnv_ object looks like this:
 
 ```js
 const gitHubWorkflowEnv = {
-  projectDirectoryUrl: "/home/runner/work/repository-name",
+  rootDirectoryUrl: "/home/runner/work/repository-name",
   githubToken: "xxx",
   repositoryOwner: "jsenv",
   repositoryName: "repository-name",

package/src/generateFileSizeReport.js

@@ -16,14 +16,14 @@ export const generateFileSizeReport = async ({
   cancellationToken,
   log,
   logLevel,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
   trackingConfig = jsenvTrackingConfig,
   manifestConfig = {
     "./dist/**/manifest.json": true,
   },
   transformations = { raw: rawTransform },
 }) => {
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
 
   const logger = createLogger({ logLevel })
 
@@ -34,7 +34,7 @@ export const generateFileSizeReport = async ({
 
   const groupTrackingResults = await applyTrackingConfig(trackingConfig, {
     cancellationToken,
-    projectDirectoryUrl,
+    rootDirectoryUrl,
     manifestConfig,
   })
   const groupNames = Object.keys(groupTrackingResults)
@@ -51,7 +51,7 @@ export const generateFileSizeReport = async ({
         groupTrackingResult,
         {
           logger,
-          projectDirectoryUrl,
+          rootDirectoryUrl,
           tracking: trackingConfig[groupName],
           transformations,
         },
@@ -74,17 +74,14 @@ export const generateFileSizeReport = async ({
 
 const groupTrackingResultToGroupReport = async (
   groupTrackingResult,
-  { logger, projectDirectoryUrl, tracking, transformations },
+  { logger, rootDirectoryUrl, tracking, transformations },
 ) => {
   const manifestMap = {}
   const { manifestMetaMap } = groupTrackingResult
   const manifestRelativeUrls = Object.keys(manifestMetaMap)
   await Promise.all(
     manifestRelativeUrls.map(async (manifestRelativeUrl) => {
-      const manifestFileUrl = resolveUrl(
-        manifestRelativeUrl,
-        projectDirectoryUrl,
-      )
+      const manifestFileUrl = resolveUrl(manifestRelativeUrl, rootDirectoryUrl)
       const manifestFileContent = await readFile(manifestFileUrl, {
         as: "string",
       })
@@ -117,9 +114,8 @@ 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, projectDirectoryUrl)
-    const fileContent = await readFile(fileUrl)
-    const fileBuffer = Buffer.from(fileContent)
+    const fileUrl = resolveUrl(fileRelativeUrl, rootDirectoryUrl)
+    const fileBuffer = await readFile(fileUrl, { as: "buffer" })
     const sizeMap = await getFileSizeMap(fileBuffer, {
       transformations,
       logger,

package/src/internal/applyTrackingConfig.js

@@ -5,7 +5,7 @@ import {
 
 export const applyTrackingConfig = async (
   trackingConfig,
-  { projectDirectoryUrl, manifestConfig },
+  { rootDirectoryUrl, manifestConfig },
 ) => {
   const result = {}
   const trackingNames = Object.keys(trackingConfig)
@@ -17,7 +17,7 @@ export const applyTrackingConfig = async (
     trackingNames.map(async (trackingName) => {
       const tracking = trackingConfig[trackingName]
       const groupTrackingResult = await applyTracking(tracking, {
-        projectDirectoryUrl,
+        rootDirectoryUrl,
         manifestConfig,
       })
       result[trackingName] = groupTrackingResult
@@ -28,7 +28,7 @@ export const applyTrackingConfig = async (
 
 const applyTracking = async (
   tracking,
-  { projectDirectoryUrl, manifestConfig },
+  { rootDirectoryUrl, manifestConfig },
 ) => {
   const structuredMetaMap = {
     track: tracking,
@@ -39,12 +39,12 @@ const applyTracking = async (
 
   try {
     directoryMatchReport = await collectDirectoryMatchReport({
-      directoryUrl: projectDirectoryUrl,
+      directoryUrl: rootDirectoryUrl,
       structuredMetaMap,
       predicate: (meta) => Boolean(meta.track) || Boolean(meta.manifest),
     })
   } catch (e) {
-    const directoryPath = urlToFileSystemPath(projectDirectoryUrl)
+    const directoryPath = urlToFileSystemPath(rootDirectoryUrl)
     if (e.code === "ENOENT" && e.path === directoryPath) {
       console.warn(`${directoryPath} does not exists`)
       return []

package/src/internal/formatSize.js

@@ -1,14 +1,8 @@
-import { createRequire } from "node:module"
-
-const require = createRequire(import.meta.url)
-
-const bytes = require("pretty-bytes")
+import bytes from "pretty-bytes"
 
 export const formatSize = (sizeNumber, { diff = false } = {}) => {
   const sizeNumberAbsolute = Math.abs(sizeNumber)
-
   let sizeString = bytes(sizeNumberAbsolute)
-
   if (diff) {
     if (sizeNumber < 0) {
       sizeString = `-${sizeString}`
@@ -16,6 +10,5 @@ export const formatSize = (sizeNumber, { diff = false } = {}) => {
       sizeString = `+${sizeString}`
     }
   }
-
   return sizeString
 }

package/src/internal/format_percentage.js

@@ -0,0 +1,31 @@
+export const formatPercentage = (number) => {
+  const absoluteValue = Math.abs(number)
+  const valueRounded = roundNumber(
+    absoluteValue,
+    determineDecimals(absoluteValue),
+  )
+  return `${number < 0 ? `-` : "+"}${valueRounded}%`
+}
+
+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)
+}

package/src/internal/jsenvCommentParameters.js

@@ -1,3 +1,4 @@
+import { formatPercentage } from "./format_percentage.js"
 import { formatSize } from "./formatSize.js"
 
 const jsenvFormatGroupSummary = ({
@@ -116,13 +117,6 @@ const formatSizeImpactAsPercentage = ({ sizeBeforeMerge, sizeAfterMerge }) => {
       ? -1
       : sizeDiff / sizeBeforeMerge
   const sizeDiffAsPercentage = sizeDiffRatio * 100
-  const sizeDiffAsPercentageFormatted = `${sizeDiffAsPercentage < 0 ? `-` : "+"}${Math.abs(
-    limitDecimals(sizeDiffAsPercentage, 2),
-  )}%`
+  const sizeDiffAsPercentageFormatted = formatPercentage(sizeDiffAsPercentage)
   return sizeDiffAsPercentageFormatted
 }
-
-const limitDecimals = (number, decimalCount = 2) => {
-  const multiplier = Math.pow(10, decimalCount)
-  return Math.round(number * multiplier) / multiplier
-}

package/src/reportFileSizeImpact.js

@@ -1,7 +1,7 @@
 import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
 import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
-import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 
+import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 import { formatComment } from "./internal/formatComment.js"
 import { jsenvCommentParameters } from "./internal/jsenvCommentParameters.js"
 
@@ -10,7 +10,7 @@ export const reportFileSizeImpact = async ({
   commandLogs,
   cancellationToken,
   cancelOnSIGINT,
-  projectDirectoryUrl,
+  rootDirectoryUrl,
 
   githubToken,
   repositoryOwner,
@@ -57,10 +57,10 @@ export const reportFileSizeImpact = async ({
       `fileSizeReportModulePath must be a string but received ${fileSizeReportModulePath}`,
     )
   }
-  projectDirectoryUrl = assertAndNormalizeDirectoryUrl(projectDirectoryUrl)
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
   const fileSizeReportModuleUrl = resolveUrl(
     fileSizeReportModulePath,
-    projectDirectoryUrl,
+    rootDirectoryUrl,
   )
 
   return commentGitHubPullRequestImpact({
@@ -68,16 +68,16 @@ export const reportFileSizeImpact = async ({
     commandLogs,
     cancellationToken,
     cancelOnSIGINT,
-    projectDirectoryUrl,
+    rootDirectoryUrl,
 
     githubToken,
     repositoryOwner,
     repositoryName,
     pullRequestNumber,
 
-    collectInfo: async ({ execCommandInProjectDirectory }) => {
-      if (installCommand) await execCommandInProjectDirectory(installCommand)
-      if (buildCommand) await execCommandInProjectDirectory(buildCommand)
+    collectInfo: async ({ execCommandInRootDirectory }) => {
+      if (installCommand) await execCommandInRootDirectory(installCommand)
+      if (buildCommand) await execCommandInRootDirectory(buildCommand)
       const fileSizeReport = await importOneExportFromFile(
         fileSizeReportModuleUrl,
       )