Repository files navigation

Measure the impact of your changes to the performance of your application.The plugin works with the help ofwebpack dev server and gathers metrics betweenthe re-builds (every time you make some changes in your codebase). It is recommended to havethe 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.

npm install performance-budget-plugin [--save-dev]

// webpack.config.jsvarPerformanceBudgetPlugin=require('performance-budget-plugin');module.exports={// ...plugins:[newPerformanceBudgetPlugin({timeToFirstCss:500,// ms, default: InfinitytimeToFirstJs:1500,// ms, default: InfinityjsSize:50000,// bytes, default: InfinitycssSize:30000,// bytes, default: InfinitydomInteractive:6000,// ms, default: InfinitydomContentLoaded:7000,// ms, default: InfinitydomComplete:8000,// ms, default: InfinitymetricsSummary:'minimal'// options: [verbose, minimal, true, false], default: false,numberOfRebuilds:3// number of rebuilds before displaying metrics, default 2})]// ...}

A little while after webpack finishes the compilation you will get in your terminal impacts of your changes. e.g.

Passingminimal as value of themetricsSummary option will give you some more info about your application.

Passingverbose you will get some more in-depth info.

All options are optional. Apart from the available metrics you can also passmetricsSummary andnumberOfRebuilds

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,

Support it by givingfeedback, contributing or just by 🌟 starring the project!

Any pull-request is more than welcome 💥 😄

This project adheres to the Contributor Covenantcode of conduct. By participating, you are expected to uphold this code.

twitter: @avraamakis

MIT