module-tree

Create a visual tree of module dependencies using archy. Optionally pass a glob pattern to limit the result to names with that pattern, or a regex to selectively highlight package names.

Please consider following this project's author, Jon Schlinkert, and consider starring the project to show your ❤️ and support.

Install

Install globally with npm

$ npm install --global module-tree

Usage

$ mtree <options>

Results in a tree that looks something like:

module-tree
├─┬ ansi-yellow
│ └── ansi-wrap
├── archy
├─┬ define-property
│ └─┬ is-descriptor
│   ├─┬ is-accessor-descriptor
│   │ └─┬ kind-of
│   │   └── is-buffer
│   ├─┬ is-data-descriptor
│   │ └─┬ kind-of
│   │   └── is-buffer
│   ├─┬ kind-of
│   │ └── is-buffer
│   └── lazy-cache
...

CLI options

• --version | -v: show versions next to package names (like npm's output when installing modules)
• --pattern | -p: glob pattern to pass to glob-object for filtering packages by name. Visit glob-object for usage instructions and available options.
• --color | -c: Add or remove color.

--version

Show versions next to package names.

$ mtree -v

Results in something like:

--color

Remove color

$ mtree --color=false
# or 
$ mtree -c=false

Add color

Only apply coloring to packages that match the given regex pattern (make sure to wrap your pattern in quotes to ensure it's properly converted to regex):

# apply coloring to package names that begin with "is-" 
$ mtree -c="is-.*"

Results in something like:

Example

When run in this project, the following command:

# remove color, filter package name "get-value" 
$ mtree -c=false -p="**.get-value"

Results in:

{ label: 'module-tree',
  nodes:
   [ { label: 'glob-object',
       nodes: [ { label: 'get-value', nodes: [] } ] },
     { label: 'normalize-pkg',
       nodes:
        [ { label: 'map-schema',
            nodes:
             [ { label: 'get-value', nodes: [] },
               { label: 'union-value',
                 nodes: [ { label: 'get-value', nodes: [] } ] } ] } ] } ] }

Which renders to:

module-tree
├─┬ glob-object
│ └── get-value
└─┬ normalize-pkg
  └─┬ map-schema
    ├── get-value
    └─┬ union-value
      └── get-value

API

The top level export is a function that will build a tree from the current project's package.json:

var pkgTree = require('module-tree');
console.log(pkgTree());

Additionally, the following methods are exposed.

.buildTree

Build an object, where dependencies represented properties and keys are module names.

Params

• pattern {Object}: Glob pattern to pass to micromatch for filtering packages (stringify-keys converts the object to an array of object paths, which is then filtered by micromatch)
• options {Object}
• returns {Object}

Example

{
  'union-value': {
    'get-value': {
      pkg: [object] // package.json contents
    }
  }
}

.buildNodes

Build an object that can be passed to archy, where dependencies are represented as nodes, and the name of each package is used as the label.

Params

• tree {Object}
• options {Object}
• returns {Object}

Example

// results in an object like this
{ label: 'union-value',
  nodes: [ { label: 'get-value', nodes: [] } ] }

Build a tree from module dependencies using archy.

Params

• pattern {Object}: Glob pattern to pass to micromatch for filtering packages (stringify-keys converts the object to an array of object paths, which is then filtered by micromatch)
• options {Object}
• returns {Object}

About

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Running Tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Related projects

You might also be interested in these projects:

normalize-pkg: Normalize values in package.json using the map-schema library. | homepage

Contributors

Commits	Contributor
14	jonschlinkert
4	akileez

Author

Jon Schlinkert

• linkedin/in/jonschlinkert
• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2018, Jon Schlinkert. Released under the MIT License.

---

This file was generated by verb-generate-readme, v0.6.0, on January 17, 2018.