[![npm][npm]][npm-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![tests][tests]][tests-url]
[![downloads][downloads]][downloads-url]

src="https://webpack.js.org/assets/icon-square-big.svg">

Umi Webpack Bundle Analyzer

Visualize size of webpack output files with an interactive zoomable treemap.

Install

``bash


NPM

`js
const BundleAnalyzerPlugin = require('umi-webpack-bundle-analyzer').BundleAnalyzerPlugin;

module.exports = {
plugins: [
new BundleAnalyzerPlugin()
]
}
`

It will create an interactive treemap visualization of the contents of all your bundles.

!webpack bundle analyzer zoomable treemap

This module will help you:

1. Realize what's really inside your bundle
2. Find out what modules make up the most of its size
3. Find modules that got there by mistake
4. 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 sizes!

Options (for plugin)

`js
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.|
|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|Default: parsed. Module sizes to show in report by default. Size definitions section describes what these values mean.|
|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|
|generateReportFile|{Boolean}|Default: false. If true, bundle size report JSON file will be generated in bundle output directory|
|reportDepth|{Number}|Default: 1. If generateReportFile is true, will treeshaking bundle size report at node_modules' depth |
|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:

`bash
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.

`
umi-webpack-bundle-analyzer bundle/output/path/stats.json
`

Options (for CLI)

`bash
umi-webpack-bundle-analyzer [bundleDir] [options]
`

Arguments are documented below:

$3

Path to webpack stats JSON file

$3

Directory containing all generated bundles.

$3

`
-V, --version output the version number
-m, --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.
In json mode single JSON file with bundle report will be generated. (default: server)
-h, --host Host that will be used in server mode to start HTTP server. (default: 127.0.0.1)
-p, --port Port that will be used in server mode to start HTTP server. Should be a number or auto (default: 8888)
-r, --report Path to bundle report file that will be generated in static mode. (default: report.html)
-t, --title