bus-factor v1.0.0-alpha

bus-factor-js

A tool for analysing the bus factor of open-source projects on npm and their dependencies.

For example:

$ npm i -g bus-factor
$ busfactor preact

preact has 1 author(s) and 3 maintainer(s).
Authors:
- Jason Miller <jason@developit.ca>
Maintainers:
- developit <jason@developit.ca>
- lukeed <luke@lukeed.com>
- marvinhagemeister <marvin@marvinhagemeister.de>

Many projects are under-maintained, often for want of funding. This tool is intended to help identify those projects in order to organize labor and materials to support them.

Install

Use npm:

$ npm i -g bus-factor
$ busfactor -h

busfactor <project> [options]

...

Usage

$ busfactor --help

busfactor <project>

Tool for analysing the bus factor of projects and their dependencies.

Positionals:
  project  Name of the project on NPM.                                  [string]

Options:
  --registry, -r   URL to the NPM registry to use.
                                  [default: "https://skimdb.npmjs.com/registry"]
  --json, -j       Output analysis as JSON. Useful for aggregation.
                                                                [default: false]
  --recursive, -R  Analyse project dependencies too.            [default: false]
  -h, --help       Show help                                           [boolean]
  -v, --version    Show version number                                 [boolean]

Development

To work on the source code, download it with git and build it with Node.js:

$ git clone https://github.com/garbados/bus-factor-js
$ cd bus-factor-js
$ npm install

To run the test suite, use npm test:

$ npm test

Contributions

All contributions are welcome but will be moderated at the discretion of the project's maintainers. This section will update as governance policies emerge and evolve.

To report a bug or request a feature, please file and issue.

To share a patch, please submit a pull request.

License

Apache-2.0