Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kaliber5/ember-cli-bundlesize
Make sure your Ember app stays small by testing its bundle size against a given size budget.
https://github.com/kaliber5/ember-cli-bundlesize
bundlesize ember ember-addon
Last synced: about 1 month ago
JSON representation
Make sure your Ember app stays small by testing its bundle size against a given size budget.
- Host: GitHub
- URL: https://github.com/kaliber5/ember-cli-bundlesize
- Owner: kaliber5
- License: mit
- Created: 2018-09-21T21:40:41.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-12-10T16:58:59.000Z (about 2 years ago)
- Last Synced: 2024-10-11T07:56:57.946Z (3 months ago)
- Topics: bundlesize, ember, ember-addon
- Language: JavaScript
- Homepage:
- Size: 2.33 MB
- Stars: 35
- Watchers: 3
- Forks: 5
- Open Issues: 25
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
ember-cli-bundlesize
==============================================================================
[](https://emberobserver.com/addons/ember-cli-bundlesize)
[](https://badge.fury.io/js/ember-cli-bundlesize)
Make sure your Ember app stays small by testing its bundle size against a given size budget.
Compatibility
------------------------------------------------------------------------------
* Ember.js v3.8 or above
* Ember CLI v2.13 or above
* Node.js v10 or above
Installation
------------------------------------------------------------------------------
```
ember install ember-cli-bundlesize
```
Make sure to `git add` the added `config/bundlesize.js` file!
#### Optional dependency
If your app uses Brotli compression and the `brotli` option is set in your configuration (i.e `compression: 'brotli'`), you must install the optional dependency: `brotli-size`.
```
npm install --save-dev brotli-size
```
Usage
------------------------------------------------------------------------------
This addon lets you define buckets for your asset files (e.g. JavaScript, CSS, images), and a size budget for each
bucket that all files belonging to that bucket must not exceed, e.g "max. 400KB of JavaScript after GZip compression".
### Running bundle size tests
Run this command to build and assert that your app does not exceed the defined limits:
```
ember bundlesize:test
```
This will create a production build of your app (so that may take a bit), and assert that all the files defined for
each bucket don't exceed its limits, after compression. In case of a failure the command will exit with a non-zero exit
code. So you can integrate this command into your CI workflow, and make your builds fail when the bundle size test
does not pass.
If you do not want to build the app before running the tests you can disable the build by passing `--build-app=false`.
If you want to use a different build directory from the default one (`dist`), use `--build-dir=other-dist-directory`.
### Configuration
After installing the addon, a `config/bundlesize.js` file with a default configuration will be generated:
```js
module.exports = {
app: {
javascript: {
pattern: 'assets/*.js',
limit: '500KB',
compression: 'gzip'
},
css: {
pattern: 'assets/*.css',
limit: '50KB',
compression: 'gzip'
}
}
};
```
In this example, top level is defined by `app`, followed by two buckets, `javascript` and `css`. You can include as many apps and buckets as you wish. Each app supports multiple buckets and each bucket supports the following configuration properties:
* `pattern`: a `glob` pattern (or array thereof) defining the files belonging to this bucket
* `limit`: the maximum size all files defined by `pattern` may consume. you can use common size units like `B`, `KB`, `MB`
* `compression`: what compression type to use before comparing:
* `gzip` (default)
* `brotli`: compress files using Brotli
* `none`: do not compress files at all
To override the location of the config path you can pass: `config-path=""`
Contributing
------------------------------------------------------------------------------
See the [Contributing](CONTRIBUTING.md) guide for details.