Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/adrieankhisbe/bundle-phobia-cli
📦 Cli for the node BundlePhobia Service 😱
https://github.com/adrieankhisbe/bundle-phobia-cli
bundlephobia cli hacktoberfest npm
Last synced: 1 day ago
JSON representation
📦 Cli for the node BundlePhobia Service 😱
- Host: GitHub
- URL: https://github.com/adrieankhisbe/bundle-phobia-cli
- Owner: AdrieanKhisbe
- License: mit
- Created: 2017-09-12T05:02:22.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-16T09:53:44.000Z (6 months ago)
- Last Synced: 2024-12-14T20:02:36.232Z (8 days ago)
- Topics: bundlephobia, cli, hacktoberfest, npm
- Language: JavaScript
- Homepage:
- Size: 1.06 MB
- Stars: 180
- Watchers: 4
- Forks: 12
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# bundle-phobia-cli
[](https://www.npmjs.com/package/bundle-phobia-cli)
[](https://travis-ci.com/AdrieanKhisbe/bundle-phobia-cli)
[](https://codecov.io/gh/AdrieanKhisbe/bundle-phobia-cli)
[](https://opensource.org/licenses/MIT)
> Cli for the node [BundlePhobia](https://bundlephobia.com/) Service
## About
[BundlePhobia](https://bundlephobia.com/) is a tool to help you _find the cost of adding a npm package to your bundle_.
It enables you to query package sizes.
## Installation
Just use `npm install -g bundle-phobia-cli` and you're good to go!
## Usage
Once installed you will have access to different executables:
- `bundle-phobia`: to query package size.
Just invoke it with a list of package names and some options.
- `bundle-phobia-install`: to conditionally install package if weight constraint are respected. This is a wrapper on `npm install`
Note that you can specify a version along with the package range such as an
instance exact version `[email protected]` or range version `ora@^3.0.0`.
### Examples
```bash
# Query package size of lodash and react
$ bundle-phobia lodash react
ℹ lodash (4.17.11) has 0 dependencies for a weight of 68.51KB (24.05KB gzipped)
ℹ react (16.6.0) has 4 dependencies for a weight of 5.86KB (2.48KB gzipped)
# Perform conditional install of lodash
$ bundle-phobia-install lodash
ℹ Applying a size limit of 100KB
ℹ Proceed to installation of package lodash
+ [email protected]
added 1 package from 2 contributors and audited 1 package in 1.377s
found 0 vulnerabilities
```
### Detailed Usage
#### `bundle-phobia`
Some option are available to control what stats are outputed by `bundle-phobia`.
By default an humain friendly output is provided, otherwise you can have a json output
with the `--json` flag. In case you need just the size (or gzip) in a script, you can
use the `--[gzip]-size` flag.
To control the packages to be queried, you can either provide them as an argument list,
or you can refer a `package.json` file with the `--package` option. This would read the
packages as `dependencies`.
You can also provide a folder to `-p` (including `.`). This would look for `package.json` in that folder.
##### Options Summary
```
Usage: bundle-phobia [other-package-names...]
Options:
--version Show version number [boolean]
--package, -p Provide a package.json to read dependencies [string]
--range, -r Get a range of version (0 for all, 8 by default) [number]
--json, -j Output json rather than a formater string [boolean]
--size, -s Output just the module size [boolean]
--gzip-size, -g Output just the module gzip size [boolean]
--dependencies, -d Output just the number of dependencies [boolean]
--self Output bundle-phobia stats [boolean]
-h, --help Show help [boolean]
```
#### `bundle-phobia-install`
`bundle-phobia-install` offer three kind of flags:
- flags to specify the size constraints
- flags to specify behavior when constraints are not respected
- npm install flags to control it's behavior
To control the size constraint of a single package: `--max-size` and `--max-gzip-size` aliases to `-m` and `-M`.
To control the overall size of dependencies: `--max-overall-size` and `--max-overall-gzip-size` aliases to `-o` and `-O`.
They expect a size argument that can be either a number or a number followed by a `kB`, `mB` unit.
By default if constraint is not respected, install with failed.
If you want to perform anyway with just a warning use the `--warn`/`-w` flag.
If you want to be asked what to do, use the `--interactive`/`-i`.
All other options will be conveyed to `npm`.
Limits can also be configured in the `package.json` by adding a `bundle-phobia` section with a `max-[gzip-]size` key.
```json
{
"name": "bundle-phobia-install-test",
"dependencies": {},
"bundle-phobia": {
"max-size": "12kB",
"max-overall-size": "1MB"
}
}
```
##### Options Summary
```
Usage: bundle-phobia-install [other-package-names...]
Options:
--version Show version number [boolean]
--warn, -w Install despite of negative check but warn about
predicate violation [boolean]
--interactive, -i Ask for override in case of predicate violation [boolean]
--max-size, -m Size threeshold of individual library to install [string]
--max-gzip-size, -M Gzip Size threeshold of individual library to install
[string]
-h, --help Show help [boolean]
```