Skip to content

Latest commit

 

History

History
269 lines (196 loc) · 10.7 KB

README.md

File metadata and controls

269 lines (196 loc) · 10.7 KB
Raw
BundleMon logo

BundleMon

npm node npm npm

BundleMon helps you to monitor your bundle size.

Your goal is to keep your bundle size as small as possible to reduce the amount of time it takes for users to load your website/application. This is particularly important for users on low bandwidth connections.

BundleMon helps you achieve that by constantly monitoring your bundle size on every commit and alerts you on changes.

Features

  • Set max size for files, will fail build if exceeded
  • Compare files to base branch
  • Set max increase allowed in percentage from base branch, will fail build if exceeded
  • Supports multiple CI
  • Integrates with Github, can post build status & comment with detailed information
  • History report - example

History report - specific commit History report

Guides

Setup

npm install bundlemon --save-dev

# or

yarn add bundlemon --dev

Add bundlemon property to your package.json

"bundlemon": {
  "baseDir": "./build",
  "files": [
    {
      "path": "index.html",
      "maxSize": "2kb",
      "maxPercentIncrease": 5
    },
    {
      "path": "bundle.<hash>.js",
      "maxSize": "10kb"
    },
    {
      "path": "assets/**/*.{png,svg}"
    }
  ]
}

BundleMon config can be placed in other places like: .bundlemonrc, .bundlemonrc.json, bundlemon.config.js exporting a JS object, more forms can be found here

Name Description Type Default
baseDir Relative/absolute path to the directory string process.cwd()
files Files config FileConfig[] -
groups Sum all file sizes matching the pattern, rules applies to the sum of the files Groups config FileConfig[] -
defaultCompression Use compression before calculating file size "none" | "gzip" | "brotli" "gzip"
reportOutput Output options (string | [string, object])[] []
verbose Print more details boolean false
subProject By setting sub project you can use the same project id for multiple projects. This can be useful for monorepos. Can be set/overwrite with BUNDLEMON_SUB_PROJECT env var string undefined
includeCommitMessage Include commit message when saving records boolean false
pathLabels More info here Record<string, string> { "hash": "[a-zA-Z0-9]+" }

CLI usage

You can also set some of the variables using CLI flags

bundlemon --config my-custom-config-path.json

CLI flags docs

Path labels

When using hash in file names the file name can be changed every build.

In order for BundleMon to keep track of your files you can use <hash> to replace the hash with a constant string.

For example:

index.html
home.b72f15a3.chunk.js
login.057c430b.chunk.js
bundle.ea45e578.js

Config:

"bundlemon": {
  "baseDir": "./build",
  "files": [
    {
      "path": "*.<hash>.chunk.js"
    },
    {
      "path": "*.<hash>.js"
    }
  ]
}

Output:

[PASS] bundle.(hash).js: 19.67KB
[FAIL] home.(hash).chunk.js: 70.09KB > 50KB
[PASS] login.(hash).chunk.js: 3.37KB < 50KB

Tip

You can customize the default labels and add more labels, more info here

BundleMon Project

In order to save history and get differences from your main branches BundleMon will need a project id.

If you are running BundleMon in GitHub actions BundleMon will detect all necessary information automatically, Just Install BundleMon GitHub App.

If not, you will need to create a new project and setup environment variables.

  • Create new project and copy the project ID and API key
  • Add the ID to BUNDLEMON_PROJECT_ID and the API key to BUNDLEMON_PROJECT_APIKEY environment variables in your CI

GitHub integration

BundleMon can create GitHub check run, post commit status and a detailed comment on your PR.

GitHub check run


GitHub build status


GitHub detailed comment

  1. Install BundleMon GitHub App

  2. Setup integration

    • If BundleMon runs in GitHub actions you can go to step 2.

    • If BundleMon not runs In GitHub actions you will need to create GitHub access token without any scopes, the token owner must have write permission to the repo you would want to post outputs to.

      Add the token to BUNDLEMON_GITHUB_TOKEN environment variable in your CI.

      The token is not saved in BundleMon service, ONLY used to verify the username that created the token.

  3. Add github to reportOutput

    "reportOutput": ["github"]

// override default options

"reportOutput": [
  [
    "github",
    {
      "checkRun": false,
      "commitStatus": true,
      "prComment": true
    }
  ]
]

// each option support conditional values

"reportOutput": [
  [
    "github",
    {
      "checkRun": false, // can also be "off"
      "commitStatus": true, // can also be "always"
      "prComment": "on-failure"
    }
  ]
]

    Each option support one of: true | false | "always" | "on-failure" | "pr-only" | "off"

    "on-failure" option means that only when BundleMon limit exceeded then it will post the output (check run / commit status / PR comment) to GitHub

GitHub action example & forks support

BundleMon supports running on PRs originating from forks.

Step by step guide to set up BundleMon with Github actions

name: Build

on:
  push:
    branches: [main]
  pull_request:
    types: [synchronize, opened, reopened]

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v3
      - name: Setup Node
        uses: actions/setup-node@v3
        with:
          node-version: '18'

      - name: Install dependencies
        run: yarn

      - name: Build
        run: yarn build

      - name: BundleMon
        uses: lironer/bundlemon-action@v1

Set additional environment variables

In order to get BundleMon to work you'll need to set these environment variables:

If you are using one of the supported CIs (GitHub Actions, Travis and Codefresh) you dont need to set anything. CircleCI is also supported, but you need to manually set CI_TARGET_BRANCH.

  • CI=true
  • CI_REPO_OWNER - github.com/LironEr/bundlemon LironEr
  • CI_REPO_NAME - github.com/LironEr/bundlemon bundlemon
  • CI_BRANCH - source branch name
  • CI_COMMIT_SHA - commit SHA
  • CI_TARGET_BRANCH - target branch name, only set if BundleMon runs on a pull request
  • CI_PR_NUMBER - PR number, only set if BundleMon runs on a pull request
  • CI_COMMIT_MESSAGE - Optional, set it if includeCommitMessage option is true

BundleMon free hosted service

By default BundleMon is running on a free hosted server, you can also run BundleMon on your server.

Limitations of the free hosted service:

  • Records created by a PR will be deleted after 30 days.
  • Records in branches without activity (new commits) will be deleted after 180 days.
  • After 90 days only the latest record per day will be kept.

More limitations may be added in the future as more and more projects use the free hosted service.

If you want to support this project and help with server costs please consider donating ❤

Contributing

Read the contributing guide to learn how to run this project locally and contribute.