Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/fernandopasik/adopter
📈 Auditing tool for tracking packages and modules usage, for increasing adoption of libraries
https://github.com/fernandopasik/adopter
adoption cli dependencies libraries metrics modules packages report statistics stats usage
Last synced: about 2 months ago
JSON representation
📈 Auditing tool for tracking packages and modules usage, for increasing adoption of libraries
- Host: GitHub
- URL: https://github.com/fernandopasik/adopter
- Owner: fernandopasik
- License: mit
- Created: 2021-09-02T23:39:01.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-19T15:48:10.000Z (about 2 months ago)
- Last Synced: 2024-11-19T16:47:28.095Z (about 2 months ago)
- Topics: adoption, cli, dependencies, libraries, metrics, modules, packages, report, statistics, stats, usage
- Language: TypeScript
- Homepage:
- Size: 3.35 MB
- Stars: 3
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# adopter
Auditing tool for tracking packages and modules usage, for increasing adoption of libraries.
[](https://github.com/fernandopasik/adopter/actions/workflows/main.yml 'Build Status')
[](https://codecov.io/gh/fernandopasik/adopter 'Coverage Status')
[](https://snyk.io/test/github/fernandopasik/adopter?targetFile=package.json 'Known Vulnerabilities')
[](https://www.npmjs.com/package/adopter 'npm version')
## 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)