# adopter

> Auditing tool for tracking packages and modules usage, for increasing adoption of libraries

Latest version **0.10.2** (published 2021-12-08) · MIT license · 0 weekly downloads

## Install

```sh
npm install adopter
pnpm add adopter
yarn add adopter
bun add adopter
```

Provides the command `adopter`.

## Health

**Score 45/100 (D)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high maintenance score; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.10.2 |
| Published | 2021-12-08 |
| First published | 2021-09-27 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 8 |
| Unpacked size | 141.1 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Fernando Pasik |
| Maintainers | fernandopasik |
| Keywords | adoption, cli, dependencies, libraries, metrics, modules, packages, report, statistics, stats, usage |

## Links

- npm: https://www.npmjs.com/package/adopter
- Repository: https://github.com/fernandopasik/adopter
- npm.io page: https://npm.io/package/adopter

## Dependencies (8)

- [chalk](https://npm.io/package/chalk.md) ^5.0.0
- [execa](https://npm.io/package/execa.md) ^6.0.0
- [yargs](https://npm.io/package/yargs.md) ^17.3.0
- [globby](https://npm.io/package/globby.md) ^12.0.2
- [loglevel](https://npm.io/package/loglevel.md) ^1.8.0
- [progress](https://npm.io/package/progress.md) ^2.0.3
- [typescript](https://npm.io/package/typescript.md) ^4.5.2
- [chalk-template](https://npm.io/package/chalk-template.md) ^0.2.0

## Alternatives

- [@salesforce/cli](https://npm.io/package/@salesforce/cli.md) — 389.7K weekly downloads
- [@mintlify/cli](https://npm.io/package/@mintlify/cli.md) — 208.9K weekly downloads
- [@grafana/e2e-selectors](https://npm.io/package/@grafana/e2e-selectors.md) — 128.7K weekly downloads
- [mintlify](https://npm.io/package/mintlify.md) — 112.0K weekly downloads
- [@intlayer/cli](https://npm.io/package/@intlayer/cli.md) — 22.8K weekly downloads

## Recent versions

- 0.10.2 (latest) — 2021-12-08
- 0.10.1 — 2021-12-07
- 0.10.0 — 2021-12-07
- 0.9.1 — 2021-10-24
- 0.9.0 — 2021-10-14
- 0.8.1 — 2021-10-14
- 0.8.0 — 2021-10-13
- 0.7.1 — 2021-10-13
- 0.7.0 — 2021-10-12
- 0.6.0 — 2021-10-10
- 0.5.1 — 2021-10-07
- 0.5.0 — 2021-10-07
- 0.4.0 — 2021-10-07
- 0.3.1 — 2021-10-04
- 0.3.0 — 2021-10-04
- … 6 more at https://npm.io/package/adopter/versions

## README

# adopter

Auditing tool for tracking packages and modules usage, for increasing adoption of libraries.

<!-- BADGES - START -->

[![Build Status](https://github.com/fernandopasik/adopter/actions/workflows/main.yml/badge.svg)](https://github.com/fernandopasik/adopter/actions/workflows/main.yml 'Build Status')
[![Known Vulnerabilities](https://snyk.io/test/github/fernandopasik/adopter/badge.svg?targetFile=package.json)](https://snyk.io/test/github/fernandopasik/adopter?targetFile=package.json 'Known Vulnerabilities')
[![npm version](https://img.shields.io/npm/v/adopter.svg?logo=npm)](https://www.npmjs.com/package/adopter 'npm version')

<!-- BADGES - END -->

## Install

Install it globally

```sh
npm install -g adopter
```

Install it locally in the project

```sh
npm install adopter
```

## Usage

Can be run as a client

```sh
adopter [options] package1 [package2] [packageN]
```

or in a node script

```js
import adopter from 'adopter';

adopter({ packages: ['package1', 'package2', 'package3'] });
```

### Options

| option           | description                                           | type    | default               |
| ---------------- | ----------------------------------------------------- | ------- | --------------------- |
| --help           | Show help                                             | boolean |                       |
| --version        | Show version number                                   | boolean |                       |
| --coverage       | Report file coverage                                  | boolean | false                 |
| --debug          | Display debugging information                         | boolean | false                 |
| --rootDir        | Root directory containing files for tracking packages | string  | "."                   |
| --srcIgnoreMatch | Glob patterns to ignore files for tracking packages   | array   | []                    |
| --srcMatch       | Glob patterns to match files for tracking packages    | array   | ["\*\*/\*.[jt]s?(x)"] |

## Audit Information

The tool runs on your codebase and displays two types of reports

- Package and module usage
- File imports coverage

### Package and module usage

This section displays a summary with amount of packages tracked, used and it's usage percentage.
Also displays information on each package:

- If package **is imported** in the codebase
- If the package **is indirectly used** by other packages
- What packages in the list are dependencies of the analyzed package
- What packages in the list are dependents of the analyzed package
- Which **modules are imported** in your codebase
- Which **modules are not imported** in your codebase

### File imports coverage

This section displays a summary with the amount of files tracked and amount of files that import tracked packages.
Also displays the list of files in your codebase and if and which packages and modules are imported on each file.

## License

MIT (c) 2021 [Fernando Pasik](https://fernandopasik.com)

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