webpack-bundle-analyzer 5.1.1 → 5.3.0

package/lib/analyzer.js

@@ -1,74 +1,254 @@
 "use strict";
 
-const fs = require('fs');
-const path = require('path');
+const fs = require("node:fs");
+const path = require("node:path");
 const {
   parseChunked
-} = require('@discoveryjs/json-ext');
-const Logger = require('./Logger');
-const Folder = require('./tree/Folder').default;
+} = require("@discoveryjs/json-ext");
+const Logger = require("./Logger");
 const {
   parseBundle
-} = require('./parseUtils');
-const {
-  createAssetsFilter
-} = require('./utils');
+} = require("./parseUtils");
 const {
   getCompressedSize
-} = require('./sizeUtils');
+} = require("./sizeUtils");
+const Folder = require("./tree/Folder").default;
+const {
+  createAssetsFilter
+} = require("./utils");
 const FILENAME_QUERY_REGEXP = /\?.*$/u;
 const FILENAME_EXTENSIONS = /\.(js|mjs|cjs|bundle)$/iu;
-module.exports = {
-  getViewerData,
-  readStatsFromFile
-};
+
+/** @typedef {import("webpack").StatsCompilation} StatsCompilation */
+/** @typedef {import("webpack").StatsModule} StatsModule */
+/** @typedef {import("webpack").StatsAsset} StatsAsset */
+/** @typedef {import("./BundleAnalyzerPlugin").CompressionAlgorithm} CompressionAlgorithm */
+/** @typedef {import("./BundleAnalyzerPlugin").ExcludeAssets} ExcludeAssets */
+
+/**
+ * @typedef {object} AnalyzerOptions
+ * @property {"gzip" | "brotli" | "zstd"} compressionAlgorithm compression algorithm
+ */
+
+/**
+ * @param {StatsModule[]} modules modules
+ * @param {AnalyzerOptions} options options
+ * @returns {Folder} a folder class
+ */
+function createModulesTree(modules, options) {
+  const root = new Folder(".", options);
+  for (const module of modules) {
+    root.addModule(module);
+  }
+  root.mergeNestedFolders();
+  return root;
+}
+
+/**
+ * arr-flatten <https://github.com/jonschlinkert/arr-flatten>
+ *
+ * Copyright (c) 2014-2017, Jon Schlinkert.
+ * Released under the MIT License.
+ *
+ * Modified by Sukka <https://skk.moe>
+ *
+ * Replace recursively flatten with one-level deep flatten to match lodash.flatten
+ *
+ * TODO: replace with Array.prototype.flat once Node.js 10 support is dropped
+ */
+/**
+ * Flattens an array by one level.
+ * @template T
+ * @param {(T | T[])[]} arr the array to flatten
+ * @returns {T[]} a new array containing the flattened elements
+ */
+function flatten(arr) {
+  if (!arr) return [];
+  const len = arr.length;
+  if (!len) return [];
+  let cur;
+  const res = [];
+  for (let i = 0; i < len; i++) {
+    cur = arr[i];
+    if (Array.isArray(cur)) {
+      res.push(...cur);
+    } else {
+      res.push(cur);
+    }
+  }
+  return res;
+}
+
+/**
+ * @param {StatsCompilation} bundleStats bundle stats
+ * @param {string} assetName asset name
+ * @returns {boolean} child asset bundlers
+ */
+function getChildAssetBundles(bundleStats, assetName) {
+  return flatten((bundleStats.children || (/** @type {StatsCompilation} */[])).find(
+  /**
+   * @param {StatsCompilation} child child stats
+   * @returns {string[][]} assets by chunk name
+   */
+  child => Object.values(child.assetsByChunkName || []))).includes(assetName);
+}
+
+/**
+ * @param {StatsAsset} statsAsset stats asset
+ * @param {StatsModule} statsModule stats modules
+ * @returns {boolean} true when asset has a module
+ */
+function assetHasModule(statsAsset, statsModule) {
+  // Checking if this module is the part of asset chunks
+  return (statsModule.chunks || []).some(moduleChunk => statsAsset.chunks && statsAsset.chunks.includes(moduleChunk));
+}
+
+/**
+ * @param {StatsModule} statsModule stats Module
+ * @returns {boolean} true when runtime modules, otherwise false
+ */
+function isRuntimeModule(statsModule) {
+  return statsModule.moduleType === "runtime";
+}
+
+/**
+ * @param {StatsCompilation} bundleStats bundle stats
+ * @returns {StatsModule[]} modules
+ */
+function getBundleModules(bundleStats) {
+  /** @type {Set<string | number>} */
+  const seenIds = new Set();
+  const modules = /** @type {StatsModule[]} */[...(bundleStats.chunks?.map(chunk => chunk.modules) || []), ...(bundleStats.modules || [])].filter(Boolean);
+  return flatten(modules).filter(mod => {
+    // Filtering out Webpack's runtime modules as they don't have ids and can't be parsed (introduced in Webpack 5)
+    if (isRuntimeModule(mod)) {
+      return false;
+    }
+    if (seenIds.has(mod.id)) {
+      return false;
+    }
+    seenIds.add(mod.id);
+    return true;
+  });
+}
+
+/** @typedef {Record<string, Record<string, boolean>>} ChunkToInitialByEntrypoint */
+
+/**
+ * @param {StatsCompilation} bundleStats bundle stats
+ * @returns {ChunkToInitialByEntrypoint} chunk to initial by entrypoint
+ */
+function getChunkToInitialByEntrypoint(bundleStats) {
+  if (bundleStats === null || bundleStats === undefined) {
+    return {};
+  }
+  /** @type {ChunkToInitialByEntrypoint} */
+  const chunkToEntrypointInititalMap = {};
+  for (const entrypoint of Object.values(bundleStats.entrypoints || {})) {
+    for (const asset of entrypoint.assets || []) {
+      chunkToEntrypointInititalMap[asset.name] ??= {};
+      chunkToEntrypointInititalMap[asset.name][(/** @type {string} */
+      entrypoint.name)] = true;
+    }
+  }
+  return chunkToEntrypointInititalMap;
+}
+
+/**
+ * @param {StatsModule} statsModule stats modules
+ * @returns {boolean} true when entry module, otherwise false
+ */
+function isEntryModule(statsModule) {
+  return statsModule.depth === 0;
+}
+
+/**
+ * @typedef {object} ViewerDataOptions
+ * @property {Logger} logger logger
+ * @property {CompressionAlgorithm} compressionAlgorithm compression algorithm
+ * @property {ExcludeAssets} excludeAssets exclude assets
+ */
+
+/** @typedef {import("./tree/Module").ModuleChartData} ModuleChartData */
+/** @typedef {import("./tree/ContentModule").ContentModuleChartData} ContentModuleChartData */
+/** @typedef {import("./tree/ConcatenatedModule").ConcatenatedModuleChartData} ConcatenatedModuleChartData */
+/** @typedef {import("./tree/ContentFolder").ContentFolderChartData} ContentFolderChartData */
+/** @typedef {import("./tree/Folder").FolderChartData} FolderChartData */
+
+/**
+ * @typedef {object} ChartDataItem
+ * @property {string} label label
+ * @property {true} isAsset true when is asset, otherwise false
+ * @property {number} statSize stat size
+ * @property {number | undefined} parsedSize stat size
+ * @property {number | undefined} gzipSize gzip size
+ * @property {number | undefined} brotliSize brotli size
+ * @property {number | undefined} zstdSize zstd size
+ * @property {(ModuleChartData | ContentModuleChartData | ConcatenatedModuleChartData | ContentFolderChartData | FolderChartData)[]} groups groups
+ * @property {Record<string, boolean>} isInitialByEntrypoint record with initial entrypoints
+ */
+
+/**
+ * @typedef {ChartDataItem[]} ChartData
+ */
+
+/**
+ * @param {StatsCompilation} bundleStats bundle stats
+ * @param {string | null} bundleDir bundle dir
+ * @param {ViewerDataOptions=} opts options
+ * @returns {ChartData} chart data
+ */
 function getViewerData(bundleStats, bundleDir, opts) {
   const {
     logger = new Logger(),
-    compressionAlgorithm,
+    compressionAlgorithm = "gzip",
     excludeAssets = null
   } = opts || {};
   const isAssetIncluded = createAssetsFilter(excludeAssets);
 
   // Sometimes all the information is located in `children` array (e.g. problem in #10)
-  if ((bundleStats.assets == null || bundleStats.assets.length === 0) && bundleStats.children && bundleStats.children.length > 0) {
+  if ((bundleStats.assets === null || bundleStats.assets === undefined || bundleStats.assets.length === 0) && bundleStats.children && bundleStats.children.length > 0) {
     const {
       children
     } = bundleStats;
-    bundleStats = bundleStats.children[0];
+    [bundleStats] = bundleStats.children;
     // Sometimes if there are additional child chunks produced add them as child assets,
     // leave the 1st one as that is considered the 'root' asset.
     for (let i = 1; i < children.length; i++) {
-      children[i].assets.forEach(asset => {
+      for (const asset of children[i].assets || []) {
         asset.isChild = true;
+        /** @type {StatsAsset[]} */
         bundleStats.assets.push(asset);
-      });
+      }
     }
   } else if (bundleStats.children && bundleStats.children.length > 0) {
     // Sometimes if there are additional child chunks produced add them as child assets
-    bundleStats.children.forEach(child => {
-      child.assets.forEach(asset => {
+    for (const child of bundleStats.children) {
+      for (const asset of child.assets || []) {
         asset.isChild = true;
+        /** @type {StatsAsset[]} */
         bundleStats.assets.push(asset);
-      });
-    });
+      }
+    }
   }
 
   // Picking only `*.js, *.cjs or *.mjs` assets from bundle that has non-empty `chunks` array
   bundleStats.assets = (bundleStats.assets || []).filter(asset => {
     // Filter out non 'asset' type asset if type is provided (Webpack 5 add a type to indicate asset types)
-    if (asset.type && asset.type !== 'asset') {
+    if (asset.type && asset.type !== "asset") {
       return false;
     }
 
     // Removing query part from filename (yes, somebody uses it for some reason and Webpack supports it)
     // See #22
-    asset.name = asset.name.replace(FILENAME_QUERY_REGEXP, '');
-    return FILENAME_EXTENSIONS.test(asset.name) && asset.chunks.length > 0 && isAssetIncluded(asset.name);
+    asset.name = asset.name.replace(FILENAME_QUERY_REGEXP, "");
+    return FILENAME_EXTENSIONS.test(asset.name) && asset.chunks && asset.chunks.length > 0 && isAssetIncluded(asset.name);
   });
 
   // Trying to parse bundle assets and get real module sizes if `bundleDir` is provided
+  /** @type {Record<string, { src: string, runtimeSrc: string }> | null} */
   let bundlesSources = null;
+  /** @type {Record<string | number, boolean> | null} */
   let parsedModules = null;
   if (bundleDir) {
     bundlesSources = {};
@@ -78,10 +258,10 @@ function getViewerData(bundleStats, bundleDir, opts) {
       let bundleInfo;
       try {
         bundleInfo = parseBundle(assetFile, {
-          sourceType: statAsset.info.javascriptModule ? 'module' : 'script'
+          sourceType: statAsset.info.javascriptModule ? "module" : "script"
         });
       } catch (err) {
-        const msg = err.code === 'ENOENT' ? 'no such file' : err.message;
+        const msg = /** @type {NodeJS.ErrnoException} */err.code === "ENOENT" ? "no such file" : /** @type {Error} */err.message;
         logger.warn(`Error parsing bundle asset "${assetFile}": ${msg}`, {
           cause: err
         });
@@ -96,34 +276,49 @@ function getViewerData(bundleStats, bundleDir, opts) {
     if (Object.keys(bundlesSources).length === 0) {
       bundlesSources = null;
       parsedModules = null;
-      logger.warn('\nNo bundles were parsed. Analyzer will show only original module sizes from stats file.\n');
+      logger.warn("\nNo bundles were parsed. Analyzer will show only original module sizes from stats file.\n");
     }
   }
+
+  /** @typedef {{ size: number, parsedSize?: number, gzipSize?: number, brotliSize?: number, zstdSize?: number, modules: StatsModule[], tree: Folder }} Asset */
+
   const assets = bundleStats.assets.reduce((result, statAsset) => {
     // If asset is a childAsset, then calculate appropriate bundle modules by looking through stats.children
     const assetBundles = statAsset.isChild ? getChildAssetBundles(bundleStats, statAsset.name) : bundleStats;
-    const modules = assetBundles ? getBundleModules(assetBundles) : [];
-    const asset = result[statAsset.name] = {
+    /** @type {StatsModule[]} */
+    const modules = assetBundles ?
+    // @ts-expect-error TODO looks like we have a bug with child compilation parsing, need to add test cases
+    getBundleModules(assetBundles) : [];
+    const asset = result[statAsset.name] = /** @type {Asset} */{
       size: statAsset.size
     };
-    const assetSources = bundlesSources && Object.prototype.hasOwnProperty.call(bundlesSources, statAsset.name) ? bundlesSources[statAsset.name] : null;
+    const assetSources = bundlesSources && Object.hasOwn(bundlesSources, statAsset.name) ? bundlesSources[statAsset.name] : null;
     if (assetSources) {
       asset.parsedSize = Buffer.byteLength(assetSources.src);
-      if (compressionAlgorithm === 'gzip') asset.gzipSize = getCompressedSize('gzip', assetSources.src);
-      if (compressionAlgorithm === 'brotli') asset.brotliSize = getCompressedSize('brotli', assetSources.src);
+      if (compressionAlgorithm === "gzip") {
+        asset.gzipSize = getCompressedSize("gzip", assetSources.src);
+      }
+      if (compressionAlgorithm === "brotli") {
+        asset.brotliSize = getCompressedSize("brotli", assetSources.src);
+      }
+      if (compressionAlgorithm === "zstd") {
+        asset.zstdSize = getCompressedSize("zstd", assetSources.src);
+      }
     }
 
     // Picking modules from current bundle script
+    /** @type {StatsModule[]} */
     let assetModules = (modules || []).filter(statModule => assetHasModule(statAsset, statModule));
 
     // Adding parsed sources
     if (parsedModules) {
+      /** @type {StatsModule[]} */
       const unparsedEntryModules = [];
-      for (const statModule of assetModules) {
-        if (parsedModules[statModule.id]) {
-          statModule.parsedSrc = parsedModules[statModule.id];
-        } else if (isEntryModule(statModule)) {
-          unparsedEntryModules.push(statModule);
+      for (const statsModule of assetModules) {
+        if (typeof statsModule.id !== "undefined" && parsedModules[statsModule.id]) {
+          statsModule.parsedSrc = parsedModules[statsModule.id];
+        } else if (isEntryModule(statsModule)) {
+          unparsedEntryModules.push(statsModule);
         }
       }
 
@@ -139,10 +334,10 @@ function getViewerData(bundleStats, bundleDir, opts) {
           // If there are multiple entry points we move all of them under synthetic concatenated module.
           assetModules = (assetModules || []).filter(mod => !unparsedEntryModules.includes(mod));
           assetModules.unshift({
-            identifier: './entry modules',
-            name: './entry modules',
+            identifier: "./entry modules",
+            name: "./entry modules",
             modules: unparsedEntryModules,
-            size: unparsedEntryModules.reduce((totalSize, module) => totalSize + module.size, 0),
+            size: unparsedEntryModules.reduce((totalSize, module) => totalSize + (/** @type {number} */module.size), 0),
             parsedSrc: assetSources.runtimeSrc
           });
         }
@@ -153,7 +348,7 @@ function getViewerData(bundleStats, bundleDir, opts) {
       compressionAlgorithm
     });
     return result;
-  }, {});
+  }, /** @type {Record<string, Asset>} */{});
   const chunkToInitialByEntrypoint = getChunkToInitialByEntrypoint(bundleStats);
   return Object.entries(assets).map(([filename, asset]) => ({
     label: filename,
@@ -166,88 +361,22 @@ function getViewerData(bundleStats, bundleDir, opts) {
     parsedSize: asset.parsedSize,
     gzipSize: asset.gzipSize,
     brotliSize: asset.brotliSize,
+    zstdSize: asset.zstdSize,
     groups: Object.values(asset.tree.children).map(i => i.toChartData()),
     isInitialByEntrypoint: chunkToInitialByEntrypoint[filename] ?? {}
   }));
 }
+
+/**
+ * @param {string} filename filename
+ * @returns {Promise<StatsCompilation>} result
+ */
 function readStatsFromFile(filename) {
   return parseChunked(fs.createReadStream(filename, {
-    encoding: 'utf8'
+    encoding: "utf8"
   }));
 }
-function getChildAssetBundles(bundleStats, assetName) {
-  return flatten((bundleStats.children || []).find(c => Object.values(c.assetsByChunkName))).includes(assetName);
-}
-function getBundleModules(bundleStats) {
-  const seenIds = new Set();
-  return flatten((bundleStats.chunks?.map(chunk => chunk.modules) || []).concat(bundleStats.modules).filter(Boolean)).filter(mod => {
-    // Filtering out Webpack's runtime modules as they don't have ids and can't be parsed (introduced in Webpack 5)
-    if (isRuntimeModule(mod)) {
-      return false;
-    }
-    if (seenIds.has(mod.id)) {
-      return false;
-    }
-    seenIds.add(mod.id);
-    return true;
-  });
-}
-function assetHasModule(statAsset, statModule) {
-  // Checking if this module is the part of asset chunks
-  return (statModule.chunks || []).some(moduleChunk => statAsset.chunks.includes(moduleChunk));
-}
-function isEntryModule(statModule) {
-  return statModule.depth === 0;
-}
-function isRuntimeModule(statModule) {
-  return statModule.moduleType === 'runtime';
-}
-function createModulesTree(modules, opts) {
-  const root = new Folder('.', opts);
-  modules.forEach(module => root.addModule(module));
-  root.mergeNestedFolders();
-  return root;
-}
-function getChunkToInitialByEntrypoint(bundleStats) {
-  if (bundleStats == null) {
-    return {};
-  }
-  const chunkToEntrypointInititalMap = {};
-  Object.values(bundleStats.entrypoints || {}).forEach(entrypoint => {
-    for (const asset of entrypoint.assets) {
-      chunkToEntrypointInititalMap[asset.name] = chunkToEntrypointInititalMap[asset.name] ?? {};
-      chunkToEntrypointInititalMap[asset.name][entrypoint.name] = true;
-    }
-  });
-  return chunkToEntrypointInititalMap;
-}
-;
-
-/**
- * arr-flatten <https://github.com/jonschlinkert/arr-flatten>
- *
- * Copyright (c) 2014-2017, Jon Schlinkert.
- * Released under the MIT License.
- *
- * Modified by Sukka <https://skk.moe>
- *
- * Replace recursively flatten with one-level deep flatten to match lodash.flatten
- *
- * TODO: replace with Array.prototype.flat once Node.js 10 support is dropped
- */
-function flatten(arr) {
-  if (!arr) return [];
-  const len = arr.length;
-  if (!len) return [];
-  let cur;
-  const res = [];
-  for (let i = 0; i < len; i++) {
-    cur = arr[i];
-    if (Array.isArray(cur)) {
-      res.push(...cur);
-    } else {
-      res.push(cur);
-    }
-  }
-  return res;
-}
+module.exports = {
+  getViewerData,
+  readStatsFromFile
+};

package/lib/bin/analyzer.js

@@ -2,30 +2,49 @@
 "use strict";
 
 const {
-  resolve,
-  dirname
-} = require('path');
-const commander = require('commander');
+  dirname,
+  resolve
+} = require("node:path");
+const {
+  program: commanderProgram
+} = require("commander");
 const {
   magenta
-} = require('picocolors');
-const analyzer = require('../analyzer');
-const viewer = require('../viewer');
-const Logger = require('../Logger');
-const utils = require('../utils');
-const SIZES = new Set(['stat', 'parsed', 'gzip']);
-const COMPRESSION_ALGORITHMS = new Set(['gzip', 'brotli']);
-const program = commander.version(require('../../package.json').version).usage(`<bundleStatsFile> [bundleDir] [options]
+} = require("picocolors");
+const Logger = require("../Logger");
+const analyzer = require("../analyzer");
+const {
+  isZstdSupported
+} = require("../sizeUtils");
+const utils = require("../utils");
+const viewer = require("../viewer");
+const SIZES = new Set(["stat", "parsed", "gzip"]);
+const COMPRESSION_ALGORITHMS = new Set(isZstdSupported ? ["gzip", "brotli", "zstd"] : ["gzip", "brotli"]);
 
-  Arguments:
+/**
+ * @param {string} str string
+ * @returns {string} break with string
+ */
+function br(str) {
+  return `\n${" ".repeat(32)}${str}`;
+}
 
-    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`,`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(
+/**
+ * @template T
+ * @returns {(val: T) => T[]} array
+ */
+function array() {
+  /** @type {T[]} */
+  const arr = [];
+  return val => {
+    arr.push(val);
+    return arr;
+  };
+}
+const program = commanderProgram.version(require("../../package.json").version).argument("<bundleStatsFile>", "Path to Webpack Stats JSON file.").argument("[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\`,\`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/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.').option('-t, --title <title>', 'String to use in title element of html report.').option('-s, --default-sizes <type>', 'Module sizes to show in treemap by default.' + br(`Possible values: ${[...SIZES].join(', ')}`), 'parsed').option('--compression-algorithm <type>', 'Compression algorithm that will be used to calculate the compressed module sizes.' + br(`Possible values: ${[...COMPRESSION_ALGORITHMS].join(', ')}`), 'gzip').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("-t, --title <title>", "String to use in title element of html report.").option("-s, --default-sizes <type>", `Module sizes to show in treemap by default.${br(`Possible values: ${[...SIZES].join(", ")}`)}`, "parsed").option("--compression-algorithm <type>", `Compression algorithm that will be used to calculate the compressed module sizes.${br(`Possible values: ${[...COMPRESSION_ALGORITHMS].join(", ")}`)}`, "gzip").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();
 let [bundleStatsFile, bundleDir] = program.args;
 let {
   mode,
@@ -40,29 +59,48 @@ let {
   exclude: excludeAssets
 } = program.opts();
 const logger = new Logger(logLevel);
-if (typeof reportTitle === 'undefined') {
+if (typeof reportTitle === "undefined") {
   reportTitle = utils.defaultTitle;
 }
-if (!bundleStatsFile) showHelp('Provide path to Webpack Stats file as first argument');
-if (mode !== 'server' && mode !== 'static' && mode !== 'json') {
-  showHelp('Invalid mode. Should be either `server`, `static` or `json`.');
+
+/**
+ * @param {string} error error message
+ */
+function showHelp(error) {
+  if (error) console.log(`\n  ${magenta(error)}\n`);
+  program.outputHelp();
+  process.exit(1);
+}
+if (!bundleStatsFile) {
+  showHelp("Provide path to Webpack Stats file as first argument");
 }
-if (mode === 'server') {
-  if (!host) showHelp('Invalid host name');
-  port = port === 'auto' ? 0 : Number(port);
-  if (isNaN(port)) showHelp('Invalid port. Should be a number or `auto`');
+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");
+  port = port === "auto" ? 0 : Number(port);
+  if (Number.isNaN(port)) {
+    showHelp("Invalid port. Should be a number or `auto`");
+  }
 }
 if (!COMPRESSION_ALGORITHMS.has(compressionAlgorithm)) {
-  showHelp(`Invalid compression algorithm option. Possible values are: ${[...COMPRESSION_ALGORITHMS].join(', ')}`);
+  showHelp(`Invalid compression algorithm option. Possible values are: ${[...COMPRESSION_ALGORITHMS].join(", ")}`);
+}
+if (!SIZES.has(defaultSizes)) {
+  showHelp(`Invalid default sizes option. Possible values are: ${[...SIZES].join(", ")}`);
 }
-if (!SIZES.has(defaultSizes)) showHelp(`Invalid default sizes option. Possible values are: ${[...SIZES].join(', ')}`);
 bundleStatsFile = resolve(bundleStatsFile);
 if (!bundleDir) bundleDir = dirname(bundleStatsFile);
-parseAndAnalyse(bundleStatsFile);
+
+/**
+ * @param {string} bundleStatsFile bundle stats file
+ * @returns {Promise<void>}
+ */
 async function parseAndAnalyse(bundleStatsFile) {
   try {
     const bundleStats = await analyzer.readStatsFromFile(bundleStatsFile);
-    if (mode === 'server') {
+    if (mode === "server") {
       viewer.startServer(bundleStats, {
         openBrowser,
         port,
@@ -75,10 +113,10 @@ async function parseAndAnalyse(bundleStatsFile) {
         logger: new Logger(logLevel),
         analyzerUrl: utils.defaultAnalyzerUrl
       });
-    } else if (mode === 'static') {
+    } else if (mode === "static") {
       viewer.generateReport(bundleStats, {
         openBrowser,
-        reportFilename: resolve(reportFilename || 'report.html'),
+        reportFilename: resolve(reportFilename || "report.html"),
         reportTitle,
         defaultSizes,
         compressionAlgorithm,
@@ -86,9 +124,9 @@ async function parseAndAnalyse(bundleStatsFile) {
         excludeAssets,
         logger: new Logger(logLevel)
       });
-    } else if (mode === 'json') {
+    } else if (mode === "json") {
       viewer.generateJSONReport(bundleStats, {
-        reportFilename: resolve(reportFilename || 'report.json'),
+        reportFilename: resolve(reportFilename || "report.json"),
         compressionAlgorithm,
         bundleDir,
         excludeAssets,
@@ -97,22 +135,8 @@ async function parseAndAnalyse(bundleStatsFile) {
     }
   } catch (err) {
     logger.error(`Couldn't read webpack bundle stats from "${bundleStatsFile}":\n${err}`);
-    logger.debug(err.stack);
+    logger.debug(/** @type {Error} */err.stack);
     process.exit(1);
   }
 }
-function showHelp(error) {
-  if (error) console.log(`\n  ${magenta(error)}\n`);
-  program.outputHelp();
-  process.exit(1);
-}
-function br(str) {
-  return `\n${' '.repeat(32)}${str}`;
-}
-function array() {
-  const arr = [];
-  return val => {
-    arr.push(val);
-    return arr;
-  };
-}
+parseAndAnalyse(bundleStatsFile);

package/lib/index.js

@@ -2,8 +2,8 @@
 
 const {
   start
-} = require('./viewer');
+} = require("./viewer");
 module.exports = {
   start,
-  BundleAnalyzerPlugin: require('./BundleAnalyzerPlugin')
+  BundleAnalyzerPlugin: require("./BundleAnalyzerPlugin")
 };