@jsenv/file-size-impact 12.1.11 → 12.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "12.1.11",
+  "version": "12.2.0",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {

package/readme.md

@@ -28,7 +28,7 @@ The first thing you need is a script capable to generate a file size report.
 npm install --save-dev @jsenv/file-size-impact
 ```
 
-_generate_file_size_report.mjs_
+_file_size.mjs_
 
 ```js
 import { generateFileSizeReport } from "@jsenv/file-size-impact"
@@ -48,7 +48,7 @@ export const fileSizeReport = await generateFileSizeReport({
 At this stage, you could generate a file size report on your machine with the following command.
 
 ```console
-node ./generate_file_size_report.mjs --log
+node ./_file_size.mjs --log
 ```
 
 Now it's time to configure a workflow to compare file size reports before and after merging a pull request.
@@ -85,7 +85,7 @@ jobs:
       - name: Setup npm
         run: npm install
       - name: Report file size impact
-        run: node ./report_file_size_impact.mjs
+        run: node ./file_size.mjs
         env:
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
 ```
@@ -108,11 +108,16 @@ import {
 await reportFileSizeImpact({
   ...readGitHubWorkflowEnv(),
   buildCommand: "npm run dist",
-  fileSizeReportModulePath: "./generate_file_size_report.mjs#fileSizeReport",
+  fileSizeReportModulePath: new URL(
+    "./file_size.mjs#fileSizeReport",
+    import.meta.url,
+  ),
 })
 ```
 
-where `fileSizeReport` is the name of the export from _generate_file_size_report.mjs_.
+**Notes**:
+
+- "#fileSizeReport" is the name of the export from _file_size.mjs_.
 
 ## Other tools
 
@@ -322,8 +327,10 @@ await reportFileSizeImpact({
 
   installCommand: "npm install",
   buildCommand: "npm run build",
-  fileSizeReportModulePath: "./generate_file_size_report.mjs#fileSizeReport",
-
+  fileSizeReportModulePath: new URL(
+    "./file_size.mjs#fileSizeReport",
+    import.meta.url,
+  ),
   filesOrdering: "size_impact",
 })
 ```

package/src/internal/jsenvCommentParameters.js

@@ -96,7 +96,7 @@ export const jsenvFormatEmojiCell = ({ sizeBeforeMerge, sizeAfterMerge }) => {
 export const jsenvCommentParameters = {
   filesOrdering: "size_impact",
   maxFilesPerGroup: 600,
-  fileRelativeUrlMaxLength: 100,
+  fileRelativeUrlMaxLength: 50,
   formatGroupSummary: jsenvFormatGroupSummary,
   formatFileRelativeUrl: jsenvFormatFileRelativeUrl,
 

package/src/reportFileSizeImpact.js

@@ -1,5 +1,5 @@
 import { commentGitHubPullRequestImpact } from "@jsenv/github-pull-request-impact"
-import { assertAndNormalizeDirectoryUrl, resolveUrl } from "@jsenv/filesystem"
+import { assertAndNormalizeDirectoryUrl } from "@jsenv/filesystem"
 
 import { importOneExportFromFile } from "@jsenv/dynamic-import-worker"
 import { formatComment } from "./internal/formatComment.js"
@@ -36,6 +36,21 @@ export const reportFileSizeImpact = async ({
   runLink,
   commitInGeneratedByInfo,
 }) => {
+  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
+  let fileSizeReportModuleUrl
+  if (fileSizeReportModulePath === "string") {
+    fileSizeReportModuleUrl = new URL(
+      fileSizeReportModulePath,
+      rootDirectoryUrl,
+    ).href
+  } else if (fileSizeReportModulePath instanceof URL) {
+    fileSizeReportModuleUrl = fileSizeReportModulePath.href
+  } else {
+    throw new TypeError(
+      `fileSizeReportModulePath must be a string or an url but received ${fileSizeReportModulePath}`,
+    )
+  }
+
   if (installCommand === null) {
     // a null installCommand means there is no need to install anything
   } else if (typeof installCommand !== "string") {
@@ -52,17 +67,6 @@ export const reportFileSizeImpact = async ({
     )
   }
 
-  if (typeof fileSizeReportModulePath !== "string") {
-    throw new TypeError(
-      `fileSizeReportModulePath must be a string but received ${fileSizeReportModulePath}`,
-    )
-  }
-  rootDirectoryUrl = assertAndNormalizeDirectoryUrl(rootDirectoryUrl)
-  const fileSizeReportModuleUrl = resolveUrl(
-    fileSizeReportModulePath,
-    rootDirectoryUrl,
-  )
-
   return commentGitHubPullRequestImpact({
     logLevel,
     commandLogs,
@@ -75,9 +79,9 @@ export const reportFileSizeImpact = async ({
     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,
       )