@jsenv/file-size-impact 12.1.3 → 12.1.7

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "12.1.3",
+  "version": "12.1.7",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {
@@ -39,7 +39,7 @@
   "dependencies": {
     "@jsenv/dynamic-import-worker": "1.0.1",
     "@jsenv/filesystem": "2.7.1",
-    "@jsenv/github-pull-request-impact": "1.6.6",
+    "@jsenv/github-pull-request-impact": "1.6.9",
     "@jsenv/logger": "4.0.1",
     "pretty-bytes": "5.6.0"
   },

package/readme.md

@@ -1,4 +1,4 @@
-# File size impact [![npm package](https://img.shields.io/npm/v/@jsenv/file-size-impact.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/file-size-impact) [![workflow status](https://github.com/jsenv/file-size-impact/workflows/main/badge.svg)](https://github.com/jsenv/file-size-impact/actions?workflow=main) [![codecov](https://codecov.io/gh/jsenv/file-size-impact/branch/master/graph/badge.svg)](https://codecov.io/gh/jsenv/file-size-impact)
+# File size impact [![npm package](https://img.shields.io/npm/v/@jsenv/file-size-impact.svg?logo=npm&label=package)](https://www.npmjs.com/package/@jsenv/file-size-impact)
 
 `@jsenv/file-size-impact` analyses a pull request impact on specific files size. This analysis is posted in a comment of the pull request on GitHub.
 
@@ -9,29 +9,16 @@
 
 # Pull request comment
 
-This section shows pull request comment and how to read it.
+Screenshot + explanation on pull request comment.
 
 ![legend of pull request comment](./docs/comment_legend.png)
 
-## group summary
-
-"_remaining files (+4.71%)_" is a group summary, it translates into the following sentence:
-
-> "There is a group of files named **remaining files** and pull request has an overall impact of +4.71% on these files."
-
-## size impact
-
-"_21.6 kB (+4.11 kB / +23.55%)_" is a size impact, it translates into the following sentence:
-
-> "The size after merge is **21.6 kB**. Pull request adds **4.11 kB** representing an increase of **23.55%** of the size before merge."
-
-## Unmodified row
-
-Unmodified row is the sum of all files in a group that are not impacted by changes in the pull request.
-
-## Total row
-
-Total row is the sum of all files in a group.
+| Text                           | How to read it                                                                                                                |
+| ------------------------------ | ----------------------------------------------------------------------------------------------------------------------------- |
+| "remaining files (+4.71%)"     | There is a group of files named "remaining files" and pull request has an overall impact of _+4.71%_ on these files.          |
+| "21.6 kB (+4.11 kB / +23.55%)" | The size after merge is _21.6 kB_. Pull request adds _4.11 kB_ representing an increase of _23.55%_ of the size before merge. |
+| "_Unmodified (4)_"             | Sum files in "remaining files" group not impacted by the pull request.                                                        |
+| _Total (5)_                    | Sum files in "remaining files" group.                                                                                         |
 
 # Installation
 
@@ -46,7 +33,7 @@ _generate_file_size_report.mjs_
 ```js
 import { generateFileSizeReport } from "@jsenv/file-size-impact"
 
-export const filesizeReport = await generateFileSizeReport({
+export const fileSizeReport = await generateFileSizeReport({
   log: process.argv.includes("--log"),
   projectDirectoryUrl: new URL("./", import.meta.url),
   trackingConfig: {
@@ -110,18 +97,23 @@ _report_file_size_impact.mjs_
  * This file is executed by file_size_impact.yml GitHub workflow.
  * - it generates file size report before and after merging a pull request
  * - Then, it creates or updates a comment in the pull request
- * See https://github.com/jsenv/file-size-impact#how-it-works
+ * See https://github.com/jsenv/workflow/tree/main/packages/jsenv-file-size-impact#how-it-works
  */
 
-import { reportFileSizeImpact, readGitHubWorkflowEnv } from "@jsenv/file-size-impact"
+import {
+  reportFileSizeImpact,
+  readGitHubWorkflowEnv,
+} from "@jsenv/file-size-impact"
 
 await reportFileSizeImpact({
   ...readGitHubWorkflowEnv(),
   buildCommand: "npm run dist",
-  fileSizeModulePath: "./generate_file_size_report.mjs",
+  fileSizeReportModulePath: "./generate_file_size_report.mjs#fileSizeReport",
 })
 ```
 
+where `fileSizeReport` is the name of the export from _generate_file_size_report.mjs_.
+
 ## Other tools
 
 If you want to use an other tool than GitHub worflow to run the pull request comparison, like Jenkins, there is a few things to do:
@@ -202,7 +194,7 @@ const fileSizeReport = await generateFileSizeReport({
 _trackingConfig_ parameter is an object used to configure group of files you want to track. This parameter is optional with a default value exported in [src/jsenvTrackingConfig.js](./src/jsenvTrackingConfig.js)
 
 _trackingConfig_ keys are group names that will appear in the generated comment.
-_trackingConfig_ values are objects associating a pattern to a value. This object is refered as _metaValueMap_ in [@jsenv/url-meta#structuredMetaMap](https://github.com/jsenv/jsenv-url-meta#structuredmetamap).
+_trackingConfig_ values are objects associating a pattern to a value. This object is refered as _metaValueMap_ in [@jsenv/url-meta#structuredMetaMap](https://github.com/jsenv/url-meta#structuredmetamap).
 
 For example you can create two groups named _"critical files"_ and _"remaining files"_ like this:
 
@@ -234,7 +226,12 @@ _transformations_ parameter is an object used to transform files content before
 You can use this parameter to track file size after gzip compression.
 
 ```js
-import { generateFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
+import {
+  generateFileSizeReport,
+  raw,
+  gzip,
+  brotli,
+} from "@jsenv/file-size-impact"
 
 await generateFileSizeReport({
   transformations: { raw, gzip, brotli },
@@ -262,7 +259,12 @@ await generateFileSizeReport({
 Finally _transformations_ can be used to add custom _transformations_.
 
 ```js
-import { generateFileSizeReport, raw, gzip, brotli } from "@jsenv/file-size-impact"
+import {
+  generateFileSizeReport,
+  raw,
+  gzip,
+  brotli,
+} from "@jsenv/file-size-impact"
 
 await generateFileSizeReport({
   transformations: {
@@ -320,7 +322,7 @@ await reportFileSizeImpact({
 
   installCommand: "npm install",
   buildCommand: "npm run build",
-  fileSizeModulePath: "./generate_file_size_report.mjs",
+  fileSizeReportModulePath: "./generate_file_size_report.mjs#fileSizeReport",
 
   filesOrdering: "size_impact",
 })
@@ -389,7 +391,10 @@ _commitInGeneratedByInfo_ parameter is a boolean controlling if a link to the co
 _readGitHubWorkflowEnv_ is a function meant to be runned inside a GitHub workflow. It returns an object meant to be forwarded to [reportFileSizeImpact](#reportFileSizeImpact).
 
 ```js
-import { reportFileSizeImpact, readGitHubWorkflowEnv } from "@jsenv/file-size-impact"
+import {
+  reportFileSizeImpact,
+  readGitHubWorkflowEnv,
+} from "@jsenv/file-size-impact"
 
 const gitHubWorkflowEnv = readGitHubWorkflowEnv()
 
@@ -402,13 +407,13 @@ _gitHubWorkflowEnv_ object looks like this:
 
 ```js
 const gitHubWorkflowEnv = {
-  projectDirectoryUrl: "/home/runner/work/repo-name/repo-name",
+  projectDirectoryUrl: "/home/runner/work/repository-name",
   githubToken: "xxx",
   repositoryOwner: "jsenv",
-  repositoryName: "file-size-impact",
+  repositoryName: "repository-name",
   pullRequestNumber: 10,
   runLink: {
-    url: "https://github.com/jsenv/file-size-impact/actions/runs/34",
+    url: "https://github.com/jsenv/repository-name/actions/runs/34",
     text: "workflow-name#34",
   },
 }
@@ -430,8 +435,8 @@ Read more in [manifestConfig](#manifestConfig) parameter
 
 # See also
 
-- [@jsenv/performance-impact](https://github.com/jsenv/performance-impact): Monitor pull requests impacts but on performance metrics
-- [@jsenv/lighthouse-impact](https://github.com/jsenv/lighthouse-impact): Monitor pull requests impacts but on lighthouse score
+- [@jsenv/performance-impact](../jsenv-performance-impact): Monitor pull requests impacts but on performance metrics
+- [@jsenv/lighthouse-impact](../jsenv-lighthouse-impact): Monitor pull requests impacts but on lighthouse score
 
 # Note about GitHub workflow paths
 

package/src/reportFileSizeImpact.js

@@ -109,7 +109,7 @@ export const reportFileSizeImpact = async ({
       })
     },
     generatedByLink: {
-      url: "https://github.com/jsenv/file-size-impact",
+      url: "https://github.com/jsenv/workflow/tree/main/packages/jsenv-file-size-impact",
       text: "@jsenv/file-size-impact",
     },
     runLink,