# npm-sustainability

> collect sustainability data for your npm dependencies

Latest version **1.0.0-beta.1** (published 2019-04-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install npm-sustainability
pnpm add npm-sustainability
yarn add npm-sustainability
bun add npm-sustainability
```

Provides the command `npm-sustainability`.

## Health

**Score 5/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: insecure dependencies; abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0-beta.1 |
| Published | 2019-04-12 |
| First published | 2019-04-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 9 |
| Unpacked size | 71.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Kyle E. Mitchell |
| Maintainers | kemitchell |

## Links

- npm: https://www.npmjs.com/package/npm-sustainability
- Repository: https://github.com/kemitchell/npm-sustainability.js
- Homepage: https://github.com/kemitchell/npm-sustainability.js#readme
- Issues: https://github.com/kemitchell/npm-sustainability.js/issues
- npm.io page: https://npm.io/package/npm-sustainability

## Dependencies (9)

- [docopt](https://npm.io/package/docopt.md) ^0.6.2
- [fs-access](https://npm.io/package/fs-access.md) ^2.0.0
- [run-series](https://npm.io/package/run-series.md) ^1.1.8
- [run-parallel](https://npm.io/package/run-parallel.md) ^1.1.9
- [simple-concat](https://npm.io/package/simple-concat.md) ^1.0.0
- [read-package-tree](https://npm.io/package/read-package-tree.md) ^5.2.2
- [get-sustainability](https://npm.io/package/get-sustainability.md) github:kemitchell/get-sustainability.js
- [json-parse-errback](https://npm.io/package/json-parse-errback.md) ^2.0.1
- [sustainability-schema](https://npm.io/package/sustainability-schema.md) github:kemitchell/sustainability-schema.json

## Recent versions

- 1.0.0-beta.1 (latest) — 2019-04-12

## README

collect sustainability data for your npm dependencies

# Command Line Program

To run with `npx`:

```bash
cd your-npm-project
npx npm-sustainability
```

To install and use `npm-sustainability` globally:

```bash
npm install --global npm-sustainability
cd your-npm-project
npm-sustainability
```

To install as a development dependency of your package:

```bash
cd your-npm-project
npm install --save-dev npm-sustainability
```

For output as newline-delimited JSON objects, for further processing:

```bash
cd your-npm-project
npm-sustainability --ndjson
```

# JavaScript Module

The package exports an asynchronous function of three arguments:

1. A configuration object.

2. The path of the package to check.

3. An error-first callback that yields:

   - an array of objects, one per project

   - an array of URIs that failed to download or validate

---
_Source: https://npm.io/package/npm-sustainability · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._