Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/robertknight/webpack-bundle-size-analyzer

A tool for finding out what contributes to the size of Webpack bundles
https://github.com/robertknight/webpack-bundle-size-analyzer

file-size webpack

Last synced: 22 days ago
JSON representation

A tool for finding out what contributes to the size of Webpack bundles

Awesome Lists containing this project

README 

        
Webpack Bundle Size Analyzer

============================



[![Build Status](https://travis-ci.org/robertknight/webpack-bundle-size-analyzer.svg?branch=master)](https://travis-ci.org/robertknight/webpack-bundle-size-analyzer)



A small utility to help you find out what is contributing

to the size of your [Webpack](http://webpack.github.io/) bundles.



Webpack has a JSON output mode which produces detailed machine-readable

information about everything that has been included in a generated bundle.



This output is produced by running `webpack --json`. This tool analyzes

the resulting JSON output and displays a tree of packages that were included

in the bundle, ordered by the size of all the used modules.



For further reading on reducing the size of Webpack bundles,

see their [optimization guide](http://webpack.github.io/docs/optimization.html)



## Usage



There are 2 ways to use this tool:



1. As a command line application

2. As a webpack plugin



### CLI Usage



Assuming you have the webpack CLI command [installed locally in your project](https://webpack.js.org/guides/installation#local-installation):



```sh

npm install -g webpack-bundle-size-analyzer

node_modules/.bin/webpack --json | webpack-bundle-size-analyzer

```



If you have webpack [installed globally](https://webpack.js.org/guides/installation#global-installation)

then the first part of this command will be just `webpack --json` instead.



When run on [react-testing](https://github.com/robertknight/react-testing) for example,

it produces this output, where `` refers to the size of the bundle's own code.



````

react: 641.95 kB (55.3%)

  : 641.95 kB (100%)

chai: 125.8 kB (10.8%)

  deep-eql: 7.51 kB (5.97%)

    type-detect: 2.72 kB (36.2%)

      : 2.72 kB (100%)

    : 4.79 kB (63.8%)

  assertion-error: 2.29 kB (1.82%)

    : 2.29 kB (100%)

  : 116 kB (92.2%)

flummox: 73.46 kB (6.33%)

  flux: 9.01 kB (12.3%)

    : 9.01 kB (100%)

  eventemitter3: 5.94 kB (8.08%)

    : 5.94 kB (100%)

  uniqueid: 947 B (1.26%)

    : 947 B (100%)

  object-assign: 484 B (0.643%)

    : 484 B (100%)

  : 57.12 kB (77.8%)

q: 58.84 kB (5.07%)

  : 58.84 kB (100%)

...

: 195.57 kB (16.9%)

````



### Plugin Usage



#### Description

When using the plugin version of this library, a file will be written to a

location of your choice (when you run your webpack build).  The file contents

will be a list of the packages in your bundle (sorted in descending order).

Each line will contain the name of a package, along with it's file size, and the

percentage of space it takes up in your bundle.



#### Plugin Installation

Install this library as a development dependency to your webpack project:

```sh

npm install --save-dev webpack-bundle-size-analyzer

```



Import your plugin at the top of your `webpack.config.js` file:



Old School:

```js

var WebpackBundleSizeAnalyzerPlugin = require('webpack-bundle-size-analyzer').WebpackBundleSizeAnalyzerPlugin;

```



New School:

```js

import { WebpackBundleSizeAnalyzerPlugin } from 'webpack-bundle-size-analyzer';

```



Now in your webpack's plugin section, start using this plugin:



```js

{

  {...topOfConfig}

  plugins: [

    new WebpackBundleSizeAnalyzerPlugin('./reports/plain-report.txt')

  ]

  {...bottomOfConfig}

}

```



#### Example Plugin Output



Using the above plugin configuration, the following file will be written:



`/reports/plain-report.txt`:

```text

marked: 27.53 KB (14.9%)

lru-cache: 6.29 KB (3.40%)

style-loader: 717 B (0.379%)

: 150.33 KB (81.3%)

```



### Important Note About Minified Code



If you minify/compress your code using the [approach recommended in the Webpack documentation](http://webpack.github.io/docs/optimization.html), which is to use the UglifyJS plugin, be aware that this tool will report the sizes of modules _before_ they are minified. This is because the statistics generated by `webpack --json` do not take account of plugins that operate on the bundle as a whole.



Knowing the sizes of dependencies before they are minified can still be useful to get an idea of how much different dependencies are responsible for size of your minified bundle, but be aware that it can be misleading. This is because some libraries compress better than others.



If instead you minify modules in your bundle individually using a loader (eg. [the UglifyJS loader](https://www.npmjs.com/package/uglify-loader)), the stats output by `webpack --json` _will_ show minified sizes. If you want to get a better idea of the sizes of different dependencies after they are minified, you can temporarily remove the UglifyJS plugin and replace it with [the UglifyJS loader](https://www.npmjs.com/package/uglify-loader) instead before running `webpack --json | webpack-bundle-size-analyzer`.



The reason that using a plugin, rather than a loader, is the recommended approach in Webpack is that compression is better if applied to the whole bundle rather than to individual source files one at a time.