@adobe/sizewatcher 1.2.1 → 1.4.0

package/CHANGELOG.md

@@ -1,5 +1,43 @@
 # Changelog
 
+## 1.4.0
+
+Major changes:
+
+- [#106](https://github.com/adobe/sizewatcher/issues/106) Require at least node 18. Was 12 before. Node 18 is last version we can make work with being a CommonJS module.
+
+Improvements:
+
+- Upgrade dependencies (many major bumps)
+- Added renovate
+- [#98](https://github.com/adobe/sizewatcher/pull/98) CI: drop `.travis.yml`, was not running on Travis CI for years anyway
+- [#101](https://github.com/adobe/sizewatcher/pull/101) fixed package.json using `npm pkg fix`
+- CI: various CI improvements
+
+Fixes:
+
+- [#108](https://github.com/adobe/sizewatcher/pull/108) [#113](https://github.com/adobe/sizewatcher/pull/113) Git comparator reporting incorrect deltas. now count files in checkout instead of .git folder for consistent sizes
+- [#112](https://github.com/adobe/sizewatcher/pull/112) Node-modules: replace broken cost-of-modules with howfat for better largest modules reporting
+- [#97](https://github.com/adobe/sizewatcher/pull/97) Fix node version 20+ test failures
+
+## 1.3.0
+
+Improvements:
+
+- [#87](https://github.com/adobe/sizewatcher/issues/87) Drop node 10 support
+- Various dependency updates
+
+## 1.2.1
+
+Important bug fixes.
+
+Fixes:
+
+- [#63](https://github.com/adobe/sizewatcher/issues/63) fix and improve git checkout logic
+- [#62](https://github.com/adobe/sizewatcher/issues/62) fix failure on fork PRs
+- [#53](https://github.com/adobe/sizewatcher/issues/53) sizewatcher fails if there is no "package.json" file in the main branch, or if a package.json has no dependencies and thus node_modules is missing
+- [#74](https://github.com/adobe/sizewatcher/issues/74) improve delta calculation (showed weird negative values in some cases)
+
 ## 1.2.0
 
 Improvements:

package/README.md

@@ -33,6 +33,7 @@ While any custom file or folder path can be measured via configuration, various
 
 `sizewatcher` runs as part of your CI and reports results as comment on the pull request or as github commit status (optional), allowing to block PRs if a certain threshold was exceeded.
 
+
 This is an example of a `sizewatcher` Github PR comment with a failure (ignore the small numbers):
 
 ---
@@ -125,7 +126,7 @@ By default `sizewatcher` will
 
 ## Requirements
 
-- [Nodejs](https://nodejs.org) version 10+
+- [Nodejs](https://nodejs.org) version 18+ (since 1.4.0)
   - recommended to use latest stable version "LTS"
 - Github or Github Enterprise
   - if you want to run it on pull requests
@@ -137,12 +138,14 @@ By default `sizewatcher` will
 
 ## Installation
 
-You can install the `sizewatcher` tool locally for testing or checking your changes before committing:
+Local: You can install the `sizewatcher` tool locally for testing or checking your changes before committing:
 
 ```
 npm install -g @adobe/sizewatcher
 ```
 
+For setup in Continuous Integration: see [CI Setup](#ci-setup) section.
+
 ## Usage
 
 When run locally, `sizewatcher` will output its results on the command line.
@@ -230,7 +233,7 @@ npx @adobe/sizewatcher
 This command will always use the latest published version. In some cases it might be (temporarily) desireable to stick to a certain version, which can be achieved using:
 
 ```
-npx @adobe/sizewatcher@1.0.0
+npx @adobe/sizewatcher@1.2.1
 ```
 
 #### GITHUB_TOKEN
@@ -274,11 +277,11 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2
+    - uses: actions/checkout@v4
     - name: Install Node.js
-      uses: actions/setup-node@v1
+      uses: actions/setup-node@v4
       with:
-        node-version: '14'
+        node-version: 'lts/*'
     # ---------- this runs sizewatcher ------------
     - run: npx @adobe/sizewatcher
       env:
@@ -289,7 +292,7 @@ jobs:
 
 For [Travis CI](https://travis-ci.org) you need to
 - use `language: node_js`
-  - if you already use a different language, find a way to ensure Nodejs 10+ is installed
+  - if you already use a different language, find a way to ensure Nodejs 12+ is installed
 - under `script` run `npx @adobe/sizewatcher`
 - set a secret environment variable `GITHUB_TOKEN` in the [Travis repository settings](https://docs.travis-ci.com/user/environment-variables/#defining-variables-in-repository-settings) with a github token with permission to comment on PRs and reporting commit statuses for the repository
 
@@ -309,7 +312,7 @@ script:
 ### CircleCI
 
 For [CircleCI](https://circleci.com) you need to
-- use a docker image with Nodejs 10+ installed
+- use a docker image with Nodejs 12+ installed
   - alternatively install [using nvm](https://www.google.com/search?q=circleci+use+nvm)
 - run `npx @adobe/sizewatcher`
 - set a secret environment variable `GITHUB_TOKEN` in the [CircleCI project settings](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-project) (or in a [Context](https://circleci.com/docs/2.0/env-vars/#setting-an-environment-variable-in-a-context)) with a github token with permission to comment on PRs and reporting commit statuses for the repository
@@ -334,7 +337,7 @@ jobs:
 
 This is not tested well but might work.
 
-Ensure Nodejs 10+ is installed.
+Ensure Nodejs 12+ is installed.
 
 Set these environment variables in the CI job:
 
@@ -432,23 +435,33 @@ comparators:
 
 ### git
 
-Compares the size of the git repository by measuring the `.git` folder. Useful to detect if large files are added to the repo.
+Compares the size of the git repository by measuring the total size of the checked out folder (without the `.git` folder or any build artifacts since it runs first on a clean checkout). Useful to detect if large files are added to the repo.
 
 Name: `git`
 
 Trigger: Runs if a `.git` directory is found.
 
-Details: Shows the largest files (git objects) added in the PR:
+Details: Shows the largest files (git objects) in the entire repository and added in the PR:
 
 ---
-Largest files in new changes:
+Largest files:
 ```
-710a7c687b06  2.8KiB lib/render.js
-0a8f1a2ddb4f  2.4KiB test/config.test.js
-6846cf298cd4  2.3KiB test/config.test.js
-a643d322cc26  1.5KiB lib/config.js
-933e4432aae5     73B .sizewatcher.yml
-6db7d5c27a66     69B .sizewatcher.yml
+Largest files in repository checkout:
+
+   356KiB package-lock.json
+    26KiB README.md
+    11KiB LICENSE
+   5.8KiB lib/compare.js
+   5.8KiB lib/checkout.js
+   5.0KiB test/mocha-capture-console.js
+   4.7KiB test/cli.test.js
+   4.5KiB lib/report.js
+   4.3KiB test/config.test.js
+   3.8KiB lib/render.js
+
+Largest files among new changes:
+
+ 3.0KiB CHANGELOG.md
 ```
 ---
 
@@ -460,34 +473,37 @@ Name: `node_modules`
 
 Trigger: Runs if a `package.json` is found.
 
-Details: Prints the largest modules using [cost-of-modules](https://www.npmjs.com/package/cost-of-modules):
+Details: Prints the largest modules using [howfat](https://www.npmjs.com/package/howfat):
 
 ---
-Largest node modules:
-```
-┌───────────────┬─────────────┬────────┐
-│ name          │ children    │ size   │
-├───────────────┼─────────────┼────────┤
-│ @octokit/rest │ 33          │ 11.25M │
-├───────────────┼─────────────┼────────┤
-│ js-yaml       │ 3           │ 0.72M  │
-├───────────────┼─────────────┼────────┤
-│ simple-git    │ 2           │ 0.24M  │
-├───────────────┼─────────────┼────────┤
-│ tmp           │ 13          │ 0.22M  │
-├───────────────┼─────────────┼────────┤
-│ debug         │ 1           │ 0.08M  │
-├───────────────┼─────────────┼────────┤
-│ deepmerge     │ 0           │ 0.03M  │
-├───────────────┼─────────────┼────────┤
-│ require-dir   │ 0           │ 0.02M  │
-├───────────────┼─────────────┼────────┤
-│ du            │ 1           │ 0.01M  │
-├───────────────┼─────────────┼────────┤
-│ pretty-bytes  │ 0           │ 0.01M  │
-├───────────────┼─────────────┼────────┤
-│ 9 modules     │ 34 children │ 4.57M  │
-└───────────────┴─────────────┴────────┘
+Largest production node modules:
+```
+@adobe/sizewatcher@1.3.0 (67 deps, 21.64mb, 2583 files, ©undefined)
+╭───────────────────────┬──────────────┬──────────┬───────┬───────────┬────────────┬───────────╮
+│ Name                  │ Dependencies │     Size │ Files │ Native    │ License    │ Deprec    │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ @octokit/rest@19.0.3  │           25 │     11mb │   380 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ glob@10.3.5           │           27 │   3.08mb │   367 │           │ ISC        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ simple-git@3.22.0     │            4 │ 934.57kb │   142 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ js-yaml@4.1.0         │            1 │ 562.78kb │    40 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ xbytes@1.9.1          │              │  74.45kb │    11 │           │ Apache-2.0 │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ tmp@0.2.3             │              │  53.08kb │     5 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ debug@4.4.0           │            1 │  48.36kb │    11 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ deepmerge@4.3.1       │              │  30.43kb │    11 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ require-dir@1.2.0     │              │  16.87kb │    40 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ get-folder-size@5.0.0 │              │  11.65kb │     5 │           │ MIT        │           │
+├───────────────────────┼──────────────┼──────────┼───────┼───────────┼────────────┼───────────┤
+│ pretty-bytes@5.6.0    │              │  11.27kb │     5 │           │ MIT        │           │
+╰───────────────────────┴──────────────┴──────────┴───────┴───────────┴────────────┴───────────╯
 ```
 
 Configuration: supports `dir`
@@ -640,6 +656,23 @@ If you want to add a new automatic comparator for language X or dependency manag
 6. test and validate
 7. create PR
 
+### How to release
+
+How to create a new release of version `1.4` (as example):
+
+1. Ensure all changes are merged to `main`
+2. On `main` checkout, bump version in `package.json` to `1.4`
+3. Run `npm publish --dry-run` to ensure all looks good
+4. Commit straight to `main` like [here](https://github.com/adobe/sizewatcher/commit/4da848b6cc52a38f98203760f8f74e44a0ec77cd)
+5. Create a new draft [release in Github](https://github.com/adobe/sizewatcher/releases)
+   1. Nmae the release `1.4`
+   2. Add release notes with new features, improvements, fixes
+   3. Ensure github creates a tag `v1.4`
+6. Save draft and check things look good
+7. Publish the release
+8. The [Publish Package to NPM](https://github.com/adobe/sizewatcher/actions/workflows/npm-publish.yml) Github action workflow should automatically release the new version to npmjs.com
+
+
 ## Licensing
 
 This project is licensed under the Apache V2 License. See [LICENSE](LICENSE) for more information.

package/lib/checkout.js

@@ -18,7 +18,9 @@ const debug = require("debug")("sizewatcher");
 const tmp = require("tmp");
 tmp.setGracefulCleanup();
 const path = require("path");
+// TODO: get rid of simple-git, replace with execSync('git ...') (sanitize user input!)
 const Git = require("simple-git");
+const { execSync } = require("child_process");
 
 async function getGitRoot(dir) {
     // --git-dir will return relative directories
@@ -36,10 +38,8 @@ async function currentBranch(dir) {
     return branch;
 }
 
-async function currentSha(dir) {
-    const git = Git(dir);
-    const sha = await git.revparse(["HEAD"]);
-    return sha;
+async function commitSha(dir, branch) {
+    return Git(dir).revparse([branch]);
 }
 
 async function getDefaultBranch(dir) {
@@ -50,17 +50,18 @@ async function getDefaultBranch(dir) {
             return m[1];
         }
     } catch (e) {
-        debug(`ignoring error in getDefaultBranch(): ${e.message}`);
+        debug(`- ignoring error in getDefaultBranch(): ${e.message}`);
     }
 }
 
-async function hasBranch(dir, branch) {
+// works with branch names and commit hashes
+async function hasRef(dir, branch) {
     try {
-        await Git(dir).revparse(["--verify", branch]);
-        return branch;
+        await Git(dir).catFile(["commit", branch]);
+        return true;
     } catch (e) {
-        debug(`ignoring error in hasBranch(): ${e.message}`);
-        return undefined;
+        debug(`- git returned with non-zero exit code in hasRef(), treating as false: ${e.message}`);
+        return false;
     }
 }
 
@@ -73,9 +74,9 @@ async function getBeforeBranch(dir, branch) {
     return branch
         || await getPullRequestBaseBranch()
         || await getDefaultBranch(dir)
-        || await hasBranch(dir, "main")
-        || await hasBranch(dir, "trunk")
-        || await hasBranch(dir, "master"); // eslint-disable-line no-return-await
+        || (await hasRef(dir, "main") && "main")
+        || (await hasRef(dir, "trunk") && "trunk")
+        || (await hasRef(dir, "master") && "master"); // eslint-disable-line no-return-await
 }
 
 async function getAfterBranch(dir, branch) {
@@ -90,46 +91,47 @@ async function getAfterBranch(dir, branch) {
 async function cloneRemoteAndCheckout(from, to, branch) {
     // 1. get remote url from existing checkout from CI (in `from` dir)
     const remoteUrl = (await Git(from).remote(["get-url", "origin"])).trim();
-    debug(`cloning ${remoteUrl} into ${to}`);
+    debug(`- git clone ${remoteUrl} into ${to}`);
 
     // 2. git clone remote url into new directory `to`
     await Git().clone(remoteUrl, to);
 
     // 3. checkout desired branch
-    debug(`checking out '${branch}'...`);
+    debug(`- git checkout '${branch}'...`);
     await Git(to).checkout(branch);
 }
 
 async function cloneLocalAndCheckout(from, to, branch) {
     const gitRoot = await getGitRoot(from);
 
-    debug(`local cloning ${gitRoot} into ${to}`);
+    // local clone will preserve the HEAD (aka same branch)
+    debug(`- local cloning ${gitRoot} into ${to}`);
     await Git().clone(gitRoot, to, { '--local'  : true });
 
     if (branch) {
-        debug(`checking out '${branch}'...`);
+        debug(`- checking out '${branch}'...`);
         await Git(to).checkout(branch);
     }
 }
 
 async function gitCheckoutBeforeAndAfter(gitDir, beforeBranch, afterBranch) {
-    debug(`retrieving before branch: ${beforeBranch}`);
-    beforeBranch = await getBeforeBranch(gitDir, beforeBranch);
-    debug(`retrieving after branch: ${afterBranch}`);
-    afterBranch = await getAfterBranch(gitDir, afterBranch);
-    if (beforeBranch === afterBranch) {
+    const resolvedBeforeBranch = await getBeforeBranch(gitDir, beforeBranch);
+    debug(`resolved before branch '${beforeBranch || ""}' => '${resolvedBeforeBranch}'`);
+
+    const resolvedAfterBranch = await getAfterBranch(gitDir, afterBranch);
+    debug(`resolved after branch '${afterBranch || ""}' => '${resolvedAfterBranch}'`);
+
+    if (resolvedBeforeBranch === resolvedAfterBranch) {
         return {
             before: {
-                branch: beforeBranch
+                branch: resolvedBeforeBranch
             },
             after: {
-                branch: afterBranch,
+                branch: resolvedAfterBranch,
             }
         };
     }
 
-    debug(`cloning branches ${beforeBranch} (before) and ${afterBranch} (after)...`);
-
     const tempDir = tmp.dirSync({unsafeCleanup: true}).name;
     debug(`temporary directory: ${tempDir}`);
 
@@ -138,40 +140,53 @@ async function gitCheckoutBeforeAndAfter(gitDir, beforeBranch, afterBranch) {
     const beforeDir = path.join(tempDir, "before");
 
     // we can use the faster local clone only if the "branch" is present locally
-    if (await hasBranch(gitDir, beforeBranch)) {
-        debug(`[before] using local cloning because existing checkout already has before branch '${beforeBranch}'`);
-        await cloneLocalAndCheckout(gitDir, beforeDir, beforeBranch);
+    if (await hasRef(gitDir, resolvedBeforeBranch)) {
+        debug(`[before] using local cloning (because existing checkout already has '${resolvedBeforeBranch}')`);
+        await cloneLocalAndCheckout(gitDir, beforeDir, resolvedBeforeBranch);
     } else {
-        debug(`[before] using remote cloning, as existing checkout does not have before branch '${beforeBranch}'`);
+        debug(`[before] using remote cloning (because existing checkout does not have '${resolvedBeforeBranch}')`);
         // ...otherwise need to do a full remote clone
-        await cloneRemoteAndCheckout(gitDir, beforeDir, beforeBranch);
+        await cloneRemoteAndCheckout(gitDir, beforeDir, resolvedBeforeBranch);
     }
 
+    debug(`[before] input branch   : ${beforeBranch || ""}`);
+    debug(`[before] resolved branch: ${resolvedBeforeBranch}`);
+    const beforeSha = await commitSha(beforeDir, resolvedBeforeBranch);
+    debug(`[before] branch sha     : ${beforeSha}`);
+    debug(`[before] actual ref     : ${await currentBranch(beforeDir)}`);
+
+    // this is needed mostly for Github actions/checkout with its special PR merge commit replacing the actual last sha
+    debug(`[before] ensure full history - git fetch origin ${resolvedAfterBranch}:${resolvedAfterBranch}...`);
+    execSync(`git fetch origin ${resolvedAfterBranch}:${resolvedAfterBranch}`, { cwd: beforeDir });
+
     // after checkout --------------------------------------------------------------
 
     const afterDir = path.join(tempDir, "after");
 
-    debug(`[after] using local cloning`);
-    await cloneLocalAndCheckout(gitDir, afterDir);
-    try {
-        // need to ensure before branch is available under local name
-        await Git(afterDir).branch([beforeBranch, "-t", `origin/${beforeBranch}`]);
-    } catch (e) {
-        debug("ignoring error", e);
-    }
-    debug(`[after] current branch: ${await currentBranch(afterDir)}`);
+    // always local clone after which preserves the HEAD
+    // works well for CI checkouts where the checkout is in the after state already (unless afterBranch is specified)
+    // if user specified afterBranch on cli, we will checkout that branch after cloning
+    debug(`[after] local cloning${afterBranch ? ` and checking out '${afterBranch}'` : ""}`);
+    await cloneLocalAndCheckout(gitDir, afterDir, afterBranch);
+
+    debug(`[after] input branch   : ${afterBranch || ""}`);
+    debug(`[after] resolved branch: ${resolvedAfterBranch}`);
+    const afterSha = await commitSha(beforeDir, resolvedAfterBranch);
+    debug(`[after] branch sha     : ${afterSha}`);
+    debug(`[after] actual ref     : ${await currentBranch(afterDir)}`);
 
     debug("folders ready");
 
     return {
         before: {
             dir: beforeDir,
-            branch: beforeBranch
+            branch: resolvedBeforeBranch,
+            sha: beforeSha
         },
         after: {
             dir: afterDir,
-            branch: afterBranch,
-            sha: await currentSha(afterDir)
+            branch: resolvedAfterBranch,
+            sha: afterSha
         }
     };
 }

package/lib/comparators/custom.js

@@ -15,12 +15,12 @@
 // comparators/custom.js - compares custom path
 
 const debug = require("debug")("sizewatcher:custom");
-const du = require("du");
 const path = require("path");
 const fs = require("fs");
 const pb = require('pretty-bytes');
 const { spawn } = require('child_process');
 const glob = require("glob");
+const { getFileSize } = require("../size");
 
 async function spawnProcess(command, args, options) {
     return new Promise((resolve, reject) => {
@@ -57,7 +57,7 @@ async function measure(baseDir, globPath, fileListing) {
     const files = glob.sync(path.join(baseDir, globPath));
     for (const file of files) {
         if (fs.existsSync(file)) {
-            const fileSize = await du(file);
+            const fileSize = await getFileSize(file);
             total += fileSize;
 
             if (fileListing) {

package/lib/comparators/git.js

@@ -12,33 +12,54 @@
 
 'use strict';
 
-// comparators/git.js - compares git repo size (.git folder)
+// comparators/git.js - compares git repo size
 
 const debug = require("debug")("sizewatcher:git");
-const du = require("du");
 const path = require("path");
 const fs = require("fs");
 const { execSync } = require("child_process");
-const Git = require("simple-git");
+const { getFileSize, getFolderRegex } = require("../size");
 
 async function getSize(dir) {
-    debug(`git garbage collection of '${dir}'...`);
-    await Git(dir).raw(["gc"]);
+    debug(`calculating folder size of ${dir}...`);
 
-    debug(`calculating folder size of ${dir}/.git...`);
-    return du(path.join(dir, ".git"));
+    return getFileSize(dir, {
+        // do not include .git folder
+        ignore: getFolderRegex(path.join(dir, ".git"))
+    });
 }
 
-async function largestCommits(dir, beforeBranch, afterBranch) {
-    process.chdir(dir);
-    debug(`determining object sizes in new commits...`);
-    // get size of objects in the new commits
+async function getLargestCommits(dir, beforeBranch, afterBranch) {
+    debug(`determining largest objects in commits between ${beforeBranch} and ${afterBranch}...`);
+    // 1. we then get the list of objects in the range
+    // 2. calculate the size of each object
+    // 3. sort the objects by size
+    // 4. format the output nicely (human readable KiB, MiB, GiB, etc)
     return execSync(`git rev-list --objects ${beforeBranch}..${afterBranch} \
         | git cat-file --batch-check='%(objecttype) %(objectname) %(objectsize) %(rest)' \
         | sed -n 's/^blob //p' \
         | sort -r --numeric-sort --key=2 \
-        | cut -c 1-12,41- \
-        | $(command -v gnumfmt || echo numfmt) --field=2 --to=iec-i --suffix=B --padding=7 --round=nearest`).toString();
+        | cut -c 41- \
+        | $(command -v gnumfmt || echo numfmt) --field=1 --to=iec-i --suffix=B --padding=7 --round=nearest`, { cwd: dir }).toString();
+
+    // Note: even if the command will fail this will not throw an error (because of the shell piping)
+    //       this is ok because this is an informational output only
+}
+
+async function getLargestFiles(dir) {
+    debug(`determining largest objects in repo...`);
+    // 1. get the list of objects in the repo
+    // 2. sort the objects by size
+    // 3. show the top 10
+    // 3. format the output nicely (human readable KiB, MiB, GiB, etc)
+    return execSync(`git ls-tree -r --long HEAD \
+        | sort --key 4 -n -r \
+        | head -n 10 \
+        | cut -c 53- \
+        | $(command -v gnumfmt || echo numfmt) --field=1 --to=iec-i --suffix=B --padding=7 --round=nearest`, { cwd: dir }).toString();
+
+    // Note: even if the command will fail this will not throw an error (because of the shell piping)
+    //       this is ok because this is an informational output only
 }
 
 module.exports = {
@@ -50,12 +71,19 @@ module.exports = {
     compare: async function(before, after) {
         const beforeSize = await getSize(before.dir);
         const afterSize = await getSize(after.dir);
-        const details = await largestCommits(after.dir, before.branch, after.sha);
+
+        const largestFiles = await getLargestFiles(after.dir);
+        const largestCommits = await getLargestCommits(before.dir, before.branch, after.branch);
+
+        let details = `Largest files in repository checkout:\n\n${largestFiles}\n`;
+        if (largestCommits.length > 0) {
+            details += `Largest files among new changes:\n\n${largestCommits}`;
+        }
 
         return {
             beforeSize,
             afterSize,
-            detailsLabel: "Largest files in new changes",
+            detailsLabel: "Largest files",
             details
         };
     }

package/lib/comparators/node_modules.js

@@ -16,9 +16,10 @@
 
 const debug = require("debug")("sizewatcher:node_modules");
 const { execSync } = require("child_process");
-const du = require("du");
 const path = require("path");
 const fs = require("fs");
+const { getFileSize } = require("../size");
+
 
 function isEmptyObject(obj) {
     return Object.keys(obj).length === 0 && obj.constructor === Object;
@@ -44,7 +45,7 @@ async function getSize(dir) {
     const nodeModules = path.join(dir, "node_modules");
     if (fs.existsSync(nodeModules)) {
         debug(`calculating folder size of ${nodeModules}...`);
-        return du(nodeModules);
+        return getFileSize(nodeModules);
     } else {
         return 0;
     }
@@ -62,16 +63,16 @@ async function costOfModules(dir) {
         return "(no production dependencies)";
     }
 
-    debug(`running cost-of-modules...`);
+    debug(`running npx howfat...`);
     try {
-        const out = execSync("npx cost-of-modules --less --no-install").toString();
+        const out = execSync("npx howfat -r table --sort size-").toString();
         const PREFIX = "\nCalculating...\n\n\n";
         if (out.startsWith(PREFIX)) {
             return out.substring(PREFIX.length);
         }
         return out;
     } catch (e) {
-        throw new Error(`cost-of-modules failed with: ${e.stdout ? e.stdout.toString() : ""} ${e.stdout ? e.stderr.toString() : ""}`);
+        throw new Error(`howfat failed with: ${e.stdout ? e.stdout.toString() : ""} ${e.stdout ? e.stderr.toString() : ""}`);
     }
 
 }

package/lib/compare.js

@@ -48,10 +48,25 @@ async function compare(before, after) {
 
     console.log("Calculating size changes for");
 
-    for (const name of Object.keys(COMPARATORS)) {
-        const comparator = COMPARATORS[name];
+    const comparators = [];
+    // ensure git comparator comes first as it needs a clean checkout (in after folder)
+    if (COMPARATORS.git) {
+        const comp = COMPARATORS.git;
+        comp.type = "git";
+        comparators.push(comp);
+    }
+    for (const type of Object.keys(COMPARATORS)) {
+        if (type !== "git") {
+            const comp = COMPARATORS[type];
+            comp.type = type;
+            comparators.push(comp);
+        }
+    }
+
+    for (const comparator of comparators) {
+        const type = comparator.type;
 
-        if (name === "custom") {
+        if (type === "custom") {
             // custom comparator, multiple could be configured
             let customConfigs = config.comparators.custom;
             if (!customConfigs) {
@@ -68,9 +83,9 @@ async function compare(before, after) {
 
         } else {
             // fixed comparators
-            const comparatorConfig = config.comparators[name];
+            const comparatorConfig = config.comparators[type];
             if (comparatorConfig === false) {
-                debug(`skipping '${name}' because disabled in config`);
+                debug(`skipping '${type}' because disabled in config`);
                 continue;
             }
             let dirs = ["."];
@@ -83,9 +98,9 @@ async function compare(before, after) {
             }
             for (const dir of dirs) {
                 if (dir !== ".") {
-                    comparator.name = `${name} [${dir}]`;
+                    comparator.name = `${type} [${dir}]`;
                 } else {
-                    comparator.name = name;
+                    comparator.name = type;
                 }
                 comparator.config = comparatorConfig || {};
 
@@ -103,7 +118,7 @@ async function compare(before, after) {
     deltas.before = before;
     deltas.after = after;
 
-    return process(deltas);
+    return processDeltas(deltas);
 }
 
 function exceeds(value, increasePct, limit) {
@@ -126,7 +141,7 @@ function exceeds(value, increasePct, limit) {
     }
 }
 
-function process(deltas) {
+function processDeltas(deltas) {
     const summary = {
         cheers: 0,
         ok: 0,

package/lib/config.js

@@ -39,7 +39,7 @@ function load() {
 
     if (fs.existsSync(CONFIG_FILE)) {
         const data = fs.readFileSync(CONFIG_FILE, "utf8");
-        const loadedConfig = yaml.safeLoad(data) || {};
+        const loadedConfig = yaml.load(data) || {};
 
         config = deepmerge(DEFAULT_CONFIG, loadedConfig);
 
@@ -65,6 +65,6 @@ module.exports = {
     },
 
     asYaml() {
-        return yaml.safeDump(this.get());
+        return yaml.dump(this.get());
     }
 };

package/lib/render.js

@@ -42,7 +42,7 @@ function indentEachLine(string, indent="  ") {
 function renderAsText(deltas) {
     let text = `Sizewatcher measured the following changes:\n\n`;
 
-    text += `  '${deltas.before.branch}' => '${deltas.after.branch}' (sha ${deltas.after.sha})\n\n`;
+    text += `  '${deltas.before.branch}' (sha ${deltas.before.sha}) => '${deltas.after.branch}' (sha ${deltas.after.sha})\n\n`;
 
     for (const d of deltas) {
         if (d.error) {
@@ -101,7 +101,7 @@ function renderAsMarkdown(deltas) {
 
     markdown += `<details><summary>Notes</summary><br>\n\n`;
     markdown += `- PR branch: \`${deltas.after.branch}\` @ ${deltas.after.sha}\n`;
-    markdown += `- Base branch: \`${deltas.before.branch}\`\n`;
+    markdown += `- Base branch: \`${deltas.before.branch}\` @ ${deltas.before.sha}\n`;
     markdown += `- Sizewatcher v${require('../package.json').version}\n`;
     markdown += `- Effective Configuration:\n`;
     markdown += `\n\`\`\`yaml\n${config.asYaml()}\`\`\`\n`;

package/lib/size.js

@@ -0,0 +1,68 @@
+/*
+ * Copyright 2020 Adobe. All rights reserved.
+ * This file is licensed to you under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License. You may obtain a copy
+ * of the License at http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under
+ * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
+ * OF ANY KIND, either express or implied. See the License for the specific language
+ * governing permissions and limitations under the License.
+ */
+
+'use strict';
+
+const debug = require("debug")("sizewatcher:size");
+
+let _getFolderSize;
+
+/**
+ * Get the size of a folder or file
+ *
+ * @param {String} dir Path to the folder or file
+ * @param {Object} options Supported options:
+ *  - ignore: Regex pattern. Any file or folder with a path that matches the pattern will not be counted in the total folder size.
+ * @returns {Promise<Number>} The size of the folder or file in bytes
+ */
+async function getFileSize(dir, options) {
+    // lazy load get-folder-size due to ESM vs. CommonJS
+    if (!_getFolderSize) {
+        _getFolderSize = (await import("get-folder-size")).default;
+    }
+
+    const result = await _getFolderSize(dir, options);
+    if (result.errors) {
+        debug(`get-folder-size of ${dir} returned some errors:`, result.errors);
+    }
+    return result.size;
+}
+
+function escapeRegex(string) {
+    return string.replace(/[/\-\\^$*+?.()|[\]{}]/g, '\\$&');
+}
+
+/**
+ * Get a regex pattern that matches a directory and all its descendants.
+ *
+ * @param {String} dir Path to the directory
+ * @returns {RegExp} The regex pattern
+ */
+function getFolderRegex(dir) {
+    return new RegExp(`^${escapeRegex(dir)}(\\/.*)?$`);
+}
+
+/**
+ * Get a regex pattern that matches a file exactly.
+ *
+ * @param {String} file Path to the file
+ * @returns {RegExp} The regex pattern
+ */
+function getFileRegex(file) {
+    return new RegExp(`^${escapeRegex(file)}$`);
+}
+
+module.exports = {
+    getFileSize,
+    getFolderRegex,
+    getFileRegex
+};

package/lib/sizewatcher.js

@@ -56,7 +56,7 @@ async function sizewatcher(argv) {
             return process.exit();
         }
 
-        console.log(`Comparing changes from '${before.branch}' to '${after.branch}'\n`);
+        console.log(`Comparing changes from '${before.branch}' (sha ${before.sha}) to '${after.branch}' (sha ${after.sha})\n`);
 
         const deltas = await compare(before, after);
 

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@adobe/sizewatcher",
-  "version": "1.2.1",
+  "version": "1.4.0",
   "description": "Warns if your pull requests introduce large size increases.",
   "main": "index.js",
   "bin": {
-    "sizewatcher": "./index.js"
+    "sizewatcher": "index.js"
   },
   "author": "Adobe",
   "license": "Apache-2.0",
-  "repository": "adobe/sizewatcher",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/adobe/sizewatcher.git"
+  },
   "keywords": [
     "size",
     "check",
@@ -19,31 +22,35 @@
     "pull-request"
   ],
   "scripts": {
-    "test": "nyc -r=text -r=lcov mocha",
+    "test": "DEBUG=sizewatcher* nyc -r=text -r=lcov mocha",
     "posttest": "eslint .",
     "report-coverage": "nyc report --reporter=text-lcov | coveralls",
-    "sizewatcher": "DEBUG=sizewatcher* node ./index.js"
+    "sizewatcher": "DEBUG=sizewatcher* node ./index.js",
+    "clean": "rm -rf test/checkout/*/build"
   },
   "devDependencies": {
     "@adobe/eslint-config-asset-compute": "^1.3.0",
     "coveralls": "^3.1.0",
-    "eslint": "^7.1.0",
-    "mocha": "^7.2.0",
-    "mock-fs": "^4.13.0",
-    "nyc": "^15.1.0",
+    "eslint": "^8.0.0",
+    "mocha": "^11.0.0",
+    "mock-fs": "^5.5.0",
+    "nyc": "^17.0.0",
     "supports-color": "^8.1.1"
   },
   "dependencies": {
-    "@octokit/rest": "^18.0.3",
-    "debug": "^4.1.1",
-    "deepmerge": "^4.2.2",
-    "du": "^1.0.0",
-    "glob": "^7.1.6",
-    "js-yaml": "^3.14.0",
-    "pretty-bytes": "^5.3.0",
-    "require-dir": "^1.2.0",
-    "simple-git": "^3.7.1",
-    "tmp": "^0.2.1",
-    "xbytes": "^1.6.2"
+    "@octokit/rest": "19.0.3",
+    "debug": "4.4.0",
+    "deepmerge": "4.3.1",
+    "get-folder-size": "5.0.0",
+    "glob": "10.3.5",
+    "js-yaml": "4.1.0",
+    "pretty-bytes": "5.6.0",
+    "require-dir": "1.2.0",
+    "simple-git": "3.22.0",
+    "tmp": "0.2.3",
+    "xbytes": "1.9.1"
+  },
+  "overrides": {
+    "whatwg-url": "^14.0.0"
   }
 }