webpack-bundle-analyzer 5.2.0 → 5.3.0

package/lib/tree/Folder.js

@@ -4,44 +4,77 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _Module = _interopRequireDefault(require("./Module"));
-var _BaseFolder = _interopRequireDefault(require("./BaseFolder"));
-var _ConcatenatedModule = _interopRequireDefault(require("./ConcatenatedModule"));
-var _utils = require("./utils");
-var _sizeUtils = require("../sizeUtils");
+var _sizeUtils = require("../sizeUtils.js");
+var _BaseFolder = _interopRequireDefault(require("./BaseFolder.js"));
+var _ConcatenatedModule = _interopRequireDefault(require("./ConcatenatedModule.js"));
+var _Module = _interopRequireDefault(require("./Module.js"));
+var _utils = require("./utils.js");
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/** @typedef {import("webpack").StatsModule} StatsModule */
+/** @typedef {import("../analyzer").AnalyzerOptions} AnalyzerOptions */
+/** @typedef {import("../analyzer").CompressionAlgorithm} CompressionAlgorithm */
+/** @typedef {import("./Module").SizeFields} SizeFields */
+/** @typedef {import("./BaseFolder").BaseFolderChartData} BaseFolderChartData */
+
+/**
+ * @typedef {object} OwnFolderChartData
+ * @property {number} parsedSize parsed size
+ * @property {number | undefined} gzipSize gzip size
+ * @property {number | undefined} brotliSize brotli size
+ * @property {number | undefined} zstdSize zstd size
+ */
+
+/** @typedef {BaseFolderChartData & OwnFolderChartData} FolderChartData */
+
 class Folder extends _BaseFolder.default {
+  /**
+   * @param {string} name name
+   * @param {AnalyzerOptions} opts options
+   */
   constructor(name, opts) {
     super(name);
+    /** @type {AnalyzerOptions} */
     this.opts = opts;
   }
   get parsedSize() {
     return this.src ? this.src.length : 0;
   }
   get gzipSize() {
-    return this.opts.compressionAlgorithm === 'gzip' ? this.getCompressedSize('gzip') : undefined;
+    return this.opts.compressionAlgorithm === "gzip" ? this.getCompressedSize("gzip") : undefined;
   }
   get brotliSize() {
-    return this.opts.compressionAlgorithm === 'brotli' ? this.getCompressedSize('brotli') : undefined;
+    return this.opts.compressionAlgorithm === "brotli" ? this.getCompressedSize("brotli") : undefined;
   }
   get zstdSize() {
-    return this.opts.compressionAlgorithm === 'zstd' ? this.getCompressedSize('zstd') : undefined;
+    return this.opts.compressionAlgorithm === "zstd" ? this.getCompressedSize("zstd") : undefined;
   }
+
+  /**
+   * @param {CompressionAlgorithm} compressionAlgorithm compression algorithm
+   * @returns {number | undefined} compressed size
+   */
   getCompressedSize(compressionAlgorithm) {
-    const key = `_${compressionAlgorithm}Size`;
-    if (!Object.prototype.hasOwnProperty.call(this, key)) {
+    const key = /** @type {`_${CompressionAlgorithm}Size`} */
+    `_${compressionAlgorithm}Size`;
+    if (!Object.hasOwn(this, key)) {
+      /** @type {Folder & SizeFields} */
       this[key] = this.src ? (0, _sizeUtils.getCompressedSize)(compressionAlgorithm, this.src) : 0;
     }
-    return this[key];
+    return /** @type {Folder & SizeFields} */this[key];
   }
+
+  /**
+   * @param {StatsModule} moduleData stats module
+   */
   addModule(moduleData) {
     const pathParts = (0, _utils.getModulePathParts)(moduleData);
     if (!pathParts) {
       return;
     }
     const [folders, fileName] = [pathParts.slice(0, -1), pathParts[pathParts.length - 1]];
+    /** @type {BaseFolder} */
     let currentFolder = this;
-    folders.forEach(folderName => {
+    for (const folderName of folders) {
       let childNode = currentFolder.getChild(folderName);
       if (
       // Folder is not created yet
@@ -54,11 +87,15 @@ class Folder extends _BaseFolder.default {
         childNode = currentFolder.addChildFolder(new Folder(folderName, this.opts));
       }
       currentFolder = childNode;
-    });
+    }
     const ModuleConstructor = moduleData.modules ? _ConcatenatedModule.default : _Module.default;
     const module = new ModuleConstructor(fileName, moduleData, this, this.opts);
     currentFolder.addChildModule(module);
   }
+
+  /**
+   * @returns {FolderChartData} chart data
+   */
   toChartData() {
     return {
       ...super.toChartData(),
@@ -69,5 +106,4 @@ class Folder extends _BaseFolder.default {
     };
   }
 }
-exports.default = Folder;
-;
+exports.default = Folder;

package/lib/tree/Module.js

@@ -4,13 +4,47 @@ Object.defineProperty(exports, "__esModule", {
   value: true
 });
 exports.default = void 0;
-var _Node = _interopRequireDefault(require("./Node"));
-var _sizeUtils = require("../sizeUtils");
+var _sizeUtils = require("../sizeUtils.js");
+var _Node = _interopRequireDefault(require("./Node.js"));
 function _interopRequireDefault(e) { return e && e.__esModule ? e : { default: e }; }
+/** @typedef {import("webpack").StatsModule} StatsModule */
+/** @typedef {import("../sizeUtils").Algorithm} CompressionAlgorithm */
+
+/** @typedef {{ compressionAlgorithm: CompressionAlgorithm }} ModuleOptions */
+
+/** @typedef {"parsedSize" | "gzipSize" | "brotliSize" | "zstdSize"} SizeType */
+
+/**
+ * @typedef {object} ModuleChartData
+ * @property {string | number | undefined} id id
+ * @property {string} label label
+ * @property {string} path path
+ * @property {number | undefined} statSize stat size
+ * @property {number | undefined} parsedSize parsed size
+ * @property {number | undefined} gzipSize gzip size
+ * @property {number | undefined} brotliSize brotli size
+ * @property {number | undefined} zstdSize zstd size
+ */
+
+/**
+ * @typedef {object} SizeFields
+ * @property {number=} _gzipSize gzip size
+ * @property {number=} _brotliSize brotli size
+ * @property {number=} _zstdSize zstd size
+ */
+
 class Module extends _Node.default {
+  /**
+   * @param {string} name name
+   * @param {StatsModule} data data
+   * @param {Node | undefined} parent parent
+   * @param {ModuleOptions} opts options
+   */
   constructor(name, data, parent, opts) {
     super(name, parent);
+    /** @type {StatsModule} */
     this.data = data;
+    /** @type {ModuleOptions} */
     this.opts = opts;
   }
   get src() {
@@ -18,12 +52,16 @@ class Module extends _Node.default {
   }
   set src(value) {
     this.data.parsedSrc = value;
-    delete this._gzipSize;
-    delete this._brotliSize;
-    delete this._zstdSize;
+    delete (/** @type {Module & SizeFields} */this._gzipSize);
+    delete (/** @type {Module & SizeFields} */this._brotliSize);
+    delete (/** @type {Module & SizeFields} */this._zstdSize);
   }
+
+  /**
+   * @returns {number} size
+   */
   get size() {
-    return this.data.size;
+    return /** @type {number} */this.data.size;
   }
   set size(value) {
     this.data.size = value;
@@ -44,29 +82,45 @@ class Module extends _Node.default {
     return this.src ? this.src.length : undefined;
   }
   getGzipSize() {
-    return this.opts.compressionAlgorithm === 'gzip' ? this.getCompressedSize('gzip') : undefined;
+    return this.opts.compressionAlgorithm === "gzip" ? this.getCompressedSize("gzip") : undefined;
   }
   getBrotliSize() {
-    return this.opts.compressionAlgorithm === 'brotli' ? this.getCompressedSize('brotli') : undefined;
+    return this.opts.compressionAlgorithm === "brotli" ? this.getCompressedSize("brotli") : undefined;
   }
   getZstdSize() {
-    return this.opts.compressionAlgorithm === 'zstd' ? this.getCompressedSize('zstd') : undefined;
+    return this.opts.compressionAlgorithm === "zstd" ? this.getCompressedSize("zstd") : undefined;
   }
+
+  /**
+   * @param {CompressionAlgorithm} compressionAlgorithm compression algorithm
+   * @returns {number | undefined} compressed size
+   */
   getCompressedSize(compressionAlgorithm) {
-    const key = `_${compressionAlgorithm}Size`;
+    const key = /** @type {`_${CompressionAlgorithm}Size`} */
+    `_${compressionAlgorithm}Size`;
     if (!(key in this)) {
+      /** @type {Module & SizeFields} */
       this[key] = this.src ? (0, _sizeUtils.getCompressedSize)(compressionAlgorithm, this.src) : undefined;
     }
-    return this[key];
+    return /** @type {Module & SizeFields} */this[key];
   }
+
+  /**
+   * @param {StatsModule} data data
+   */
   mergeData(data) {
     if (data.size) {
+      /** @type {number} */
       this.size += data.size;
     }
     if (data.parsedSrc) {
-      this.src = (this.src || '') + data.parsedSrc;
+      this.src = (this.src || "") + data.parsedSrc;
     }
   }
+
+  /**
+   * @returns {ModuleChartData} module chart data
+   */
   toChartData() {
     return {
       id: this.data.id,
@@ -80,5 +134,4 @@ class Module extends _Node.default {
     };
   }
 }
-exports.default = Module;
-;
+exports.default = Module;

package/lib/tree/Node.js

@@ -5,22 +5,29 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.default = void 0;
 class Node {
+  /**
+   * @param {string} name name
+   * @param {Node=} parent parent
+   */
   constructor(name, parent) {
+    /** @type {string} */
     this.name = name;
+    /** @type {Node | undefined} */
     this.parent = parent;
   }
   get path() {
+    /** @type {string[]} */
     const path = [];
+    /** @type {Node | undefined} */
     let node = this;
     while (node) {
       path.push(node.name);
       node = node.parent;
     }
-    return path.reverse().join('/');
+    return path.reverse().join("/");
   }
   get isRoot() {
     return !this.parent;
   }
 }
-exports.default = Node;
-;
+exports.default = Node;

package/lib/tree/utils.js

@@ -5,18 +5,28 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getModulePathParts = getModulePathParts;
 const MULTI_MODULE_REGEXP = /^multi /u;
+
+/** @typedef {import("webpack").StatsModule} StatsModule */
+
+/**
+ * @param {StatsModule} moduleData moduleData
+ * @returns {string[] | null} module path parts
+ */
 function getModulePathParts(moduleData) {
-  if (MULTI_MODULE_REGEXP.test(moduleData.identifier)) {
+  if (moduleData.identifier && MULTI_MODULE_REGEXP.test(moduleData.identifier)) {
     return [moduleData.identifier];
   }
-  const loaders = moduleData.name.split('!');
+  if (!moduleData.name) {
+    return null;
+  }
+  const loaders = moduleData.name.split("!");
   // Removing loaders from module path: they're joined by `!` and the last part is a raw module path
   const parsedPath = loaders[loaders.length - 1]
   // Splitting module path into parts
-  .split('/')
+  .split("/")
   // Removing first `.`
   .slice(1)
   // Replacing `~` with `node_modules`
-  .map(part => part === '~' ? 'node_modules' : part);
+  .map(part => part === "~" ? "node_modules" : part);
   return parsedPath.length ? parsedPath : null;
 }

package/lib/utils.js

@@ -1,21 +1,40 @@
 "use strict";
 
+/** @typedef {import("net").AddressInfo} AddressInfo */
+/** @typedef {import("webpack").StatsAsset} StatsAsset */
+
 const {
   inspect,
   types
-} = require('util');
-const opener = require('opener');
-const MONTHS = ['Jan', 'Feb', 'Mar', 'Apr', 'May', 'Jun', 'Jul', 'Aug', 'Sep', 'Oct', 'Nov', 'Dec'];
-exports.createAssetsFilter = createAssetsFilter;
+} = require("node:util");
+const opener = require("opener");
+
+/** @typedef {import("./BundleAnalyzerPlugin").ExcludeAssets} ExcludeAssets */
+/** @typedef {import("./BundleAnalyzerPlugin").AnalyzerUrl} AnalyzerUrl */
+/** @typedef {import("./Logger")} Logger */
+
+const MONTHS = ["Jan", "Feb", "Mar", "Apr", "May", "Jun", "Jul", "Aug", "Sep", "Oct", "Nov", "Dec"];
+
+/**
+ * @param {ExcludeAssets} excludePatterns exclude patterns
+ * @returns {(asset: string) => boolean} function to filter
+ */
 function createAssetsFilter(excludePatterns) {
+  /** @type {((asset: string) => void | boolean)[]} */
   const excludeFunctions = (Array.isArray(excludePatterns) ? excludePatterns : [excludePatterns]).filter(Boolean).map(pattern => {
-    if (typeof pattern === 'string') {
-      pattern = new RegExp(pattern, 'u');
+    if (typeof pattern === "string") {
+      pattern = new RegExp(pattern, "u");
     }
     if (types.isRegExp(pattern)) {
-      return asset => pattern.test(asset);
+      return (
+        /**
+         * @param {string} asset asset
+         * @returns {boolean} true when need to exclude, otherwise false
+         */
+        asset => pattern.test(asset)
+      );
     }
-    if (typeof pattern !== 'function') {
+    if (typeof pattern !== "function") {
       throw new TypeError(`Pattern should be either string, RegExp or a function, but "${inspect(pattern, {
         depth: 0
       })}" got.`);
@@ -24,16 +43,24 @@ function createAssetsFilter(excludePatterns) {
   });
   if (excludeFunctions.length) {
     return asset => excludeFunctions.every(fn => fn(asset) !== true);
-  } else {
-    return () => true;
   }
+  return () => true;
+}
+
+/** @type {AnalyzerUrl} */
+function defaultAnalyzerUrl(options) {
+  const {
+    listenHost,
+    boundAddress
+  } = options;
+  return `http://${listenHost}:${ /** @type {AddressInfo} */boundAddress.port}`;
 }
 
 /**
- * @desc get string of current time
- * format: dd/MMM HH:mm
- * */
-exports.defaultTitle = function () {
+ * get string of current time, format: dd/MMM HH:mm
+ * @returns {string} default title
+ */
+function defaultTitle() {
   const time = new Date();
   const year = time.getFullYear();
   const month = MONTHS[time.getMonth()];
@@ -41,23 +68,24 @@ exports.defaultTitle = function () {
   const hour = `0${time.getHours()}`.slice(-2);
   const minute = `0${time.getMinutes()}`.slice(-2);
   const currentTime = `${day} ${month} ${year} at ${hour}:${minute}`;
-  return `${process.env.npm_package_name || 'Webpack Bundle Analyzer'} [${currentTime}]`;
-};
-exports.defaultAnalyzerUrl = function (options) {
-  const {
-    listenHost,
-    boundAddress
-  } = options;
-  return `http://${listenHost}:${boundAddress.port}`;
-};
+  return `${process.env.npm_package_name || "Webpack Bundle Analyzer"} [${currentTime}]`;
+}
 
 /**
  * Calls opener on a URI, but silently try / catches it.
+ * @param {string} uri URI
+ * @param {Logger} logger logger
  */
-exports.open = function (uri, logger) {
+function open(uri, logger) {
   try {
     opener(uri);
   } catch (err) {
     logger.debug(`Opener failed to open "${uri}":\n${err}`);
   }
+}
+module.exports = {
+  createAssetsFilter,
+  defaultAnalyzerUrl,
+  defaultTitle,
+  open
 };