Skip to content
Calculate the real cost to run your JS app or lib to keep good performance. Show error in pull request if the cost exceeds the limit.
JavaScript CSS
Branch: master
Clone or download

Latest commit

saitonakamura Add newlines between migration guide variants (#181)
It's easier to read this way, and more clear to what case which command corresponds
Latest commit 4924276 May 28, 2020

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
img Update screenshot Aug 11, 2019
packages Add newlines between migration guide variants (#181) May 28, 2020
scripts Fix bump script Mar 15, 2020
.editorconfig Initial commit Jun 25, 2017
.gitignore Remove JSDoc spelling check Mar 8, 2020
.travis.yml Remove Node.js 8 support Jan 7, 2020
CHANGELOG.md Release 4.5 version May 4, 2020
README.md Move action screenshot above Mar 18, 2020
package.json Update dependencies May 4, 2020
yarn.lock Update dependencies May 4, 2020

README.md

Size Limit Cult Of Martians

Size Limit logo by Anton Lovchikov

Size Limit is a performance budget tool for JavaScript. It checks every commit on CI, calculates the real cost of your JS for end-users and throws an error if the cost exceeds the limit.

  • ES modules and tree-shaking support.
  • Add Size Limit to Travis CI, Circle CI, GitHub Actions or another CI system to know if a pull request adds a massive dependency.
  • Modular to fit different use cases: big JS applications that use their own bundler or small npm libraries with many files.
  • Can calculate the time it would take a browser to download and execute your JS. Time is a much more accurate and understandable metric compared to the size in bytes.
  • Calculations include all dependencies and polyfills used in your JS.

Size Limit CLI

With GitHub action Size Limit will post bundle size changes as a comment in pull request discussion.

Size Limit comment in pull request about bundle size changes

With --why, Size Limit can tell you why your library is of this size and show the real cost of all your internal dependencies.

Bundle Analyzer example

Sponsored by Evil Martians

Who Uses Size Limit

How It Works

  1. Size Limit contains a CLI tool, 3 plugins (file, webpack, time) and 3 plugin presets for popular use cases (app, big-lib, small-lib). A CLI tool finds plugins in package.json and loads the config.
  2. If you use the webpack plugin, Size Limit will bundle your JS files into a single file. It is important to track dependencies and webpack polyfills. It is also useful for small libraries with many small files and without a bundler.
  3. The webpack plugin creates an empty webpack project, adds your library and looks for the bundle size difference.
  4. The time plugin compares the current machine performance with that of a low-priced Android devices to calculate the CPU throttling rate.
  5. Then the time plugin runs headless Chrome (or desktop Chrome if it’s available) to track the time a browser takes to compile and execute your JS.

Usage

JS Applications

Suitable for applications that have their own bundler and send the JS bundle directly to a client (without publishing it to npm). Think of a user-facing app or website, like an email client, a CRM, a landing page or a blog with interactive elements, using React/Vue/Svelte lib or vanilla JS.

Show instructions
  1. Install the preset:

    $ npm install --save-dev size-limit @size-limit/preset-app
  2. Add the size-limit section and the size script to your package.json:

    + "size-limit": [
    +   {
    +     "path": "dist/app-*.js"
    +   }
    + ],
      "scripts": {
        "build": "webpack ./webpack.config.js",
    +   "size": "npm run build && size-limit",
        "test": "jest && eslint ."
      }
  3. Here’s how you can get the size for your current project:

    $ npm run size
    
      Package size: 30.08 KB with all dependencies, minified and gzipped
      Loading time: 602 ms   on slow 3G
      Running time: 214 ms   on Snapdragon 410
      Total time:   815 ms
  4. Now, let’s set the limit. Add 25% to the current total time and use that as the limit in your package.json:

      "size-limit": [
        {
    +     "limit": "1 s",
          "path": "dist/app-*.js"
        }
      ],
  5. Add the size script to your test suite:

      "scripts": {
        "build": "webpack ./webpack.config.js",
        "size": "npm run build && size-limit",
    -   "test": "jest && eslint ."
    +   "test": "jest && eslint . && npm run size"
      }
  6. If you don’t have a continuous integration service running, don’t forget to add one — start with Travis CI.

Big Libraries

JS libraries > 10 KB in size.

This preset includes headless Chrome, and will measure your lib’s execution time. You likely don’t need this overhead for a small 2 KB lib, but for larger ones the execution time is a more accurate and understandable metric that the size in bytes. Library like React is a good example for this preset.

Show instructions
  1. Install preset:

    $ npm install --save-dev size-limit @size-limit/preset-big-lib
  2. Add the size-limit section and the size script to your package.json:

    + "size-limit": [
    +   {
    +     "path": "dist/react.production-*.js"
    +   }
    + ],
      "scripts": {
        "build": "webpack ./scripts/rollup/build.js",
    +   "size": "npm run build && size-limit",
        "test": "jest && eslint ."
      }
  3. If you use ES modules you can test the size after tree-shaking with import option:

      "size-limit": [
        {
          "path": "dist/react.production-*.js",
    +     "import": "{ createComponent }"
        }
      ],
  4. Here’s how you can get the size for your current project:

    $ npm run size
    
      Package size: 30.08 KB with all dependencies, minified and gzipped
      Loading time: 602 ms   on slow 3G
      Running time: 214 ms   on Snapdragon 410
      Total time:   815 ms
  5. Now, let’s set the limit. Add 25% to the current total time and use that as the limit in your package.json:

      "size-limit": [
        {
    +     "limit": "1 s",
          "path": "dist/react.production-*.js"
        }
      ],
  6. Add a size script to your test suite:

      "scripts": {
        "build": "rollup ./scripts/rollup/build.js",
        "size": "npm run build && size-limit",
    -   "test": "jest && eslint ."
    +   "test": "jest && eslint . && npm run size"
      }
  7. If you don’t have a continuous integration service running, don’t forget to add one — start with Travis CI.

  8. Add the library size to docs, it will help users to choose your project:

      # Project Name
    
      Short project description
    
      * **Fast.** 10% faster than competitor.
    + * **Small.** 15 KB (minified and gzipped).
    +   [Size Limit](https://github.com/ai/size-limit) controls the size.

Small Libraries

JS libraries < 10 KB in size.

This preset will only measure the size, without the execution time, so it’s suitable for small libraries. If your library is larger, you likely want the Big Libraries preset above. Nano ID or Storeon are good examples for this preset.

Show instructions
  1. First, install size-limit:

    $ npm install --save-dev size-limit @size-limit/preset-small-lib
  2. Add the size-limit section and the size script to your package.json:

    + "size-limit": [
    +   {
    +     "path": "index.js"
    +   }
    + ],
      "scripts": {
    +   "size": "size-limit",
        "test": "jest && eslint ."
      }
  3. Here’s how you can get the size for your current project:

    $ npm run size
    
      Package size: 177 B with all dependencies, minified and gzipped
  4. If your project size starts to look bloated, run --why for analysis:

    $ npm run size -- --why
  5. Now, let’s set the limit. Determine the current size of your library, add just a little bit (a kilobyte, maybe) and use that as the limit in your package.json:

     "size-limit": [
        {
    +     "limit": "9 KB",
          "path": "index.js"
        }
     ],
  6. Add the size script to your test suite:

      "scripts": {
        "size": "size-limit",
    -   "test": "jest && eslint ."
    +   "test": "jest && eslint . && npm run size"
      }
  7. If you don’t have a continuous integration service running, don’t forget to add one — start with Travis CI.

  8. Add the library size to docs, it will help users to choose your project:

      # Project Name
    
      Short project description
    
      * **Fast.** 10% faster than competitor.
    + * **Small.** 500 bytes (minified and gzipped). No dependencies.
    +   [Size Limit](https://github.com/ai/size-limit) controls the size.

Reports

Size Limit has a GitHub action that comments and rejects pull requests based on Size Limit output.

  1. Install and configure Size Limit as shown above.
  2. Add the following action inside .github/workflows/size-limit.yml
name: "size"
on:
  pull_request:
    branches:
      - master
jobs:
  size:
    runs-on: ubuntu-latest
    env:
      CI_JOB_NUMBER: 1
    steps:
      - uses: actions/checkout@v1
      - uses: andresz1/size-limit-action@v1.0.0
        with:
          github_token: ${{ secrets.GITHUB_TOKEN }}

Config

Size Limits supports three ways to define config.

  1. size-limit section in package.json:

      "size-limit": [
        {
          "path": "index.js",
          "import": "{ createStore }",
          "limit": "500 ms"
        }
      ]
  2. or a separate .size-limit.json config file:

    [
      {
        "path": "index.js",
        "import": "{ createStore }",
        "limit": "500 ms"
      }
    ]
  3. or a more flexible .size-limit.js config file:

    module.exports = [
      {
        path: "index.js",
        import: "{ createStore }",
        limit: "500 ms"
      }
    ]

Each section in the config can have these options:

  • path: relative paths to files. The only mandatory option. It could be a path "index.js", a pattern "dist/app-*.js" or an array ["index.js", "dist/app-*.js", "!dist/app-exclude.js"].
  • import: partial import to test tree-shaking. It could be "{ lib }" to test import { lib } from 'lib' or { "a.js": "{ a }", "b.js": "{ b }" } to test multiple files.
  • limit: size or time limit for files from the path option. It should be a string with a number and unit, separated by a space. Format: 100 B, 10 KB, 500 ms, 1 s.
  • name: the name of the current section. It will only be useful if you have multiple sections.
  • entry: when using a custom webpack config, a webpack entry could be given. It could be a string or an array of strings. By default, the total size of all entry points will be checked.
  • webpack: with false it will disable webpack.
  • running: with false it will disable calculating running time.
  • gzip: with false it will disable gzip compression.
  • brotli: with true it will use brotli compression and disable gzip compression.
  • config: a path to a custom webpack config.
  • ignore: an array of files and dependencies to exclude from the project size calculation.

If you use Size Limit to track the size of CSS files, make sure to set webpack: false. Otherwise, you will get wrong numbers, because webpack inserts style-loader runtime (≈2 KB) into the bundle.

Plugins and Presets

Plugins:

  • @size-limit/file checks the size of files with Gzip, Brotli or without compression.
  • @size-limit/webpack adds your library to empty webpack project and prepares bundle file for file plugin.
  • @size-limit/time uses headless Chrome to track time to execute JS.
  • @size-limit/dual-publish compiles files to ES modules with dual-publish to check size after tree-shaking.

Plugin presets:

  • @size-limit/preset-app contains file and time plugins.
  • @size-limit/preset-big-lib contains webpack, file, and time plugins.
  • @size-limit/preset-small-lib contains webpack and file plugins.

JS API

const sizeLimit = require('size-limit')
const filePlugin = require('@size-limit/file')
const webpackPlugin = require('@size-limit/webpack')

sizeLimit([filePlugin, webpackPlugin], [filePath]).then(result => {
  result //=> { size: 12480 }
})
You can’t perform that action at this time.