https://github.com/webpackmonitor/webpackmonitor

A tool for monitoring webpack optimization metrics through the development process
https://github.com/webpackmonitor/webpackmonitor

analyzer monitoring optimization plugin webpack

Last synced: 3 days ago
JSON representation

A tool for monitoring webpack optimization metrics through the development process

• Host: GitHub
• URL: https://github.com/webpackmonitor/webpackmonitor
• Owner: webpackmonitor
• License: mit
• Created: 2017-09-14T18:33:02.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-10-14T19:51:52.000Z (over 5 years ago)
• Last Synced: 2025-01-16T23:00:14.363Z (10 days ago)
• Topics: analyzer, monitoring, optimization, plugin, webpack
• Language: JavaScript
• Homepage: http://webpackmonitor.com
• Size: 3.07 MB
• Stars: 2,414
• Watchers: 41
• Forks: 107
• Open Issues: 37
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-github-star - webpackmonitor
• awesome-list - webpackmonitor
• awesome-bundle-size - Webpack Monitor - A tool for monitoring webpack optimization metrics through the development process. (Tools to analyze bundle size / Webpack)

README

        
_Please note that Webpack Monitor is **NOT** currently maintained - sorry_ 😢



  

    

  



# Webpack Monitor

Webpack Monitor is a configurable Webpack plugin that captures relevant statistics on your production builds, and an interactive analysis tool that helps developers better understand bundle composition and identify and prioritize optimization strategies.

[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url]

## Usage

![webpack monitor analysis tool](https://roachjc.github.io/main3.gif)

Install the webpack monitor plugin on your production config. The plugin will collect stats whenever meaningful changes to bundle composition have occurred. Optionally launch analysis too to see how your bundles have changed over time!

## Setup

```sh

npm install --save-dev webpack-monitor

```

in `webpack.config.js`

```js

const WebpackMonitor = require('webpack-monitor');

// ...

plugins: [

  new WebpackMonitor({

    capture: true, // -> default 'true'

    target: '../monitor/myStatsStore.json', // default -> '../monitor/stats.json'

    launch: true, // -> default 'false'

    port: 3030, // default -> 8081

    excludeSourceMaps: true // default 'true'

  }),

],

```

- `capture` will collect stats on the build where meaningful changes have occurred. We do not capture build data where the build does not differ from most recent build on file.  

- `target` specify where to save your build data  

- `launch` will fire up a local server and launch the webpack monitor analysis tool  

- `port` optionally set the port for local server  

- `excludeSourceMaps` excludes emitted source maps from the build stats  

## Contributing

To contribute to `webpack-monitor`, fork the repository and clone it to your machine then install dependencies with `npm install`. If you're interested in joining the Webpack Monitor team as a contributor, feel free to message one of us directly!

## Authors

- Jon Roach (https://github.com/roachjc)

- Gordon Yu (https://github.com/gordonu)

- Balal Zuhair (https://github.com/bzuhair)

## License

This project is licensed under the MIT License - see the LICENSE.md file for details

[downloads-image]: https://img.shields.io/npm/dt/webpack-monitor.svg

[npm-url]: https://www.npmjs.com/package/webpack-monitor

[npm-image]: https://img.shields.io/npm/v/webpack-monitor.svg