Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/privatenumber/deps
📦🔍 Analyze which package.json dependencies are in-use with V8 Coverage 🔥
https://github.com/privatenumber/deps
coverage dependencies nodejs v8
Last synced: 3 months ago
JSON representation
📦🔍 Analyze which package.json dependencies are in-use with V8 Coverage 🔥
- Host: GitHub
- URL: https://github.com/privatenumber/deps
- Owner: privatenumber
- License: mit
- Created: 2020-05-12T03:38:52.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2021-04-05T17:06:22.000Z (almost 4 years ago)
- Last Synced: 2024-10-19T01:10:53.715Z (4 months ago)
- Topics: coverage, dependencies, nodejs, v8
- Language: TypeScript
- Homepage:
- Size: 349 KB
- Stars: 34
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# 📦🔍 deps 
Analyze which package.json dependencies are in-use with V8 Coverage 🔥
## 🙋 Why?
- 🧹 **Tidy `package.json`** Find out which dependencies are used/unused
- 🔥 **V8 Coverage** Uses [Node's Coverage feature](https://nodejs.org/api/cli.html#cli_node_v8_coverage_dir) to accurately identify which modules are loaded
- 💅 **Pretty output** View the results in a readable table. Save the output in JSON to view later
- 🚀 **Ready-to-go** Designed to be easy to use with `npx`—No installation required!
#### 👉 Try it out!
```sh
$ npx deps [...Node command]
```
_eg._ `npx deps npm run build`
## :rocket: Install
Install globally if you don't want to use it via [npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner).
```sh
npm i -g deps
```
## Usage
### 🔬 Quick analysis
Prefix your Node command with `deps` and it will analyze and output the dependencies it used
```sh
$ deps ...
```
eg. `deps npm run build`
### 👩🔬 Analyzing dependency usage across commands
_Prerequisite: install `deps` globally_
1. Start recording dependecy usage (note the [dot-space](https://superuser.com/questions/1136409/what-is-the-dot-space-filename-command-doing-in-bash) at the beginning)
```sh
$ . deps-start
```
2. Run a series of Node scripts eg.
- `npm run dev`
- `npm run build`
- `npm run lint`
- etc.
3. Analyze used dependencies
```sh
$ deps analyze
```
- Save data to file:
```sh
deps analyze -o output.json
```
- Read later with:
```sh
deps -f output.json
```
4. When you're done, stop recording
```sh
$ . deps-stop
```
## 💁♂️ FAQ
#### How does `deps` work?
`deps` detects which modules are loaded by using [V8's code coverage](https://nodejs.org/api/cli.html#cli_node_v8_coverage_dir) feature, so it's very accurate. However, it doesn't detect file-system reads, as they are simply read as text rather than actually being parsed and executed. That means it can't detect what files are statically analyzed by bundlers (eg. Webpack, Rollup, etc.). I am considering supporting FS reads in the future.
#### How does `deps` compare to `depcheck`?
[`depcheck`](https://github.com/depcheck/depcheck) statically analyzes your project to see which dependencies are imported, avoiding the need to execute code. In contrast, `deps` executes code to analyze which dependencies were loaded during run-time. They work in completely different ways, but a major drawback for me is that `depcheck` requires a ["special"](https://github.com/depcheck/depcheck#special) for supporting whether a module was loaded via dev-tools.
## 💼 License
MIT