@jsenv/file-size-impact 10.0.1 → 11.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jsenv/file-size-impact",
-  "version": "10.0.1",
+  "version": "11.0.0",
   "description": "Add files size impact into pull requests",
   "license": "MIT",
   "repository": {
@@ -26,38 +26,40 @@
     "/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",
-    "generate-comment-snapshot": "node ./test/comment/generate_comment_snapshot.mjs",
+    "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",
     "prettier-format": "node ./script/prettier/prettier_format.mjs",
     "prettier-format-stage": "npm run prettier-format -- --staged",
     "prettier-check": "npm run prettier-format -- --dry-run",
-    "upload-coverage": "node ./script/test/upload_coverage.mjs",
     "prepublishOnly": "node ./script/publish/remove_postinstall.mjs",
     "postpublish": "node ./script/publish/restore_postinstall.mjs"
   },
   "dependencies": {
-    "@jsenv/github-pull-request-impact": "1.6.3",
+    "@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/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

@@ -1,34 +1,16 @@
-# File size impact
-
-Report pull request impacts on specific files size.
-
-[![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)
-
-# Presentation
+# 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)
 
 `@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.
 
-- Catch file size impacts before merging a pull request
-- Track compressed file size
-- Regroup file into groups to match your project needs
-- Can be added to any workflow like a GitHub workflow
+- Helps you to catch size impacts before merging pull requests
+- Can be configured to track compressed file size
+- Create group of files to create meaningful reports
+- Can be added to any automated process (GitHub workflow, Jenkins, ...)
 
 # Pull request comment
 
 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:
@@ -65,9 +47,11 @@ export const generateFileSizeReport = async () => {
 }
 ```
 
-At this stage, you could generate a file size report on your machine. For an example, see `"generate-file-size-report"` in [package.json#L30](./package.json#L30) and [script/file_size/generate_file_size_report.mjs#L14](./script/file_size/generate_file_size_report.mjs#L14).
+At this stage, you could generate a file size report on your machine. For an example, see [script/file_size/generate_file_size_report.mjs#L14](./script/file_size/generate_file_size_report.mjs#L14).
+
+Now it's time to configure a workflow to compare file size reports before and after merging a pull request.
 
-All that's left is to configure a workflow to do generate a file size report before and after merging a pull request.
+## GitHub workflow
 
 _.github/workflows/file_size_impact.yml_
 
@@ -116,24 +100,24 @@ _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",
 })
 ```
 
-## Other worklow
+## Other tools
 
-For a workflow different from GitHub workflow, there is a few things to do:
+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:
 
 1. Replicate _file_size_impact.yml_
 2. Adjust _report_file_size_impact.mjs_
-3. Create a GitHub token
+3. Create a GitHub token (required to post comment on GitHub)
 
 ### 1. Replicate _file_size_impact.yml_
 
-Your workflow must reproduce the state where your git repository has been cloned and you are currently on the pull request branch. The corresponding commands looks as below:
+Your workflow must reproduce the state where your git repository has been cloned and you are currently on the pull request branch. Something like the commands below.
 
 ```console
 git init
@@ -165,7 +149,20 @@ reportFileSizeImpact({
 
 ### 3. Create a GitHub token
 
-In order to have `process.env.GITHUB_TOKEN` you need to create a GitHub token with `repo` scope at https://github.com/settings/tokens/new. After that you need to setup this environment variable. The exact way to do this is specific to your project and tools. Applied to Travis you could add it to your environment variables as documented in https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings.
+The GitHub token is required to be able to post a commment in the pull request. You need to create a GitHub token with `repo` scope at https://github.com/settings/tokens/new. Finally you need to setup this environment variable. The exact way to do this is specific to the tools your are using.
+
+# How it works
+
+In order to analyse the impact of a pull request on file size the following steps are executed:
+
+1. Checkout pull request base branch
+2. Execute an install command (_npm install_ by default)
+3. Get a file size report (dynamic import of a js module exporting `generateFileSizeReport`)
+4. Merge pull request into its base
+5. Execute command to generate files again
+6. Get a second file size report
+7. Analyse differences between the two file size reports
+8. Post or update comment in the pull request
 
 # getFileSizeReport
 
@@ -197,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,
@@ -224,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 },
 })
 ```
@@ -238,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 }),
@@ -252,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(),
@@ -269,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,
   },
@@ -281,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,
   },
@@ -308,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",
 })
@@ -332,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
 
@@ -358,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}`,
@@ -375,7 +372,7 @@ import { reportFileSizeImpact, readGitHubWorkflowEnv } from "@jsenv/file-size-im
 
 const gitHubWorkflowEnv = readGitHubWorkflowEnv()
 
-reportFileSizeImpact({
+await reportFileSizeImpact({
   ...gitHubWorkflowEnv,
 })
 ```
@@ -410,20 +407,6 @@ These files are generated by build tools. For example by [webpack-manifest-plugi
 
 Read more in [manifestConfig](#manifestConfig) parameter
 
-# How it works
-
-In order to analyse the impact of a pull request on file size the following steps are executed:
-
-1. Checkout pull request base branch
-2. Execute an install command (_npm install_ by default)
-3. Execute a build command to generate files (_npm run-script build_ by default)
-4. Take a snapshot of generated files
-5. Merge pull request into its base
-6. Execute command to generate files again
-7. Take a second snapshot of generated files
-8. Analyse differences between the two snapshots
-9. Post or update comment in the pull request
-
 # See also
 
 - [@jsenv/performance-impact](https://github.com/jsenv/performance-impact): Monitor pull requests impacts but on performance metrics

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,
@@ -49,7 +49,7 @@ const compareTwoGroups = (beforeMergeGroup, afterMergeGroup) => {
         relativeUrl: beforeMergeRelativeUrl,
         manifestKey:
           manifestKeyFromRelativeUrl(beforeMergeRelativeUrl, beforeMergeMappings) || null,
-        ...beforeMergeFileMap[afterMergeRelativeUrl],
+        ...beforeMergeFileMap[beforeMergeRelativeUrl],
       },
       afterMerge: {
         relativeUrl: afterMergeRelativeUrl,