performance-budget-plugin for webpack
Measure the impact of your changes to the performance of your application.
The plugin works with the help of `webpack dev server` and gathers metrics between
the re-builds (every time you make some changes in your codebase). It is recommended to have
the hot module replacement disabled when you use this plugin.
***A performance budget provides values against which design, development, content, or any aspect of a site that may affect performance, can be made.***
The aim of the plugin is to analyze the performance of the website against a performance bugdet.
[](http://forthebadge.com)
## Install
`npm install performance-budget-plugin [--save-dev]`
## Setup
```js
// webpack.config.js
var PerformanceBudgetPlugin = require('performance-budget-plugin');
module.exports = {
// ...
plugins: [
new PerformanceBudgetPlugin({
timeToFirstCss: 500, // ms, default: Infinity
timeToFirstJs: 1500, // ms, default: Infinity
jsSize: 50000, // bytes, default: Infinity
cssSize: 30000, // bytes, default: Infinity
domInteractive: 6000, // ms, default: Infinity
domContentLoaded: 7000, // ms, default: Infinity
domComplete: 8000, // ms, default: Infinity
metricsSummary: 'minimal' // options: [verbose, minimal, true, false], default: false,
numberOfRebuilds: 3 // number of rebuilds before displaying metrics, default 2
})
]
// ...
}
```
### Results
A little while after webpack finishes the compilation you will get in your terminal impacts of your changes. e.g.
Passing `minimal` as value of the `metricsSummary` option will give you some more info about your application.
Passing `verbose` you will get some more in-depth info.
## Options
All options are optional. Apart from the available metrics you can also pass `metricsSummary` and `numberOfRebuilds`
## Available Metrics
Any of the following can be passed to as param to the options object
requests,
gzipRequests,
postRequests,
httpsRequests,
notFound,
timeToFirstByte,
timeToLastByte,
bodySize,
contentLength,
httpTrafficCompleted,
ajaxRequests,
htmlCount,
htmlSize,
cssCount,
cssSize,
jsCount,
jsSize,
jsonCount,
jsonSize,
imageCount,
imageSize,
webfontCount,
webfontSize,
videoCount,
videoSize,
base64Count,
base64Size,
cacheHits,
cacheMisses,
cachePasses,
domains,
domInteractive,
domContentLoaded,
domComplete,
maxRequestsPerDomain,
medianRequestsPerDomain,
cookiesSent,
cookiesRecv,
domainsWithCookies,
documentCookiesLength,
documentCookiesCount,
assetsNotGzipped,
assetsWithQueryString,
assetsWithCookies,
smallImages,
smallCssFiles,
smallJsFiles,
multipleRequests,
smallestResponse,
biggestResponse,
fastestResponse,
slowestResponse,
smallestLatency,
biggestLatency,
medianResponse,
medianLatency,
requestsToFirstPaint,
domainsToFirstPaint,
requestsToDomContentLoaded,
domainsToDomContentLoaded,
requestsToDomComplete,
domainsToDomComplete,
## Like `performance-budget-plugin`?
Support it by giving [feedback](https://github.com/AvraamMavridis/performance-budget-plugin/issues), contributing or just by 🌟 starring the project!
### Contribute
Any pull-request is more than welcome :boom: :smile:
This project adheres to the Contributor Covenant [code of conduct](http://contributor-covenant.org/). By participating, you are expected to uphold this code.
### Contact
twitter: @avraamakis
## License
MIT