https://github.com/hughsk/npm-flat-graph

Given a list of modules, recursively retrieve their dependency graph and generate a flat list of each module's dependencies
https://github.com/hughsk/npm-flat-graph

Last synced: 8 days ago
JSON representation

Given a list of modules, recursively retrieve their dependency graph and generate a flat list of each module's dependencies

• Host: GitHub
• URL: https://github.com/hughsk/npm-flat-graph
• Owner: hughsk
• License: mit
• Created: 2014-03-11T14:13:26.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2014-03-12T02:34:27.000Z (over 10 years ago)
• Last Synced: 2024-10-17T16:41:21.473Z (22 days ago)
• Language: JavaScript
• Size: 113 KB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# npm-flat-graph [![Flattr this!](https://api.flattr.com/button/flattr-badge-large.png)](https://flattr.com/submit/auto?user_id=hughskennedy&url=http://github.com/hughsk/npm-flat-graph&title=npm-flat-graph&description=hughsk/npm-flat-graph%20on%20GitHub&language=en_GB&tags=flattr,github,javascript&category=software)[![experimental](http://hughsk.github.io/stability-badges/dist/experimental.svg)](http://github.com/hughsk/stability-badges) #

Given a list of modules, recursively retrieve their dependency graph and generate a flat list of each module's dependencies.

Useful if you're only concerned with the most recent versions of a dependency

tree, generally for visualisation/analysis.

## Usage ##

[![npm-flat-graph](https://nodei.co/npm/npm-flat-graph.png?mini=true)](https://nodei.co/npm/npm-flat-graph)

### `getGraph(modules, [opts], done)`

This function takes an array of `modules` by name, calling `done(err, results)`

when complete, supplying you with an index formatted like so:

``` javascript

{

  'envify': [ 'xtend', 'through', 'esprima-fb', 'jstransform' ],

  'esprima-fb': [],

  'jstransform': [ 'base62', 'esprima-fb', 'source-map' ],

  'through': [],

  'xtend': [ 'object-keys' ],

  'base62': [],

  'object-keys': [],

  'source-map': [ 'amdefine' ],

  'amdefine': []

}

```

You can also pass the following options:

* `opts.exclude`: an array of module names to not include in the final output.

  Its dependencies won't be resolved either, so is useful for elimating unwanted

  development dependencies and the like.

## License ##

MIT. See [LICENSE.md](http://github.com/hughsk/npm-flat-graph/blob/master/LICENSE.md) for details.