🍻 Displays the size of a given file in your repository.
Clone or download
Latest commit ffe6314 Nov 9, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib 🐞 fix regression on url parsing Aug 27, 2018
.editorconfig
.eslintrc 🔩 refactoring 2k18 flavor Aug 5, 2018
.gitattributes birth Jul 18, 2015
.gitignore 🔩 (package) ignore coverage directory Sep 5, 2016
.travis.yml 🔩 test on lts and stable node versions Aug 5, 2018
index.js always send hex colors Aug 26, 2018
package.json Use https. (#74) Nov 9, 2018
readme.md Use https. (#74) Nov 9, 2018
test.js 🐞 fix regression on url parsing Aug 27, 2018
yarn.lock 😎 switch to yarn Aug 5, 2018

readme.md

badge-size npm travis

Displays the size of a given file in your repository.

badge-size allows you to display in real time the size of a given file which lives in your repository. The size is always the one of your last pushed commit.

It is mainly designed for front-end library authors that want to advertise the weight of their builds to their users. But you can use it for any other purpose of course ✌️.

Examples

Badge URL
Normal size
Gzipped size
Brotli size
Custom label
PNG format
JPG format

Usage

It works like any other badge service you may know and it's configurable in the image url itself. Here is the general pattern of a typical badge-size url:

https://img.badgesize.io/:filepath[.svg|png|jpg][?compression=gzip|brotli][&label=string][&max=string][&softmax=string]

:filepath

Relative URL of file on GitHub of any absolute URL if hosted elsewhere.

The format of the GitHub URL is the same as when you browse it in the source explorer, minus blob/ part. Here is its typical form:

:user/:repo/:branch/:path

For example if I want to point to this repository index.js, it would be:

https://github.com/ngryman/badge-size/master/index.js

Note that the branch name is mandatory.

[.svg|png|jpg]

Optional image format. By default svg is used.

[?compression=gzip|brotli]

Optional compression format to measure. It's useful if you want to advertise the true size your file would take on the wire, assuming the server has gzip or brotli compression enabled.

[&label=string]

Optional text to display in the badge instead of size / gzip size / brotli size.

[&color=string]

Optional background color. By default it's brightgreen.
You can specify hexadecimal colors, without the dash (i.e bada55) or one of the following named colors:

[&style=string]

Optional style. By default it's flat.
You can specify one of the following:

[&max=string] [&softmax=string]

Optional size limits in bytes.
Max is a hard limit. Exceeding this will generate a red badge.
If softlimit is provided (in addition to max) and the file size falls within the range of max and softmax, a yellow badge will be generated.
This setting will override the color option in the above two scenarios.

https://img.badgesize.io/:filepath?max=100000&softmax=200000

Contributors

Generated with contributors-faces.

License

MIT © Nicolas Gryman