@speedy-js/depcost/README.md

[](https://npm.im/@speedy-js/depcost)

# @speedy-js/depcost

[![npm version](https://badgen.net/npm/v/@speedy-js/depcost)](https://npm.im/@speedy-js/depcost)

Retrieve the time and space cost of a dependency, previously [depcost](https://github.com/ulivz/depcost).

<p align="center">
  <img width="600" src="https://github.com/rich-lab/depcost/blob/master/assets/example.png?raw=true" alt="logo"><br />
  <small><i>e.g. retrieve the time & space cost of latest 5 versions of <code>fs-extra</code>.</i></small>
</p>

## Introduction

**depcost** (abbr. **dc**) is a cli tool for you to judge whether a node module deserve your favor via knowing the time and space cost of a dependency.

## Features

- With **Require time**, you will know if the dependency you are using now is likely to **slow down** your node application.
- With **Install size** of a dependency, you will know if the dependency is too cumbersome and **wastes your disk.**
- Quickly specify the latest released versions.

## Usages

- Choose between two packages with similar functions:

![](./assets/comparison.png)

## Install

```bash
npm install @speedy-js/depcost/depcost -g
```

## Usage

Using `depcost` or its shortcut `dc`:

```bash
Usage:
  $ depcost [...pkgs]

For more info, run any command with the `--help` flag:
  $ depcost --help

Options:
  -t, --track                             Whether to keep temp directory.
  -r, --latest-versions <latestVersions>  Specify the count of latest versions.
  -s, --versions <versions>               Select specific versions.
  -l, --log-level <logLevel>              log level of npmlog under the hood.
  -n, --npm-client <npmClient>            set npm client, defaults to npm.
  -d, --debug                             Shortcut to set log level to "debug".
  -h, --help                              Display this message
  -v, --version                           Display version number
```

Examples:

```bash
depcost [package]
depcost [package] --log-level=info
depcost [package] --debug
depcost [package@version]
depcost [package1] [package2] [package3]
depcost [package] --latest-versions=3
depcost [package] --versions=1.0.0,2.0.0
```

## Global Config

You can set global options at `~/.depcostrc` with ini syntax. 

e.g., set npmClient to `npm` globally:

```bash
echo 'npmClient=npm' > ~/.depcostrc
```

## License

MIT &copy; [ULIVZ](https://github.com/sponsors/ulivz)