1.0.0 • Published 4 years ago

deps v1.0.0

Weekly downloads
416
License
MIT
Repository
github
Last release
4 years ago

📦 deps

Try it out!

$ npx deps [...command]

eg. npx deps npm run build

:rocket: Install

Install globally if you don't want to use it via npx.

npm i -g deps

Usage

🔬 Quick analysis

Prefix your Node command with deps and it will analyze and output the dependencies it used

$ deps ...

eg. deps npm run build

👩‍🔬 Analyzing dependency usage across commands

Prerequisite: install deps globally 1. Start recording dependecy usage (note the dot-space at the beginning)

$ . deps-start
  1. Run a series of Node scripts eg.
  • npm run dev
  • npm run build
  • npm run lint
  • etc.
  1. Analyze used dependencies
    $ deps analyze
  • Save data to file:
    deps analyze -o output.json
  • Read later with:
    deps -f output.json
  1. When you're done, stop recording
    $ . deps-stop

💁‍♂️ FAQ

How does it work?

deps detects which modules are loaded by using V8's code coverage 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 it compare to 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" for supporting whether a module was loaded via dev-tools.

💼 License

MIT