Badge request: npm installed size

[styfle]

I see there is already a badge for bundle phobia that displays the bundle size which is useful for front-end packages like react.

I would like to add a badge for package phobia that displays the total npm install size plus dependencies, which is useful for backend packages such as express or desktop packages like electron.

Right now I'm just redirecting to shields but I had a suggestion to get put this on shields.io

Would you accept a PR if I created one? 😄

[chris48s]

Looks like the packagephobia badge is already generated by calling shields.io:

https://github.com/styfle/packagephobia/blob/master/src/util/badge.ts

Can you give a bit more detail about how you'd plan to add it here?

[styfle]

Correct, I would probably just call the Package Phobia API.

For example, to fetch the size of electron: https://packagephobia.now.sh/api.json?p=electron@2.0.2

Then use the same pretty bytes that some of the other shields are using.

I'm not sure where the color should live.
Right now, I use the a function to determine the color here: https://github.com/styfle/packagephobia/blob/master/src/util/npm-parser.ts#L70

So it would be duplicated code which is not always good.

How do other shield implementations do this?

[chris48s]

I would probably just call the Package Phobia API.
For example, to fetch the size of electron: https://packagephobia.now.sh/api.json?p=electron@2.0.2

👍 Sounds good, submit a PR and someone will review.

I'm not sure where the color should live.
...
How do other shield implementations do this?

Most of the badges which report a size use a constant colour (usually blue). This makes more sense than trying to declare that one size is 'good' (green) and another is 'bad' (red), because ultimately it depends on the package. My expectations of what is a reasonable size for a package that implements base64 encode/decode are very different to my expectations of a reasonable size for a unit testing framework (for example).
I don't think we have any 'size' badges which attempt to band sizes like you've done there.

[styfle]

My expectations of what is a reasonable size for a package that implements base64 encode/decode are very different to my expectations of a reasonable size for a unit testing framework

Good point.

I found badge-size which has an interesting way of doing color.

They have a max and softmax parameter which I was going to implement for package phobia.

Maybe I should return color as a parameter in the JSON API so I can keep that logic in my app?