badge-size
Version:
Displays the size of a given file in your repository
131 lines (86 loc) • 5.67 kB
Markdown
# badge-size [![npm][npm-image]][npm-url] [![travis][travis-image]][travis-url]
[npm-image]: https://img.shields.io/npm/v/badge-size.svg?style=flat
[npm-url]: https://npmjs.org/package/badge-size
[travis-image]: https://img.shields.io/travis/ngryman/badge-size.svg?style=flat
[travis-url]: https://travis-ci.org/ngryman/badge-size
> 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 :v:.
## 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:
```
http://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:
```md
: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`.<br>
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`.<br>
You can specify one of the following:
#### `[&max=string] [&softmax=string]`
Optional size limits in bytes.<br>
Max is a hard limit. Exceeding this will generate a red badge. <br>
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.<br>
This setting will override the color option in the above two scenarios.
```
http://img.badgesize.io/:filepath?max=100000&softmax=200000
```
## Contributors
[//]: contributor-faces
<a href="https://github.com/ngryman"><img src="https://avatars2.githubusercontent.com/u/892048?v=4" title="ngryman" width="80" height="80"></a>
<a href="https://github.com/bfred-it"><img src="https://avatars3.githubusercontent.com/u/1402241?v=4" title="bfred-it" width="80" height="80"></a>
<a href="https://github.com/nathancahill"><img src="https://avatars0.githubusercontent.com/u/1383872?v=4" title="nathancahill" width="80" height="80"></a>
<a href="https://github.com/apps/greenkeeper"><img src="https://avatars3.githubusercontent.com/in/505?v=4" title="greenkeeper[bot]" width="80" height="80"></a>
<a href="https://github.com/FezVrasta"><img src="https://avatars2.githubusercontent.com/u/5382443?v=4" title="FezVrasta" width="80" height="80"></a>
<a href="https://github.com/OliverJAsh"><img src="https://avatars2.githubusercontent.com/u/921609?v=4" title="OliverJAsh" width="80" height="80"></a>
<a href="https://github.com/coopy"><img src="https://avatars2.githubusercontent.com/u/794843?v=4" title="coopy" width="80" height="80"></a>
<a href="https://github.com/hairmot"><img src="https://avatars2.githubusercontent.com/u/8102124?v=4" title="hairmot" width="80" height="80"></a>
[//]: contributor-faces
<sup>Generated with [contributors-faces](https://github.com/ngryman/contributor-faces).</sup>
## License
MIT © [Nicolas Gryman](http://ngryman.sh)