Merge branch 'master' into feat/issue-template

Author: rvlb

.circleci/config.yml

@@ -0,0 +1,29 @@
+version: 2.1
+
+jobs:
+  test:
+    parameters:
+      node-version:
+        type: string
+    docker:
+      - image: cimg/node:<< parameters.node-version >>
+    steps:
+      - checkout
+      - run: |
+          echo "Node version: $(node --version)"
+          echo "NPM version:  $(npm --version)"
+          npm install
+          npm run ci
+
+workflows:
+  all-tests:
+    jobs:
+      - test:
+          matrix:
+            parameters:
+              node-version:
+                # See https://nodejs.org/en/about/releases/
+                - "current"  # Right now: 16.5
+                - "lts"      # Right now: 14.17
+                - "12.22"  # Oldest maintenance LTS, End-of-Life 2022-04-30
+          name: test-on-node-<< matrix.node-version >>

.travis.yml

@@ -1,4 +1,5 @@
 # Webpack Bundle Tracker [![Join the chat at https://gitter.im/owais/webpack-bundle-tracker](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/owais/webpack-bundle-tracker?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+[![master build status](https://circleci.com/gh/django-webpack/webpack-bundle-tracker.svg?style=svg)](https://circleci.com/gh/django-webpack/webpack-bundle-tracker)
 
 Spits out some stats about webpack compilation process to a file.
 
@@ -10,6 +11,13 @@ Spits out some stats about webpack compilation process to a file.
 npm install --save-dev webpack-bundle-tracker
 ```
 
+<br>
+
+## Compatibility
+
+This project is compatible with NodeJS versions 12 and up.
+
+
 <br>
 
 ## Usage
@@ -173,10 +181,11 @@ passed to the `space` parameter in `JSON.stringify`. More information can be fou
 
 | Name              | Type        | Default                          | Description                                                                                                                     |
 | ----------------- | ----------- | -------------------------------- | ------------------------------------------------------------------------------------------------------------------------------- |
-| `path`            | `{String}`  | `'.'`                            | Output directory of bundle tracker JSON file .                                                                                  |
+| `path`            | `{String}`  | `'.'`                            | Output directory of bundle tracker JSON file.                                                                                   |
 | `filename`        | `{String}`  | `'webpack-stats.json'`           | Name of the bundle tracker JSON file.                                                                                           |
-| `publicPath`      | `{String}`  | `?`                              | Override `output.publicPath` from Webpack config.                                                                               |
-| `relativePath`    | `{Boolean}` | `?`                              | Show relative path instead of absolute path for bundles in JSON Tracker file. Path are relative from path of JSON Tracker file. |
+| `publicPath`      | `{String}`  | (ignored)                        | Override `output.publicPath` from Webpack config.                                                                               |
+| `relativePath`    | `{Boolean}` | `false`                          | Show relative path instead of absolute path for bundles in JSON Tracker file. Path are relative from path of JSON Tracker file. |
 | `logTime`         | `{Boolean}` | `false`                          | Output `startTime` and `endTime` properties in bundle tracker JSON file.                                                        |
 | `integrity`       | `{Boolean}` | `false`                          | Output `integrity` property for each asset entry.                                                                               |
 | `integrityHashes` | `{Array}`   | `['sha256', 'sha384', 'sha512']` | Cryptographic hash functions used to compute integrity for each asset.                                                          |
+| `indent`          | `{Integer}` | `undefined`                      | Format resulting JSON file for better readability.                                                                              |

README.md

@@ -1,6 +1,6 @@
 // @ts-check
 /** @typedef {import("lodash.defaults")} defaults */
-/** @typedef {import("lodash.merge")} merge */
+/** @typedef {import("lodash.assign")} assign */
 /** @typedef {import("lodash.get")} get */
 /** @typedef {import("webpack").Compiler} Compiler */
 /** @typedef {import("webpack").Stats} Stats */
@@ -15,7 +15,7 @@ const fs = require('fs');
 const crypto = require('crypto');
 
 const defaults = require('lodash.defaults');
-const merge = require('lodash.merge');
+const assign = require('lodash.assign');
 const get = require('lodash.get');
 const each = require('lodash.foreach');
 const stripAnsi = require('strip-ansi');
@@ -40,6 +40,7 @@ class BundleTrackerPlugin {
     /** @type {Contents} */
     this.contents = {
       status: 'initialization',
+      assets: {},
       chunks: {},
     };
     this.name = 'BundleTrackerPlugin';
@@ -61,6 +62,7 @@ class BundleTrackerPlugin {
       logTime: false,
       relativePath: false,
       integrity: false,
+      indent: 2,
       // https://www.w3.org/TR/SRI/#cryptographic-hash-functions
       integrityHashes: ['sha256', 'sha384', 'sha512'],
     });
@@ -77,10 +79,13 @@ class BundleTrackerPlugin {
    * Write bundle tracker stats file
    *
    * @param {Compiler} compiler
-   * @param {Contents} contents
+   * @param {Partial<Contents>} contents
    */
   _writeOutput(compiler, contents) {
-    merge(this.contents, contents);
+    assign(this.contents, contents, {
+      assets: assign(this.contents.assets, contents.assets),
+      chunks: assign(this.contents.chunks, contents.chunks),
+    });
 
     if (this.options.publicPath) {
       this.contents.publicPath = this.options.publicPath;
@@ -121,7 +126,13 @@ class BundleTrackerPlugin {
    */
   _handleDone(compiler, stats) {
     if (stats.hasErrors()) {
-      const error = stats.compilation.errors[0];
+      const findError = compilation => {
+        if (compilation.errors.length > 0) {
+          return compilation.errors[0];
+        }
+        return compilation.children.find(child => findError(child));
+      };
+      const error = findError(stats.compilation);
       this._writeOutput(compiler, {
         status: 'error',
         error: get(error, 'name', 'unknown-error'),
@@ -131,6 +142,7 @@ class BundleTrackerPlugin {
       return;
     }
 
+    /** @type {Contents} */
     const output = { status: 'done', assets: {}, chunks: {} };
     each(stats.compilation.assets, (file, assetName) => {
       const fileInfo = {

lib/index.js

@@ -1,6 +1,6 @@
 {
   "name": "webpack-bundle-tracker",
-  "version": "1.1.0",
+  "version": "1.4.0",
   "description": "Spits out some stats about webpack compilation process to a file",
   "keywords": [
     "bundle",
@@ -24,7 +24,7 @@
     "test-debug": "node --inspect-brk=0.0.0.0 node_modules/jest/bin/jest --runInBand --env node",
     "posttest": "tsc",
     "test-watch": "jest --runInBand --env node --watchAll",
-    "travis": "npm pretest && jest --runInBand --coverage --env node && npm posttest"
+    "ci": "npm run pretest && jest --runInBand --coverage --env node && npm run posttest"
   },
   "jest": {
     "setupFilesAfterEnv": [
@@ -36,16 +36,13 @@
     "lodash.defaults": "^4.2.0",
     "lodash.foreach": "^4.5.0",
     "lodash.get": "^4.4.2",
-    "lodash.merge": "^4.6.2",
     "strip-ansi": "^6.0.0"
   },
   "devDependencies": {
     "@types/lodash.assign": "^4.2.6",
+    "@types/lodash.defaults": "^4.2.6",
     "@types/lodash.foreach": "^4.5.6",
     "@types/lodash.get": "^4.4.6",
-    "@types/lodash.merge": "^4.6.6",
-    "@types/lodash.defaults": "^4.2.6",
-    "@types/mkdirp": "^1.0.1",
     "@types/node": "^13.13.52",
     "@types/webpack": "^4.41.28",
     "@typescript-eslint/eslint-plugin": "^2.34.0",

package.json

@@ -1,6 +1,7 @@
 /* eslint-env jest */
 'use strict';
 
+const fs = require('fs');
 const zlib = require('zlib');
 const path = require('path');
 const rimraf = require('rimraf');
@@ -635,4 +636,70 @@ describe('BundleTrackerPlugin bases tests', () => {
       expectWarnings,
     );
   });
+
+  it('correctly merges chunks after multiple runs', done => {
+    fs.writeFileSync(
+      path.join(OUTPUT_DIR, 'app1.js'),
+      `require(${JSON.stringify(path.resolve(__dirname, 'fixtures', 'commons.js'))});`,
+    );
+    const compiler = webpack(
+      {
+        context: __dirname,
+        entry: {
+          app1: path.join(OUTPUT_DIR, 'app1.js'),
+          app2: path.resolve(__dirname, 'fixtures', 'app2.js'),
+        },
+        output: {
+          path: path.join(OUTPUT_DIR, 'js'),
+          filename: 'js/[name].js',
+          publicPath: 'http://localhost:3000/assets/',
+        },
+        optimization: {
+          splitChunks: {
+            cacheGroups: {
+              vendors: {
+                name: 'vendors',
+                test: /[\\/]node_modules[\\/]/,
+                priority: -10,
+                chunks: 'initial',
+              },
+              commons: {
+                name: 'commons',
+                test: /[\\/]?commons/,
+                enforce: true,
+                priority: -20,
+                chunks: 'all',
+                reuseExistingChunk: true,
+              },
+              default: {
+                name: 'shared',
+                reuseExistingChunk: true,
+              },
+            },
+          },
+        },
+        plugins: [
+          new BundleTrackerPlugin({
+            path: OUTPUT_DIR,
+            relativePath: true,
+            includeParents: true,
+            filename: path.join(OUTPUT_DIR, 'webpack-stats.json'),
+          }),
+        ],
+      },
+      () => {
+        // Edit app1.js and rerun the compilation
+        fs.writeFileSync(path.join(OUTPUT_DIR, 'app1.js'), '');
+        compiler.run(() => {
+          const trackerStatsContent = fs.readFileSync(path.join(OUTPUT_DIR, 'webpack-stats.json'), 'utf8');
+          const trackerStats = JSON.parse(trackerStatsContent);
+          expect(trackerStats.chunks).toMatchObject({
+            app1: ['js/app1.js'],
+            app2: ['js/commons.js', 'js/app2.js'],
+          });
+          done();
+        });
+      },
+    );
+  });
 });

tests/base.test.js

@@ -1,6 +1,7 @@
 /* eslint-env jest */
 'use strict';
 
+const fs = require('fs');
 const zlib = require('zlib');
 const path = require('path');
 const rimraf = require('rimraf');
@@ -120,7 +121,6 @@ describe('BundleTrackerPlugin bases tests', () => {
         ],
       },
       {
-        status: 'done',
         publicPath: 'https://test.org/statics/',
         status: 'done',
         chunks: {
@@ -636,4 +636,70 @@ describe('BundleTrackerPlugin bases tests', () => {
       expectWarnings,
     );
   });
+
+  it('correctly merges chunks after multiple runs', done => {
+    fs.writeFileSync(
+      path.join(OUTPUT_DIR, 'app1.js'),
+      `require(${JSON.stringify(path.resolve(__dirname, 'fixtures', 'commons.js'))});`,
+    );
+    const compiler = webpack5(
+      {
+        context: __dirname,
+        entry: {
+          app1: path.join(OUTPUT_DIR, 'app1.js'),
+          app2: path.resolve(__dirname, 'fixtures', 'app2.js'),
+        },
+        output: {
+          path: path.join(OUTPUT_DIR, 'js'),
+          filename: 'js/[name].js',
+          publicPath: 'http://localhost:3000/assets/',
+        },
+        optimization: {
+          splitChunks: {
+            cacheGroups: {
+              vendors: {
+                name: 'vendors',
+                test: /[\\/]node_modules[\\/]/,
+                priority: -10,
+                chunks: 'initial',
+              },
+              commons: {
+                name: 'commons',
+                test: /[\\/]?commons/,
+                enforce: true,
+                priority: -20,
+                chunks: 'all',
+                reuseExistingChunk: true,
+              },
+              default: {
+                name: 'shared',
+                reuseExistingChunk: true,
+              },
+            },
+          },
+        },
+        plugins: [
+          new BundleTrackerPlugin({
+            path: OUTPUT_DIR,
+            relativePath: true,
+            includeParents: true,
+            filename: path.join(OUTPUT_DIR, 'webpack-stats.json'),
+          }),
+        ],
+      },
+      () => {
+        // Edit app1.js and rerun the compilation
+        fs.writeFileSync(path.join(OUTPUT_DIR, 'app1.js'), '');
+        compiler.run(() => {
+          const trackerStatsContent = fs.readFileSync(path.join(OUTPUT_DIR, 'webpack-stats.json'), 'utf8');
+          const trackerStats = JSON.parse(trackerStatsContent);
+          expect(trackerStats.chunks).toMatchObject({
+            app1: ['js/app1.js'],
+            app2: ['js/commons.js', 'js/app2.js'],
+          });
+          done();
+        });
+      },
+    );
+  });
 });

tests/webpack5.test.js

@@ -33,7 +33,7 @@ declare namespace BundleTrackerPlugin {
      */
     relativePath?: boolean;
     /**
-     * Indent JSON ouput file
+     * Indent JSON output file
      */
     indent?: number;
     /**
@@ -60,17 +60,28 @@ declare namespace BundleTrackerPlugin {
      * Error message when webpack has failure from compilation
      */
     message?: string;
+    /**
+     * File information
+     */
+    assets: {
+      [name: string]: {
+        name: string;
+        integrity?: string;
+        publicPath?: string;
+        path: string;
+      };
+    };
     /**
      * List of chunks builded
      */
-    chunks?: {
+    chunks: {
       [name: string]: [
         {
           name: string;
           publicPath?: string;
           path: string;
-        }
-      ]
+        },
+      ];
     };
     /**
      * Public path of chunks