# bundlesize2 > Keep your bundle size in check Latest version **0.0.35** (published 2025-03-12) · MIT license · 0 weekly downloads ## Install ```sh npm install bundlesize2 pnpm add bundlesize2 yarn add bundlesize2 bun add bundlesize2 ``` Provides the command `bundlesize`. ## Health **Score 40/100 (D)** — status: stable. Positive: no vulnerabilities; high maintenance score. Warnings: low downloads; no types; no esm support; pre 1.0. Negative: stale. ## Facts | | | |---|---| | Version | 0.0.35 | | Published | 2025-03-12 | | First published | 2020-04-26 | | Weekly downloads | 0 | | License | MIT | | TypeScript types | none | | Module format | CommonJS | | Dependencies | 10 | | Unpacked size | 37.3 KB | | Known vulnerabilities | 0 | | Install scripts | no | | GitHub stars | 55 | | Maintainers | siddharthkp | ## Links - npm: https://www.npmjs.com/package/bundlesize2 - Repository: https://github.com/siddharthkp/bundlesize2 - Homepage: https://github.com/siddharthkp/bundlesize2#readme - Issues: https://github.com/siddharthkp/bundlesize2/issues - npm.io page: https://npm.io/package/bundlesize2 ## Dependencies (10) - [glob](https://npm.io/package/glob.md) ^9.3.5 - [plur](https://npm.io/package/plur.md) ^4.0.0 - [bytes](https://npm.io/package/bytes.md) ^3.1.0 - [chalk](https://npm.io/package/chalk.md) ^4.0.0 - [ci-env](https://npm.io/package/ci-env.md) ^1.15.0 - [figures](https://npm.io/package/figures.md) ^3.2.0 - [commander](https://npm.io/package/commander.md) ^5.1.0 - [gzip-size](https://npm.io/package/gzip-size.md) ^5.1.1 - [node-fetch](https://npm.io/package/node-fetch.md) ^2.6.7 - [cosmiconfig](https://npm.io/package/cosmiconfig.md) 5.2.1 ## Recent versions - 0.0.35 (latest) — 2025-03-12 - 0.0.34 — 2025-01-27 - 0.0.33 — 2025-01-27 - 0.0.32 — 2025-01-09 - 0.0.31 — 2021-10-21 - 0.0.30 — 2021-08-03 - 0.0.29 — 2021-08-03 - 0.0.28 — 2021-07-21 - 0.0.27 — 2021-01-07 - 0.0.26 — 2020-09-09 - 0.0.25 — 2020-05-14 - 0.0.24 — 2020-05-02 - 0.0.23 — 2020-05-02 - 0.0.22 — 2020-05-02 - 0.0.21 — 2020-05-02 - … 19 more at https://npm.io/package/bundlesize2/versions ## README



bundlesize - version 2 preview

  Jump to: - [Migration from bundlesize@0.18.0](#migration-from-bundlesize0180) - [Setup](#setup) - [Usage](#usage) - [Configuration](#configuration) - [Build status and Checks for GitHub](#build-status-and-checks-for-github)   #### Setup ```sh npm install bundlesize2 --save-dev # or yarn add bundlesize2 --dev ```   #### Usage   Add it to your scripts in `package.json` ```json "scripts": { "test": "bundlesize" } ``` Or you can use it with `npx` from [NPM 5.2+](https://medium.com/@maybekatz/introducing-npx-an-npm-package-runner-55f7d4bd282b). ```sh npx bundlesize2 ```   #### Configuration   1. Option 1: Create a `bundlesize.config.json` (recommended) Format: ```json { "files": [ { "path": "./build/vendor.js", "maxSize": "30 kB" }, { "path": "./build/chunk-*.js", "maxSize": "10 kB" } ] } ``` The file is expected to be at the project root. But, you can give a different path by using the `--config` flag: ``` bundlesize --config configs/bundlesize.json ``` Option 2: You can also put the config in `package.json` ```json { "name": "your cool library", "version": "1.1.2", "bundlesize": [ { "path": "./build/vendor.js", "maxSize": "3 kB" } ] } ``` Notice that the key here is `bundlesize` instead of `files`.   #### Customisation   1. Fuzzy matching If the names of your build files are not predictable, you can use the [glob pattern](https://github.com/isaacs/node-glob) to specify files. This is common if you append a hash to the name. ```json { "files": [ { "path": "build/**/main-*.js", "maxSize": "5 kB" }, { "path": "build/**/*.chunk.js", "maxSize": "50 kB" } ] } ``` It will match multiple files if necessary and create a new row for each file.   2. Compression options By default, bundlesize `gzips` your build files before comparing. If you are using `brotli` instead of gzip, you can specify that with each file: ```json { "files": [ { "path": "./build/vendor.js", "maxSize": "5 kB", "compression": "brotli" } ] } ``` If you do not use any compression before sending your files to the client, you can switch compression off: ```json { "files": [ { "path": "./build/vendor.js", "maxSize": "5 kB", "compression": "none" } ] } ```   #### Build status and Checks for GitHub   If your repository is hosted on GitHub, you can set bundlesize up to create a "check" on every pull request. ![build status](https://cdn.rawgit.com/siddharthkp/bundlesize/master/art/status.png) To enable checks, 1. Run `bundlesize` with the flag `bundlesize --enable-github-checks`. 2. [authorize `bundlesize` to add checks](https://github.com/apps/bundlesize2) (Does not need access to your code) Checks work with [GitHub Actions](https://github.com/features/actions), [Travis CI](https://travis-ci.org), [CircleCI](https://circleci.com/), [Wercker](http://www.wercker.com), and [Drone](http://readme.drone.io/). Using a different CI? You will need to supply an additional 5 environment variables. - `CI_REPO_OWNER` given the repo `https://github.com/myusername/myrepo` would be `myusername` - `CI_REPO_NAME` given the repo `https://github.com/myusername/myrepo` would be `myrepo` - `CI_COMMIT_MESSAGE` the commit message - `CI_COMMIT_SHA` the SHA of the CI commit, in [Jenkins](https://jenkins.io/) you would use `${env.GIT_COMMIT}` - `CI=true` usually set automtically in CI enviroments   #### Migration from bundlesize@0.18.0 1. Use the npm package `bundlesize2` instead of `bundlesize` 2. If you'd like status reported back to github, use the flag `--enable-github-checks` + authorize bundlesize2 app. [More in the docs](https://github.com/siddharthkp/bundlesize2#build-status-and-checks-for-github) 3. Remove `BUNDLESIZE_GITHUB_TOKEN`, it's not required anymore 4. If anything breaks, let me know :) Note: When this package is feature complete, it will be merged back into the original project as bundlesize@2.0.0   #### license MIT © [siddharthkp](https://github.com/siddharthkp) --- _Source: https://npm.io/package/bundlesize2 · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._