Command line package

[Siilwyn]

💭 what do you think of creating a packagephobia CLI tool? Maybe it's possible to re-use core logic that checks the size for a server.

[styfle]

Hi Selwyn,

Thanks for your interest in Package Phobia!

I have pondered the idea of a CLI tool myself but there are several ways it could be implemented.

What is your goal here? Do you want to use this CLI tool...

• as a package author checking the size of a new dependency before you add it?
• as a package author checking a new version of an existing dependency before bumping?
• as a package author checking the size of your own source code before you publish to npm?
• something else?

[Siilwyn]

Hi there @styfle,

my goal would be to run the CLI from a CI service to check the size of my own source code + node modules for pull requests. So when people add new dependencies in a PR I can check the size before merging.

[styfle]

Do you want this to be a function that would fail npm test (travis for example), or do you want it to run as a service to use with GitHub Checks like Bundle Size?

[Siilwyn]

I think both are great, though the first one is simpler to build I think.

[styfle]

Ok, and my guess is that you want to take into account .npmignore so that those files/folders are ignored when checking the size?

For example, most people do not publish their tests folder to npm because consumers do not need it, so you likely do not want to check the size of that folder, correct?

[Siilwyn]

Sorry about the late reply, I was thinking of creating a PR but have to find some time first with all kinds of other projects. ^^

I would indeed ignore the files in .npmignore and only include the files in the array of package.json files key. The purpose for me would be to test the file size of the npm package on every commit.

[jimmywarting]

i would like to be able to upload a package.json as a file or url
everything is not a npm package and some are private

[styfle]

@jimmywarting Agreed. There is a feature request here: #133

[egoist]

https://github.com/egoist/npm-size

npm-size could probably suit your needs, I can add a --size-limit <size> flag for your use case.

[egoist]

--limit flag is available now

[styfle]

Closing this issue since npm-size . --limit 3mb solves this use case.

Another solution is to run npm pack and measure the size of the resulting tarball.

Also see CLI tools listed in the How is this different? section of the readme.