dependency-tree

dependency-tree

Get the dependency tree of a module

npm install dependency-tree

Usage

var dependencyTree = require('dependency-tree');

// Returns a dependency tree object for the given file
var tree = dependencyTree({
  filename: 'path/to/a/file',
  root: 'path/to/all/files'
});

// Returns a post-order traversal (list form) of the tree with duplicate sub-trees pruned.
// This is useful for bundling source files, because the list gives the concatenation order.
var list = dependencyTree.toList({
  filename: 'path/to/a/file',
  root: 'path/to/all/files'
});

• Works for JS (AMD, CommonJS, ES6 modules) and CSS preprocessors (Sass, Stylus); basically, any filetype supported by Precinct.
  • For CommonJS modules, 3rd party dependencies (npm installed dependencies) are included in the tree by default
  • Dependency path resolutions are handled by filing-cabinet
• All core Node modules (assert, path, fs, etc) are removed from the dependency list by default

The object form is a mapping of the dependency tree to the filesystem – where every key is an absolute filepath and the value is another object/subtree.

Example:

{
  '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/a.js': {
    '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/b.js': {
      '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/d.js': {},
      '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/e.js': {}
    },
    '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/c.js': {
      '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/f.js': {},
      '/Users/mrjoelkemp/Documents/node-dependency-tree/test/example/extended/g.js': {}
    }
  }
}

This structure was chosen to serve as a visual representation of the dependency tree for use in the Dependents plugin.

Optional

• config: path to a requirejs config for AMD modules (allows for the result of aliased module paths)
• visited: object used for avoiding redundant subtree generations via memoization.

Shell version (assuming npm install -g dependency-tree):

tree --directory=path/to/all/supported/files [--list-form] filename

Prints the dependency tree of the given filename as stringified json (by default).

• You can alternatively print out the list form one element per line using the --list-form option.

Similar packages

Other packages similar to dependency-tree

madge

Madge is a JavaScript library that provides similar functionality to dependency-tree, including generating dependency graphs and detecting circular dependencies. It also offers additional features like visualizing the dependency graph and supporting multiple module formats.

depcheck

Depcheck is a tool that helps you find unused dependencies in your project. While it does not generate a dependency tree, it provides insights into which dependencies are actually being used, which can complement the functionality of dependency-tree.

webpack

Webpack is a module bundler that also provides dependency analysis as part of its bundling process. It can generate dependency graphs and detect circular dependencies, but it is more focused on bundling and optimizing assets for web applications.