github.com/webpack/webpack-bundle-analyzer @v5.3.0 sqlite
README
[![npm][npm]][npm-url] [![node][node]][node-url] [![tests][tests]][tests-url] [![downloads][downloads]][downloads-url]
Webpack Bundle Analyzer
Visualize size of webpack output files with an interactive zoomable treemap.
Install
# NPM
npm install --save-dev webpack-bundle-analyzer
# Yarn
yarn add -D webpack-bundle-analyzer
Usage (as a plugin)
const { BundleAnalyzerPlugin } = require("webpack-bundle-analyzer");
module.exports = {
plugins: [new BundleAnalyzerPlugin()],
};
It will create an interactive treemap visualization of the contents of all your bundles.
This module will help you:
- Realize what's really inside your bundle
- Find out what modules make up the most of its size
- Find modules that got there by mistake
- Optimize it!
And the best thing is it supports minified bundles! It parses them to get real size of bundled modules. And it also shows their gzipped, Brotli, or Zstandard sizes!
Options (for plugin)
new BundleAnalyzerPlugin(options?: object)
| Name | Type | Description |
|---|---|---|
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. If analyzerPort is auto, the operating system will assign an arbitrary unused port |
analyzerUrl |
{Function} called with { listenHost: string, listenHost: string, boundAddress: server.address}. server.address comes from Node.js |
Default: http://${listenHost}:${boundAddress.port}. The URL printed to console with server mode. |
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). |
reportTitle |
{String\|function} |
Default: function that returns pretty printed current date and time. Content of the HTML title element; or a function of the form () => string that provides the content. |
defaultSizes |
One of: stat, parsed, gzip, brotli |
Default: parsed. Module sizes to show in report by default. Size definitions section describes what these values mean. |
compressionAlgorithm |
One of: gzip, brotli, zstd |
Default: gzip. Compression type used to calculate the compressed module sizes. |
openAnalyzer |
{Boolean} |
Default: true. Automatically open report in default browser. |
generateStatsFile |
{Boolean} |
Default: false. If true, webpack stats JSON file will be generated in bundle output directory |
statsFilename |
{String} |
Default: stats.json. Name of webpack stats JSON file that will be generated if generateStatsFile is true. It can be either an absolute path or a path relative to a bundle output directory (which is output.path in webpack config). |
statsOptions |
null or {Object} |
Default: null. Options for stats.toJson() method. For example you can exclude sources of your modules from stats file with source: false option. See more options here. |
excludeAssets |
{null\|pattern\|pattern[]} where pattern equals to {String\|RegExp\|function} |
Default: null. Patterns that will be used to match against asset names to exclude them from the report. If pattern is a string it will be converted to RegExp via new RegExp(str). If pattern is a function it should have the following signature (assetName: string) => boolean and should return true to exclude matching asset. If multiple patterns are provided asset should match at least one of them to be excluded. |
logLevel |
One of: info, warn, error, silent |
Default: info. Used to control how much details the plugin outputs. |
Usage (as a CLI utility)
You can analyze an existing bundle if you have a webpack stats JSON file.
You can generate it using BundleAnalyzerPlugin with generateStatsFile option set to true or with this simple
command:
webpack --profile --json > stats.json
If you're on Windows and using PowerShell, you can generate the stats file with this command to avoid BOM issues:
webpack --profile --json | Out-file 'stats.json' -Encoding OEM
Then you can run the CLI tool.
webpack-bundle-analyzer bundle/output/path/stats.json
Options (for CLI)
webpack-bundle-analyzer <bundleStatsFile> [bundleDir] [options]
Arguments are documented below:
bundleStatsFile
Path to webpack stats JSON file
bundleDir
Directory containing all generated bundles.
options
``
-V, --version output the version number
-m, --mode <mode> Analyzer mode. Should beserver,staticorjson.
Inservermode analyzer will start HTTP server to show bundle report.
Instaticmode single HTML file with bundle report will be generated.
Injsonmode single JSON file with bundle report will be generated. (default: server)
-h, --host <host> Host that will be used inservermode to start HTTP server. (default: 127.0.0.1)
-p, --port <n> Port that will be used inservermode to start HTTP server. Should be a number orauto(default: 8888)
-r, --report <file> Path to bundle report file that will be generated instatic` mode. (default: report.html)
-t, --title String to use in title element of html report. (default: pretty printed current date)
-s, --default-sizes <type> Module sizes to show in treemap by default.
Possible values: stat, parsed, gzip, brotli, zstd (default: parsed)
--compression-algorithm <type> Compression algorithm that will be used to calculate the compressed module sizes.
Possible v</p>
Core symbols most depended-on inside this repo
nShape
Languages
Modules by API surface
Used by 82 indexed graphs manifest dependencies, hub-wide
Dependencies from manifests, versioned
For agents
$ claude mcp add webpack-bundle-analyzer \
-- python -m otcore.mcp_server <graph>