An open API service indexing awesome lists of open source software.

https://github.com/ulivz/depcost

Retrieve the time and space cost of a dependency
https://github.com/ulivz/depcost

dependencies nodemodule performance

Last synced: 3 months ago
JSON representation

Retrieve the time and space cost of a dependency

Awesome Lists containing this project

README

          

# depcost

[![NPM version](https://img.shields.io/npm/v/depcost.svg?style=flat)](https://npmjs.com/package/depcost) [![NPM downloads](https://img.shields.io/npm/dm/depcost.svg?style=flat)](https://npmjs.com/package/depcost) ![Node.js CI](https://github.com/rich-lab/depcost/workflows/Node.js%20CI/badge.svg) [![codecov](https://codecov.io/gh/rich-lab/depcost/branch/master/graph/badge.svg)](https://codecov.io/gh/rich-lab/depcost)


logo

e.g. retrieve the time & space cost of latest 5 versions of fs-extra.

## 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.

## Install

```bash
npm install 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 Specify the count of latest versions.
-s, --versions Select specific versions.
-l, --log-level log level of npmlog under the hood.
-n, --npm-client 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 `tnpm` globally:

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

## Contributing

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

**depcost** © [ULIVZ](https://github.com/ulivz) under [Richlab Team](https://www.yuque.com/richlab/join-us/invitation), Released under the [MIT](./LICENSE) License.