[![npm][npm]][npm-url]
[![bundlewatch][bundlewatch]][bundlewatch-url]
[![node][node]][node-url]
[![deps][deps]][deps-url]
[![builds][builds]][builds-url]
[![test][test]][test-url]
[![licenses][licenses]][licenses-url]
BundleWatch
BundleWatch checks file sizes, ensuring bundled browser assets don't jump in file size.
Sharp increases in BundleWatch can signal that something is wrong - adding a package that bloats the slug, a wrong import, or forgetting to minify.
Inspired by [Siddharth Kshetrapal bundlesize](https://github.com/siddharthkp/bundlesize)
# Getting Started:
Install the BundleWatch package:
- NPM: `npm install bundlewatch --save-dev`
- Yarn: `yarn add bundlewatch --dev`
Add some basic configuration to your .package.json`
```json
{
"name": "my package name",
"version": "0.0.1",
"bundlewatch" : {
"files": [
{
"path": "myfolder/*.js",
"maxSize": "100kB"
}
]
}
}
```
Usage:
- NPM: `npm run bundlewatch`
- Yarn: `yarn run bundlewatch`
This will give you command line output. If you want BundleWatch to report build status on your pull requests, see below.
# Adding Build Status:
BundleWatch can report its status on your GitHub Pull Requests.
