bundlesize

WebJar for bundlesize

License	License MIT
GroupId	GroupId org.webjars.npm
ArtifactId	ArtifactId bundlesize
Last Version	Last Version 0.17.1
Release Date	Release Date Jan 24, 2019
Type	Type jar
Description	Description bundlesize WebJar for bundlesize
Project URL	Project URL http://webjars.org
Source Code Management	Source Code Management https://github.com/siddharthkp/bundlesize

Download bundlesize

Filename	Size
bundlesize-0.17.1.pom
bundlesize-0.17.1.jar	14 KB
bundlesize-0.17.1-sources.jar	22 bytes
bundlesize-0.17.1-javadoc.jar	22 bytes
Browse

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/bundlesize/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>bundlesize</artifactId>
    <version>0.17.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/bundlesize/
implementation 'org.webjars.npm:bundlesize:0.17.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/bundlesize/
implementation ("org.webjars.npm:bundlesize:0.17.1")

Apache Buildr

'org.webjars.npm:bundlesize:jar:0.17.1'

Apache Ivy

<dependency org="org.webjars.npm" name="bundlesize" rev="0.17.1">
  <artifact name="bundlesize" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='bundlesize', version='0.17.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "bundlesize" % "0.17.1"

Leiningen

[org.webjars.npm/bundlesize "0.17.1"]

Dependencies

compile (10)

Group / Artifact	Type	Version
org.webjars.npm : axios	jar	[0.17.0,0.18)
org.webjars.npm : brotli-size	jar	[0.0.1]
org.webjars.npm : bytes	jar	[3.0.0,4)
org.webjars.npm : prettycli	jar	[1.4.3,2)
org.webjars.npm : ci-env	jar	[1.4.0,2)
org.webjars.npm : glob	jar	[7.1.2,8)
org.webjars.npm : read-pkg-up	jar	[3.0.0,4)
org.webjars.npm : github-build	jar	[1.2.0,2)
org.webjars.npm : commander	jar	[2.11.0,3)
org.webjars.npm : gzip-size	jar	[4.0.0,5)

Project Modules

There are no modules declared in this project.

Keep your bundle size in check

Setup

npm install bundlesize --save-dev

# or

yarn add bundlesize --dev

Usage

Add it to your scripts in package.json

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

Or you can use it with npx from NPM 5.2+.

npx bundlesize

Configuration

bundlesize accepts an array of files to check.

[
  {
    "path": "./build/vendor.js",
    "maxSize": "30 kB"
  },
  {
    "path": "./build/chunk-*.js",
    "maxSize": "10 kB"
  }
]

You can keep this array either in

package.json

{
  "name": "your cool library",
  "version": "1.1.2",
  "bundlesize": [
    {
      "path": "./build/vendor.js",
      "maxSize": "3 kB"
    }
  ]
}

or in a separate file

bundlesize.config.json

Format:

{
  "files": [
    {
      "path": "./dist.js",
      "maxSize": "3 kB"
    }
  ]
}

You can give a different file by using the --config flag:

bundlesize --config configs/bundlesize.json

Customisation

Fuzzy matching

If the names of your build files are not predictable, you can use the glob pattern to specify files.

This is common if you append a hash to the name or use a tool like create-react-app/nextjs.
```
{
  "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.

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:

{
  "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:

{
  "files": [
    {
      "path": "./build/vendor.js",
      "maxSize": "5 kB",
      "compression": "none"
    }
  ]
}

Build status for GitHub

If your repository is hosted on GitHub, you can set bundlesize up to create a "check" on every pull request.

Currently works with Travis CI, CircleCI, Wercker, and Drone.

Authorize bundlesize for status access, copy the token provided.
Add this token as BUNDLESIZE_GITHUB_TOKEN as environment parameter in your CIs project settings.

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 you would use ${env.GIT_COMMIT}
CI=true usually set automatically in CI environments

(Ask me for help if you're stuck)

Usage with CLI

bundlesize can also be used without creating a configuration file. We do not recommend this approach and it might be deprecated in a future version.

bundlesize -f "dist/*.js" -s 20kB

For more granular configuration, we recommend configuring it in the package.json (documented above).

Like it?

⭐ this repo

How to contribute?

CONTRIBUTING.md

Featured on Totally tooling tips and Chrome Dev Summit!!

who uses bundlesize?

TODO

Work with other CI tools
- AppVeyor (#234)
Automate setup (setting env_var)

similar projects

BuildSize - GitHub App, no manual configuration required
travis-weigh-in - Uses Python rather than Node.js
size-limit - Uses webpack, builds your files for you.

Contributors

This project exists thanks to all the people who contribute. [Contribute].

license

Versions

Version
0.17.1 Jan 24, 2019