webpack-bundle-analyzer 3.6.1 → 3.7.0

package/CHANGELOG.md

@@ -14,6 +14,14 @@ _Note: Gaps between patch versions are faulty, broken or test releases._
 
 <!-- Add changelog entries for new changes under this section -->
 
+## 3.7.0
+
+ * **New Feature**
+   * Added JSON output option (`analyzerMode: "json"` in plugin, `--mode json` in CLI) ([#341](https://github.com/webpack-contrib/webpack-bundle-analyzer/pull/341) by [@Gongreg](https://github.com/Gongreg))
+
+ * **Improvement**
+   * Persist "Show content of concatenated modules" option ([#322](https://github.com/webpack-contrib/webpack-bundle-analyzer/pull/322) by [@lorenzos](https://github.com/lorenzos))
+
 ## 3.6.1
 
  * **Bug Fix**

package/README.md

@@ -56,7 +56,7 @@ new BundleAnalyzerPlugin(options?: object)
 
 |Name|Type|Description|
 |:--:|:--:|:----------|
-|**`analyzerMode`**|One of: `server`, `static`, `disabled`|Default: `server`. In `server` mode analyzer will start HTTP server to show bundle report. In `static` mode single HTML file with bundle report will be generated. In `disabled` mode you can use this plugin to just generate Webpack Stats JSON file by setting `generateStatsFile` to `true`. |
+|**`analyzerMode`**|One of: `server`, `static`, `json`, `disabled`|Default: `server`. In `server` mode analyzer will start HTTP server to show bundle report. In `static` mode single HTML file with bundle report will be generated. In `json` mode single JSON file with bundle report will be generated. In `disabled` mode you can use this plugin to just generate Webpack Stats JSON file by setting `generateStatsFile` to `true`. |
 |**`analyzerHost`**|`{String}`|Default: `127.0.0.1`. Host that will be used in `server` mode to start HTTP server.|
 |**`analyzerPort`**|`{Number}` or `auto`|Default: `8888`. Port that will be used in `server` mode to start HTTP server.|
 |**`reportFilename`**|`{String}`|Default: `report.html`. Path to bundle report file that will be generated in `static` mode. It can be either an absolute path or a path relative to a bundle output directory (which is output.path in webpack config).|
@@ -111,9 +111,10 @@ Directory containing all generated bundles.
 
 ```
   -V, --version               output the version number
-  -m, --mode <mode>           Analyzer mode. Should be `server` or `static`.
+  -m, --mode <mode>           Analyzer mode. Should be `server`, `static` or `json`.
                               In `server` mode analyzer will start HTTP server to show bundle report.
-                              In `static` mode single HTML file with bundle report will be generated. (default: server)
+                              In `static` mode single HTML file with bundle report will be generated.
+                              In `json` mode single JSON file with bundle report will be generated. (default: server)
   -h, --host <host>           Host that will be used in `server` mode to start HTTP server. (default: 127.0.0.1)
   -p, --port <n>              Port that will be used in `server` mode to start HTTP server. Should be a number or `auto` (default: 8888)
   -r, --report <file>         Path to bundle report file that will be generated in `static` mode. (default: report.html)

package/lib/BundleAnalyzerPlugin.js

@@ -29,7 +29,7 @@ class BundleAnalyzerPlugin {
     this.opts = _objectSpread({
       analyzerMode: 'server',
       analyzerHost: '127.0.0.1',
-      reportFilename: 'report.html',
+      reportFilename: null,
       defaultSizes: 'parsed',
       openAnalyzer: true,
       generateStatsFile: false,
@@ -67,6 +67,8 @@ class BundleAnalyzerPlugin {
         actions.push(() => this.startAnalyzerServer(stats.toJson()));
       } else if (this.opts.analyzerMode === 'static') {
         actions.push(() => this.generateStaticReport(stats.toJson()));
+      } else if (this.opts.analyzerMode === 'json') {
+        actions.push(() => this.generateJSONReport(stats.toJson()));
       }
 
       if (actions.length) {
@@ -135,21 +137,34 @@ class BundleAnalyzerPlugin {
     })();
   }
 
-  generateStaticReport(stats) {
+  generateJSONReport(stats) {
     var _this3 = this;
 
     return _asyncToGenerator(function* () {
-      yield viewer.generateReport(stats, {
-        openBrowser: _this3.opts.openAnalyzer,
-        reportFilename: path.resolve(_this3.compiler.outputPath, _this3.opts.reportFilename),
+      yield viewer.generateJSONReport(stats, {
+        reportFilename: path.resolve(_this3.compiler.outputPath, _this3.opts.reportFilename || 'report.json'),
         bundleDir: _this3.getBundleDirFromCompiler(),
         logger: _this3.logger,
-        defaultSizes: _this3.opts.defaultSizes,
         excludeAssets: _this3.opts.excludeAssets
       });
     })();
   }
 
+  generateStaticReport(stats) {
+    var _this4 = this;
+
+    return _asyncToGenerator(function* () {
+      yield viewer.generateReport(stats, {
+        openBrowser: _this4.opts.openAnalyzer,
+        reportFilename: path.resolve(_this4.compiler.outputPath, _this4.opts.reportFilename || 'report.html'),
+        bundleDir: _this4.getBundleDirFromCompiler(),
+        logger: _this4.logger,
+        defaultSizes: _this4.opts.defaultSizes,
+        excludeAssets: _this4.opts.excludeAssets
+      });
+    })();
+  }
+
   getBundleDirFromCompiler() {
     switch (this.compiler.outputFileSystem.constructor.name) {
       case 'MemoryFileSystem':

package/lib/bin/analyzer.js

@@ -28,9 +28,9 @@ const program = commander.version(require('../../package.json').version).usage(`
     bundleStatsFile  Path to Webpack Stats JSON file.
     bundleDir        Directory containing all generated bundles.
                      You should provided it if you want analyzer to show you the real parsed module sizes.
-                     By default a directory of stats file is used.`).option('-m, --mode <mode>', 'Analyzer mode. Should be `server` or `static`.' + br('In `server` mode analyzer will start HTTP server to show bundle report.') + br('In `static` mode single HTML file with bundle report will be generated.'), 'server').option( // Had to make `host` parameter optional in order to let `-h` flag output help message
+                     By default a directory of stats file is used.`).option('-m, --mode <mode>', 'Analyzer mode. Should be `server`,`static` or `json`.' + br('In `server` mode analyzer will start HTTP server to show bundle report.') + br('In `static` mode single HTML file with bundle report will be generated.') + br('In `json` mode single JSON file with bundle report will be generated.'), 'server').option( // Had to make `host` parameter optional in order to let `-h` flag output help message
 // Fixes https://github.com/webpack-contrib/webpack-bundle-analyzer/issues/239
-'-h, --host [host]', 'Host that will be used in `server` mode to start HTTP server.', '127.0.0.1').option('-p, --port <n>', 'Port that will be used in `server` mode to start HTTP server.', 8888).option('-r, --report <file>', 'Path to bundle report file that will be generated in `static` mode.', 'report.html').option('-s, --default-sizes <type>', 'Module sizes to show in treemap by default.' + br(`Possible values: ${[...SIZES].join(', ')}`), 'parsed').option('-O, --no-open', "Don't open report in default browser automatically.").option('-e, --exclude <regexp>', 'Assets that should be excluded from the report.' + br('Can be specified multiple times.'), array()).option('-l, --log-level <level>', 'Log level.' + br(`Possible values: ${[...Logger.levels].join(', ')}`), Logger.defaultLevel).parse(process.argv);
+'-h, --host [host]', 'Host that will be used in `server` mode to start HTTP server.', '127.0.0.1').option('-p, --port <n>', 'Port that will be used in `server` mode to start HTTP server.', 8888).option('-r, --report <file>', 'Path to bundle report file that will be generated in `static` mode.').option('-s, --default-sizes <type>', 'Module sizes to show in treemap by default.' + br(`Possible values: ${[...SIZES].join(', ')}`), 'parsed').option('-O, --no-open', "Don't open report in default browser automatically.").option('-e, --exclude <regexp>', 'Assets that should be excluded from the report.' + br('Can be specified multiple times.'), array()).option('-l, --log-level <level>', 'Log level.' + br(`Possible values: ${[...Logger.levels].join(', ')}`), Logger.defaultLevel).parse(process.argv);
 let {
   mode,
   host,
@@ -44,7 +44,10 @@ let {
 } = program;
 const logger = new Logger(logLevel);
 if (!bundleStatsFile) showHelp('Provide path to Webpack Stats file as first argument');
-if (mode !== 'server' && mode !== 'static') showHelp('Invalid mode. Should be either `server` or `static`.');
+
+if (mode !== 'server' && mode !== 'static' && mode !== 'json') {
+  showHelp('Invalid mode. Should be either `server`, `static` or `json`.');
+}
 
 if (mode === 'server') {
   if (!host) showHelp('Invalid host name');
@@ -75,15 +78,22 @@ if (mode === 'server') {
     excludeAssets,
     logger: new Logger(logLevel)
   });
-} else {
+} else if (mode === 'static') {
   viewer.generateReport(bundleStats, {
     openBrowser,
-    reportFilename: resolve(reportFilename),
+    reportFilename: resolve(reportFilename || 'report.html'),
     defaultSizes,
     bundleDir,
     excludeAssets,
     logger: new Logger(logLevel)
   });
+} else if (mode === 'json') {
+  viewer.generateJSONReport(bundleStats, {
+    reportFilename: resolve(reportFilename || 'report.json'),
+    bundleDir,
+    excludeAssets,
+    logger: new Logger(logLevel)
+  });
 }
 
 function showHelp(error) {

package/lib/viewer.js

@@ -37,6 +37,7 @@ const assetsRoot = path.join(projectRoot, 'public');
 module.exports = {
   startServer,
   generateReport,
+  generateJSONReport,
   // deprecated
   start: startServer
 };
@@ -138,7 +139,7 @@ function _generateReport() {
   _generateReport = _asyncToGenerator(function* (bundleStats, opts) {
     const {
       openBrowser = true,
-      reportFilename = 'report.html',
+      reportFilename,
       bundleDir = null,
       logger = new Logger(),
       defaultSizes = 'parsed',
@@ -186,6 +187,30 @@ function _generateReport() {
   return _generateReport.apply(this, arguments);
 }
 
+function generateJSONReport(_x5, _x6) {
+  return _generateJSONReport.apply(this, arguments);
+}
+
+function _generateJSONReport() {
+  _generateJSONReport = _asyncToGenerator(function* (bundleStats, opts) {
+    const {
+      reportFilename,
+      bundleDir = null,
+      logger = new Logger(),
+      excludeAssets = null
+    } = opts || {};
+    const chartData = getChartData({
+      logger,
+      excludeAssets
+    }, bundleStats, bundleDir);
+    if (!chartData) return;
+    mkdir.sync(path.dirname(reportFilename));
+    fs.writeFileSync(reportFilename, JSON.stringify(chartData));
+    logger.info(`${bold('Webpack Bundle Analyzer')} saved JSON report to ${bold(reportFilename)}`);
+  });
+  return _generateJSONReport.apply(this, arguments);
+}
+
 function getAssetContent(filename) {
   const assetPath = path.join(assetsRoot, filename);
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "webpack-bundle-analyzer",
-  "version": "3.6.1",
+  "version": "3.7.0",
   "description": "Webpack plugin and CLI utility that represents bundle content as convenient interactive zoomable treemap",
   "author": "Yury Grunin <grunin.ya@ya.ru>",
   "license": "MIT",