Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

size-check

Zero dependencies Node License: MIT Platform

Assert that your build artifacts haven't exceeded size limits. Gzip and Brotli aware. Zero dependencies.

Like size-limit but with no dependencies. Like bundlesize but maintained.


Install

npm install -g size-check

Or without installing:

npx size-check

Quick Start

Add to your package.json:

{
  "size-check": [
    { "path": "dist/*.js",  "maxSize": "100 kB" },
    { "path": "dist/*.css", "maxSize": "20 kB", "gzip": true }
  ]
}

Then run:

size-check

Example Output

size-check  package.json

  PATH                                      SIZE        LIMIT       %     STATUS
  ────────────────────────────────────────  ──────────  ──────────  ────  ──────
  dist/main.js                              87.4 kB     100 kB      87%   PASS
  dist/vendor.js                            142.3 kB    100 kB      142%  FAIL
  dist/styles.css                           14.2 kB gz  20 kB       71%   PASS

  ───────────────────────────────────────────────────────────────────────────────
  2 passed  1 failed

Config

In package.json:

{
  "size-check": [
    { "path": "dist/*.js",   "maxSize": "100 kB" },
    { "path": "dist/*.css",  "maxSize": "20 kB",  "gzip": true },
    { "path": "dist/**/*",   "maxSize": "500 kB", "brotli": true }
  ]
}

Or as .sizecheckrc.json:

[
  { "path": "dist/bundle.js", "maxSize": "100 kB" },
  { "path": "dist/styles.css", "maxSize": "20 kB" }
]

Entry fields

Field Type Description
path string Glob pattern relative to config file
maxSize string Size limit: 100 kB, 1 MB, 500 B
gzip boolean Check gzip-compressed size
brotli boolean Check brotli-compressed size

CI Integration

- name: Check bundle sizes
  run: npx size-check

Exit code is 1 if any limit is exceeded.


Options

size-check                  # Use .sizecheckrc.json or package.json
size-check limits.json      # Use a specific config file
size-check --gzip           # Force gzip checking for all entries
size-check --brotli         # Force brotli checking for all entries
size-check --dir dist/      # Set base directory

License

MIT


Keywords

bundle size · size-limit alternative · bundlesize alternative · ci size check · gzip size · brotli size · build size · asset size · zero dependencies · ci


Built to solve, shared to help — Rushabh Shah 🛠️✨

One of 40+ zero-dependency developer CLI tools — no node_modules, ever.

Releases

Packages

Contributors

Languages