genDeps - Generate Module Dependencies

Forked and modified from Patrik Henningsson's madge

Generate module dependencies from your CommonJS or AMD module dependencies. Could also be useful for finding circular dependencies in your code. Tested on Node.js and RequireJS projects. Dependencies are calculated using static code analysis. CommonJS dependencies are found using James Halliday's detective and for AMD I'm using some parts copied from James Burke's RequireJS (both are using UglifyJS).

Installation

To install as a library:

$ npm install gendeps

API

var genDeps = require('genDeps');
var dependencyObject = genDeps('./');
console.log(dependencyObject.tree);

genDeps(src, opts)

{Object|Array|String} src (required)

• Object - a dependency tree.
• Array - an Array of directories to scan.
• String - a directory to scan.

{Object} opts (optional)

• {String} format. The module format to expect, 'cjs' or 'amd'. Commonjs (cjs) is the default format.
• {String} exclude. String from which a regex will be constructed for excluding files from the scan.
• {Boolean} breakOnError. True if the parser should stop on parse errors and when modules are missing, false otherwise. Defaults to false.

dependency object (returned from madge)

.opts

Options object passed used in the constructor.

.tree

Dependency tree object. Can be overwritten with an object in the format:

{
     'module1': ['dep1a', 'dep1b'],
     'module2': ['dep2a']
}

.obj()

Alias to the tree property.

.circular()

Returns all the modules with circular dependencies.

.depends()

Returns a list of modules that depends on a given module.

Release Notes

v0.0.1 (Jan 9, 2014)

Initial release.

License

(The MIT License)

Copyright (c) 2014 StuPig Gong <[email protected]> Copyright (c) 2012 Patrik Henningsson <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.