@jsenv/file-size-impact 10.0.4 → 11.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "10.0.4",
+  "version": "11.0.0",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {
@@ -26,9 +26,9 @@
     "/index.js"
   ],
   "scripts": {
-    "eslint-check": "node ./node_modules/eslint/bin/eslint.js .",
+    "eslint-check": "node ./node_modules/eslint/bin/eslint.js . --ext=.js,.mjs",
     "generate-importmap": "node ./script/importmap/generate_importmap.mjs",
-    "generate-file-size-report": "node ./script/file_size/generate_file_size_report.mjs --local",
+    "measure-file-sizes": "node ./script/file_size/generate_file_size_report.mjs --local",
     "generate-comment-snapshot-file": "node ./test/comment/generate_comment_snapshot_file.mjs",
     "test": "node ./script/test/test.mjs",
     "test-with-coverage": "npm run test -- --coverage",
@@ -41,23 +41,25 @@
   "dependencies": {
     "@jsenv/github-pull-request-impact": "1.6.4",
     "@jsenv/logger": "4.0.1",
-    "@jsenv/util": "4.1.1",
+    "@jsenv/filesystem": "2.2.0",
     "pretty-bytes": "5.6.0"
   },
   "devDependencies": {
-    "@jsenv/assert": "2.2.6",
+    "@babel/core": "7.15.8",
+    "@babel/eslint-parser": "7.15.8",
+    "@jsenv/assert": "2.3.2",
     "@jsenv/cancellation": "3.0.0",
     "@jsenv/codecov-upload": "3.5.0",
-    "@jsenv/core": "19.6.2",
-    "@jsenv/eslint-config": "15.0.2",
-    "@jsenv/filesystem": "2.1.1",
+    "@jsenv/core": "23.0.2",
+    "@jsenv/eslint-config": "16.0.8",
+    "@jsenv/filesystem": "2.2.0",
     "@jsenv/github-release-package": "1.2.3",
-    "@jsenv/importmap-eslint-resolver": "5.1.0",
-    "@jsenv/importmap-node-module": "1.0.1",
+    "@jsenv/importmap-eslint-resolver": "5.1.2",
+    "@jsenv/importmap-node-module": "2.4.1",
     "@jsenv/package-publish": "1.6.2",
     "@jsenv/prettier-check-project": "5.6.1",
     "eslint": "7.32.0",
-    "eslint-plugin-import": "2.24.0",
-    "prettier": "2.3.2"
+    "eslint-plugin-import": "2.25.2",
+    "prettier": "2.4.1"
   }
 }

package/readme.md

@@ -11,16 +11,6 @@
 
 This section shows pull request comment and how to read _group summary_ and _size impact_ sections.
 
-_Screenshot of a pull request comment_
-
-![screenshot of pull request comment](./docs/comment-collapsed.png)
-
-_Screenshot when comment is expanded_
-
-![screenshot of pull request comment expanded](./docs/comment-expanded.png)
-
-## Pull request comment legend
-
 ![legend of pull request comment](./docs/comment-legend.png)
 
 "_critical files (1/2)_" is a group summary, it translates into the following sentence:
@@ -110,10 +100,10 @@ _report_file_size_impact.mjs_
 
 import { reportFileSizeImpact, readGitHubWorkflowEnv } from "@jsenv/file-size-impact"
 
-reportFileSizeImpact({
+await reportFileSizeImpact({
   ...readGitHubWorkflowEnv(),
   buildCommand: "npm run dist",
-  moduleGeneratingFileSizeReportRelativeUrl: "./generate_file_size_report.mjs",
+  fileSizeModulePath: "./generate_file_size_report.mjs",
 })
 ```
 
@@ -204,7 +194,7 @@ For example you can create two groups named _"critical files"_ and _"remaining f
 ```js
 import { getFileSizeReport } from "@jsenv/file-size-impact"
 
-getFileSizeReport({
+await getFileSizeReport({
   trackingConfig: {
     "critical files": {
       "./dist/main.js": true,
@@ -231,7 +221,7 @@ You can use this parameter to track file size after gzip compression.
 ```js
 import { getFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
 
-getFileSizeReport({
+await getFileSizeReport({
   transformations: { raw, gzip, brotli },
 })
 ```
@@ -245,7 +235,7 @@ It's also possible to control compression level.
 ```js
 import { getFileSizeReport, raw, gzip } from "@jsenv/file-size-impact"
 
-getFileSizeReport({
+await getFileSizeReport({
   transformations: {
     raw,
     gzip7: (buffer) => gzip(buffer, { level: 7 }),
@@ -259,7 +249,7 @@ Finally _transformations_ can be used to add custom _transformations_.
 ```js
 import { getFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
 
-getFileSizeReport({
+await getFileSizeReport({
   transformations: {
     raw,
     trim: (buffer) => String(buffer).trim(),
@@ -276,7 +266,7 @@ This parameter reuses the shape of [trackingConfig](#trackingConfig) (associatin
 ```js
 import { reportFileSizeImpact } from "@jsenv/file-size-impact"
 
-reportFileSizeImpact({
+await reportFileSizeImpact({
   manifestConfig: {
     "./dist/**/manifest.json": true,
   },
@@ -288,7 +278,7 @@ You can disable manifest files handling by passing `null`.
 ```js
 import { reportFileSizeImpact } from "@jsenv/file-size-impact"
 
-reportFileSizeImpact({
+await reportFileSizeImpact({
   manifestConfig: {
     "./dist/**/manifest.json": null,
   },
@@ -315,7 +305,7 @@ await reportFileSizeImpact({
 
   installCommand: "npm install",
   buildCommand: "npm run build",
-  moduleGeneratingFileSizeReportRelativeUrl: "./generate_file_size_report.mjs",
+  fileSizeModulePath: "./generate_file_size_report.mjs",
 
   filesOrdering: "size_impact",
 })
@@ -339,9 +329,9 @@ _installCommand_ parameter is a string representing the command to run in order
 
 _buildCommand_ parameter is a string representing the command to run in order to generate files. This parameter is optional with a default value of `"npm run-script build"`. You can pass `null` if you don't need to run a build command before computing file sizes.
 
-## moduleGeneratingFileSizeReportRelativeUrl
+## fileSizeModulePath
 
-_moduleGeneratingFileSizeReportRelativeUrl_ 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 [projectDirectoryUrl](#projectDirectoryUrl) leading a module file. This file must contain a _generateFileSizeReport_ export.
 
 ## filesOrdering
 
@@ -365,7 +355,7 @@ Inside an other workflow, you can pass your own _runLink_. As in the example bel
 ```js
 import { reportFileSizeImpact } from "@jsenv/file-size-impact"
 
-reportFileSizeImpact({
+await reportFileSizeImpact({
   runLink: {
     url: process.env.BUILD_URL,
     text: `${process.env.JOB_NAME}#${process.env.BUILD_ID}`,
@@ -382,7 +372,7 @@ import { reportFileSizeImpact, readGitHubWorkflowEnv } from "@jsenv/file-size-im
 
 const gitHubWorkflowEnv = readGitHubWorkflowEnv()
 
-reportFileSizeImpact({
+await reportFileSizeImpact({
   ...gitHubWorkflowEnv,
 })
 ```

package/src/getFileSizeReport.js

@@ -5,7 +5,7 @@ import {
   resolveUrl,
   readFile,
   urlToFileSystemPath,
-} from "@jsenv/util"
+} from "@jsenv/filesystem"
 
 import { transform as rawTransform } from "./rawTransformation.js"
 import { jsenvTrackingConfig } from "./jsenvTrackingConfig.js"

package/src/internal/applyTrackingConfig.js

@@ -1,4 +1,4 @@
-import { urlToFileSystemPath, collectDirectoryMatchReport } from "@jsenv/util"
+import { urlToFileSystemPath, collectDirectoryMatchReport } from "@jsenv/filesystem"
 import { createCancellationToken } from "@jsenv/cancellation"
 
 export const applyTrackingConfig = async (

package/src/internal/compareTwoFileSizeReports.js

@@ -1,4 +1,4 @@
-import { resolveUrl, comparePathnames, urlToRelativeUrl } from "@jsenv/util"
+import { resolveUrl, comparePathnames, urlToRelativeUrl } from "@jsenv/filesystem"
 
 export const compareTwoFileSizeReports = ({
   afterMergeFileSizeReport,

package/src/internal/formatComment.js

@@ -1,8 +1,8 @@
 import { compareTwoFileSizeReports } from "./compareTwoFileSizeReports.js"
-import { getSizeMaps } from "./getSizeMaps.js"
 import { isAdded, isModified, isDeleted } from "./helper.js"
 import { renderImpactTable } from "./renderImpactTable.js"
 import { orderBySizeImpact } from "./orderBySizeImpact.js"
+import { getSizeMapsOneFile, getSizeMapsForManyFiles } from "./size_map.js"
 
 export const formatComment = ({
   pullRequestBase,
@@ -11,14 +11,13 @@ export const formatComment = ({
   afterMergeFileSizeReport,
 
   filesOrdering,
-  maxRowsPerTable,
+  maxFilesPerGroup,
   fileRelativeUrlMaxLength,
   formatGroupSummary,
-  formatHiddenImpactSummary,
   formatFileRelativeUrl,
   formatFileCell,
   formatFileSizeImpactCell,
-  formatGroupSizeImpactCell,
+  formatEmojiCell,
   shouldOpenGroupByDefault,
 }) => {
   const warnings = []
@@ -40,14 +39,13 @@ export const formatComment = ({
     reportComparison,
 
     filesOrdering,
-    maxRowsPerTable,
+    maxFilesPerGroup,
     fileRelativeUrlMaxLength,
     formatGroupSummary,
-    formatHiddenImpactSummary,
     formatFileRelativeUrl,
     formatFileCell,
     formatFileSizeImpactCell,
-    formatGroupSizeImpactCell,
+    formatEmojiCell,
     shouldOpenGroupByDefault,
   })
 
@@ -64,199 +62,110 @@ const renderCommentBody = ({
   reportComparison,
 
   filesOrdering,
+  maxFilesPerGroup,
   fileRelativeUrlMaxLength,
-  maxRowsPerTable,
   formatGroupSummary,
-  formatHiddenImpactSummary,
   formatFileRelativeUrl,
   formatFileCell,
   formatFileSizeImpactCell,
-  formatGroupSizeImpactCell,
+  formatEmojiCell,
   shouldOpenGroupByDefault,
 }) => {
-  const overallImpactInfo = {}
+  const { groups, transformationKeys } = reportComparison
 
-  const renderGroup = (
-    groupMessage,
-    {
-      groupName,
-      groupComparison,
-      groupFileCount,
-      groupImpactCount,
-      fileByFileImpact,
-      groupHiddenImpactCount,
-      fileByFileImpactHidden,
-    },
-  ) => {
-    const groupSummary = formatGroupSummary({
-      groupName,
-      groupImpactCount,
-      groupFileCount,
-    })
-    const groupShouldBeOpenByDefault = shouldOpenGroupByDefault({
-      groupName,
-      groupComparison,
-      groupFileCount,
-      groupImpactCount,
-      fileByFileImpact,
-      groupHiddenImpactCount,
-      fileByFileImpactHidden,
-    })
-
-    return renderDetails({
-      open: groupShouldBeOpenByDefault,
-      summary: groupSummary,
-      content: groupMessage,
-    })
-  }
-
-  const { transformationKeys } = reportComparison
-  const groupMessages = Object.keys(reportComparison.groups).map((groupName) => {
-    const groupComparison = reportComparison.groups[groupName]
+  const groupMessages = Object.keys(groups).map((groupName) => {
+    const groupComparison = groups[groupName]
     const groupFileImpactMap = groupComparison.fileImpactMap
-    const groupFileCount = Object.keys(groupFileImpactMap).length
     let fileByFileImpact = {}
-    let fileByFileImpactHidden = {}
-    if (groupFileCount === 0) {
-      return renderGroup(
-        formulateEmptyGroupContent({
-          groupName,
-          groupConfig: groupComparison.tracking,
-        }),
-        {
-          groupName,
-          groupComparison,
-          groupFileCount,
-          groupImpactCount: 0,
-          fileByFileImpact,
-          groupHiddenImpactCount: 0,
-          fileByFileImpactHidden,
-        },
-      )
-    }
+    const files = Object.keys(groupFileImpactMap)
 
-    const addImpact = (fileRelativeUrl, { event, beforeMerge, afterMerge }) => {
+    files.forEach((fileRelativeUrl) => {
+      const { beforeMerge, afterMerge } = groupFileImpactMap[fileRelativeUrl]
+      const event = isAdded({ beforeMerge, afterMerge })
+        ? "added"
+        : isDeleted({ beforeMerge, afterMerge })
+        ? "deleted"
+        : isModified({ beforeMerge, afterMerge })
+        ? "modified"
+        : "none"
       const meta = event === "deleted" ? beforeMerge.meta : afterMerge.meta
-      const impact = {
-        event,
+
+      const { sizeMapBeforeMerge, sizeMapAfterMerge, sizeImpactMap } = getSizeMapsOneFile({
+        sizeNames: transformationKeys,
         beforeMerge,
         afterMerge,
-      }
-
-      const data = metaToData(meta, { fileRelativeUrl, event, beforeMerge, afterMerge })
-      if (data.showSizeImpact) {
-        if (!overallImpactInfo.hasOwnProperty(fileRelativeUrl)) {
-          overallImpactInfo[fileRelativeUrl] = groupName
-        }
-
-        fileByFileImpact[fileRelativeUrl] = { ...impact, ...data }
-      } else {
-        fileByFileImpactHidden[fileRelativeUrl] = { ...impact, ...data }
-      }
-    }
-
-    Object.keys(groupFileImpactMap).forEach((fileRelativeUrl) => {
-      const { beforeMerge, afterMerge } = groupFileImpactMap[fileRelativeUrl]
-
-      if (isAdded({ beforeMerge, afterMerge })) {
-        addImpact(fileRelativeUrl, {
-          event: "added",
-          beforeMerge,
-          afterMerge,
-        })
-        return
-      }
-
-      if (isDeleted({ beforeMerge, afterMerge })) {
-        addImpact(fileRelativeUrl, {
-          event: "deleted",
-          beforeMerge,
-          afterMerge,
-        })
-        return
-      }
-
-      if (isModified({ beforeMerge, afterMerge })) {
-        addImpact(fileRelativeUrl, {
-          event: "modified",
-          beforeMerge,
-          afterMerge,
-        })
+      })
+      const { showSizeImpact, formatFileRelativeUrl } = metaToData(meta, {
+        fileRelativeUrl,
+        sizeBeforeMerge: sizeMapBeforeMerge[0],
+        sizeAfterMerge: sizeMapAfterMerge[0],
+        sizeImpactMap,
+      })
+      fileByFileImpact[fileRelativeUrl] = {
+        event,
+        manifestKeyBeforeMerge: beforeMerge ? beforeMerge.manifestKey : undefined,
+        manifestKeyAfterMerge: afterMerge ? afterMerge.manifestKey : undefined,
+        relativeUrlBeforeMerge: beforeMerge ? beforeMerge.relativeUrl : undefined,
+        relativeUrlAfterMerge: afterMerge ? afterMerge.relativeUrl : undefined,
+        sizeMapBeforeMerge,
+        sizeMapAfterMerge,
+        sizeImpactMap,
+        showSizeImpact,
+        formatFileRelativeUrl,
       }
     })
-
     if (filesOrdering === "size_impact") {
-      fileByFileImpact = orderBySizeImpact(fileByFileImpact, reportComparison.transformationKeys)
-      fileByFileImpactHidden = orderBySizeImpact(
-        fileByFileImpactHidden,
-        reportComparison.transformationKeys,
-      )
+      fileByFileImpact = orderBySizeImpact(fileByFileImpact, transformationKeys)
     }
 
-    const groupImpactCount = Object.keys(fileByFileImpact).length
-    const groupHiddenImpactCount = Object.keys(fileByFileImpactHidden).length
-    if (groupImpactCount === 0 && groupHiddenImpactCount === 0) {
-      return renderGroup(`<p>No impact on files in ${groupName} group.</p>`, {
-        groupName,
-        groupComparison,
-        groupFileCount,
-        groupImpactCount,
-        fileByFileImpact,
-        groupHiddenImpactCount,
-        fileByFileImpactHidden,
-      })
-    }
+    const groupSizeMaps = getSizeMapsForManyFiles({
+      sizeNames: transformationKeys,
+      fileByFileImpact,
+      files,
+    })
+    const groupSizeMapBeforeMerge = groupSizeMaps.sizeMapBeforeMerge
+    const groupSizeMapAfterMerge = groupSizeMaps.sizeMapAfterMerge
+    const groupIsEmpty = Object.keys(fileByFileImpact).length === 0
 
-    const elements = [
-      ...(groupImpactCount > 0
-        ? [
-            renderImpactTable(fileByFileImpact, {
-              groupFileImpactMap,
-              transformationKeys,
-              fileRelativeUrlMaxLength,
-              maxRowsPerTable,
-              formatFileRelativeUrl,
-              formatFileCell,
-              formatFileSizeImpactCell,
-              formatGroupSizeImpactCell,
-            }),
-          ]
-        : []),
-      ...(groupHiddenImpactCount > 0
-        ? [
-            renderDetails({
-              summary: formatHiddenImpactSummary({ groupName, groupHiddenImpactCount }),
-              content: renderImpactTable(fileByFileImpactHidden, {
-                groupFileImpactMap,
-                transformationKeys,
-                fileRelativeUrlMaxLength,
-                maxRowsPerTable,
-                formatFileRelativeUrl,
-                formatFileCell,
-                formatFileSizeImpactCell,
-                formatGroupSizeImpactCell,
-              }),
-            }),
-          ]
-        : []),
-    ]
+    const groupSummary = formatGroupSummary({
+      groupName,
+      groupSizeMapBeforeMerge,
+      groupSizeMapAfterMerge,
+      sizeNames: transformationKeys,
+      fileByFileImpact,
+    })
+    const groupShouldBeOpenByDefault = shouldOpenGroupByDefault({
+      groupName,
+      groupSizeMapBeforeMerge,
+      groupSizeMapAfterMerge,
+      sizeNames: transformationKeys,
+      fileByFileImpact,
+    })
 
-    return renderGroup(
-      elements.join(`
-`),
-      {
-        groupName,
-        groupComparison,
-        groupFileCount,
-        groupImpactCount,
-        fileByFileImpact,
-        groupHiddenImpactCount,
-        fileByFileImpactHidden,
-      },
-    )
+    return renderDetails({
+      open: groupShouldBeOpenByDefault,
+      summary: groupSummary,
+      content: groupIsEmpty
+        ? renderEmptyGroupContent({
+            groupName,
+            groupConfig: groupComparison.tracking,
+          })
+        : renderImpactTable({
+            fileByFileImpact,
+            transformationKeys,
+            fileRelativeUrlMaxLength,
+            maxFilesPerGroup,
+            formatFileRelativeUrl,
+            formatFileCell,
+            formatFileSizeImpactCell,
+            formatEmojiCell,
+            groupSizeMapBeforeMerge,
+            groupSizeMapAfterMerge,
+          }),
+    })
   })
 
-  const mergeImpact = formulateMergeImpact({ pullRequestHead, pullRequestBase, overallImpactInfo })
+  const mergeImpact = formulateMergeImpact({ pullRequestHead, pullRequestBase })
   if (groupMessages.length === 0) {
     return mergeImpact
   }
@@ -267,43 +176,20 @@ ${groupMessages.join(`
 `)}`
 }
 
-const formulateMergeImpact = ({ pullRequestBase, pullRequestHead, overallImpactInfo }) => {
-  const overallImpact = formulateOverallImpact(overallImpactInfo)
-  return `<p>Merging <em>${pullRequestHead}</em> into <em>${pullRequestBase}</em> will ${overallImpact}.</p>`
-}
-
-const formulateOverallImpact = (overallImpactInfo) => {
-  let impactedFileCount = 0
-  let impactedGroupCount = 0
-  const impactedGroups = []
-  Object.keys(overallImpactInfo).forEach((relativeUrl) => {
-    const groupName = overallImpactInfo[relativeUrl]
-    if (groupName) {
-      impactedFileCount++
-      if (!impactedGroups.includes(groupName)) {
-        impactedGroups.push(groupName)
-        impactedGroupCount++
-      }
-    }
-  })
-
-  if (impactedFileCount === 0) {
-    return `not impact files in any group`
-  }
-  return `impact ${formulateFileQuantity(impactedFileCount)} in ${formulateGroupQuantity(
-    impactedGroupCount,
-  )}`
-}
+const renderEmptyGroupContent = ({ groupName, groupConfig }) => {
+  return `<p>No file in ${groupName} group (see config below).</p>
 
-const formulateFileQuantity = (count) => {
-  return count === 1 ? `1 file` : `${count} files`
+\`\`\`json
+${JSON.stringify(groupConfig, null, "  ")}
+\`\`\`
+`
 }
 
-const formulateGroupQuantity = (count) => {
-  return count === 1 ? `1 group` : `${count} groups`
+const formulateMergeImpact = ({ pullRequestBase, pullRequestHead }) => {
+  return `<p>Merging <em>${pullRequestHead}</em> into <em>${pullRequestBase}</em> impact files as follow:</p>`
 }
 
-const metaToData = (meta, { fileRelativeUrl, event, beforeMerge, afterMerge }) => {
+const metaToData = (meta, { fileRelativeUrl, sizeBeforeMerge, sizeAfterMerge, sizeImpactMap }) => {
   if (typeof meta === "boolean") {
     return {
       showSizeImpact: true,
@@ -313,9 +199,9 @@ const metaToData = (meta, { fileRelativeUrl, event, beforeMerge, afterMerge }) =
   if (typeof meta === "object") {
     const showSizeImpact = showSizeImpactGetter(meta, {
       fileRelativeUrl,
-      event,
-      beforeMerge,
-      afterMerge,
+      sizeBeforeMerge,
+      sizeAfterMerge,
+      sizeImpactMap,
     })
     const { formatFileRelativeUrl } = meta
     return {
@@ -330,7 +216,10 @@ const metaToData = (meta, { fileRelativeUrl, event, beforeMerge, afterMerge }) =
   }
 }
 
-const showSizeImpactGetter = (meta, { fileRelativeUrl, event, beforeMerge, afterMerge }) => {
+const showSizeImpactGetter = (
+  meta,
+  { fileRelativeUrl, sizeBeforeMerge, sizeAfterMerge, sizeImpactMap },
+) => {
   const { showSizeImpact } = meta
 
   if (typeof showSizeImpact === "undefined") {
@@ -344,8 +233,9 @@ const showSizeImpactGetter = (meta, { fileRelativeUrl, event, beforeMerge, after
   if (typeof showSizeImpact === "function") {
     return showSizeImpact({
       fileRelativeUrl,
-      event,
-      ...getSizeMaps({ beforeMerge, afterMerge }),
+      sizeBeforeMerge,
+      sizeAfterMerge,
+      sizeImpactMap,
     })
   }
 
@@ -355,15 +245,6 @@ const showSizeImpactGetter = (meta, { fileRelativeUrl, event, beforeMerge, after
   return true
 }
 
-const formulateEmptyGroupContent = ({ groupName, groupConfig }) => {
-  return `<p>No file in ${groupName} group (see config below).</p>
-
-\`\`\`json
-${JSON.stringify(groupConfig, null, "  ")}
-\`\`\`
-`
-}
-
 const renderDetails = ({ summary, content, open = false, indent = 0 }) => {
   return `${" ".repeat(indent)}<details${open ? " open" : ""}>
 ${" ".repeat(indent + 2)}<summary>${summary}</summary>