Keep your bundle size in check

 

 

minimal setup

npm install bundlesize --save-dev

 

usage

Add it to your scripts in package.json

"scripts": {
  "test": "bundlesize"
}

 

configuration

 

1. Add the path and threshold in your package.json

{
  "name": "your cool library",
  "version": "1.1.2",
  "bundlesize": [
    {
      "path": "./dist.js",
      "threshold": "3 Kb"
    }
  ]
}

 

2. build status

Currently works for Travis CI and CircleCI.

• Authorize bundlesize for status access, copy the token provided.
• Add this token as github_token as environment parameter in your CIs project settings.
• On travis-ci: Enable Build branch updates and Build pull request updates. (screenshot)
• On CircleCi: Enable GitHub Status updates in your advanced project settings (this should be enabled by default).

(Ask me for help if you're stuck)

 

like it?

⭐ this repo

 

who uses bundlesize?

• preact
• styled-components
• emotion
• glamorous
• css-constructor
• Popper.js

 

todo

• work with other CI tools (circle, appveyor, etc.)
• automate setup (setting env_var)

 

license

MIT © siddharthkp