README.md

Webpack Bundle Summary

This plugin generates a JSON file with the name and size of each webpack asset. Commit this file to source control so you can easily see how diffs impact bundle size.

Installation

Install with yarn or npm (you might want to save this in devDependencies instead of dependencies)

yarn add webpack-bundle-summary --dev

or

npm install webpack-bundle-summary --save-dev

Usage

const BundleSummary = require('webpack-bundle-summary')

// webpack config
plugins: [
  new BundleSummary(options)
]
//
//

Options

All are optiona

let options = {
  // the name of the file to output the bundle-summary to
  // default: 'bundle-summary.json'
  filename: //string,

  // a function to filter assetNames if you don't want all
  // assets to be output in the summary file
  // take an asset name and return a boolean
  // default: only .js files:
  //      (assetName)  => /\.js/.test(assetName)
  // set `filter: false` to keep all webpack assets
  filter: (assetName) => { }
}
// webpack config
plugins: [
  new BundleSummary(options)
]

Here is an example bundle-summary.json, generated from the webpack-sandbox project:

{
  "$total": 6991,
  "0.js": 218,
  "1.js": 134,
  "main.js": 6639
}