Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add badge to display install size #233

Merged
merged 3 commits into from Jan 21, 2021
Merged

Add badge to display install size #233

merged 3 commits into from Jan 21, 2021

Conversation

styfle
Copy link
Contributor

@styfle styfle commented May 21, 2018

This adds a badge to the README.md file to display the npm install size

@mikaelbr
Copy link
Owner

Hi. Thanks for the PR. I'm not entirely sure why this is needed though, to be honest. What is the end goal of showing the download size?

I get this can add value for dependencies intended for frontend bundles (as a part of making decisions of "ROI" for a dependency), but this is intended a whole other use case. 1 MB isn't that much for a tool of this nature in my opinion, and I feel this can just lead to bikeshedding. What do you think?

@styfle
Copy link
Contributor Author

styfle commented May 21, 2018

Correct, 1 MB is not that much for this type of tool.
Data doesn't have to be good or bad, it's just information that users can use to make a decision: should I use this package?

You can read more about why Package Phobia exists: https://github.com/styfle/packagephobia#readme

@styfle
Copy link
Contributor Author

styfle commented Jun 1, 2018

It looks like tests failed but I don't see any test for the README.
Any idea why this is failing?

@egoist
Copy link

egoist commented Oct 13, 2019

And now it grows to 5MB 😅

image

@mikaelbr
Copy link
Owner

There was someone attacking the repo with comments and approval/rejection reviews triggering this one again, but as you've taken the time to update the PR and fix merge conflicts I can merge this if you feel it is helpful. Currently, it has a lot of potential optional deps without being lazy-loaded (64bit vs 32bit, OS specific etc) which can be approved and reduce the install size dramatically, so this can be approved and visualized by the badge.

@mikaelbr mikaelbr merged commit 0704106 into mikaelbr:master Jan 21, 2021
@styfle styfle deleted the patch-1 branch January 21, 2021 20:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants