collect sustainability data for your npm dependencies
Command Line Program
To run with npx
:
cd your-npm-projectnpx npm-sustainability
To install and use npm-sustainability
globally:
npm install --global npm-sustainabilitycd your-npm-projectnpm-sustainability
To install as a development dependency of your package:
cd your-npm-projectnpm install --save-dev npm-sustainability
For output as newline-delimited JSON objects, for further processing:
cd your-npm-projectnpm-sustainability --ndjson
JavaScript Module
The package exports an asynchronous function of three arguments:
-
A configuration object.
-
The path of the package to check.
-
An error-first callback that yields:
-
an array of objects, one per project
-
an array of URIs that failed to download or validate
-