module-usage

module-usage

See how a module is used in npm.

Example

var usage = require('module-usage');
var name = process.argv[2] || 'intersect';

usage(name).on('data', function(u) {
  console.log('%s (%s)', u.dependant, u.file);
  console.log();
  console.log(indent(u.code));
  console.log();
});

function indent(txt) {
  return txt.replace(/^/gm, '    ');
}

Some usages of intersect:

$ node example.js intersect
bower-json (lib/util/isComponent.js)

    var intersect = require('intersect');

bower-json (lib/util/isComponent.js)

    common = intersect(keys, [
        'repo',
        'development',
        'local',
        'remotes',
        'paths',
        'demo'
    ]);

roole-prefixer (lib/LinearGradientPrefixer.js)

    var intersect = require('intersect');

roole-prefixer (lib/LinearGradientPrefixer.js)

    var prefixes = intersect(this.prefixes, [
        'webkit',
        'moz',
        'o'
    ]);

...

Some usages of mkdirp:

$ node example.js mkdirp
ae86 (lib/engine.js)

    var mkdirp = require('mkdirp');

ae86 (lib/engine.js)

    mkdirp(p.join(dir, page).replace(/(\/[^\/]+$|\\[^\\]+$)/, ''), '0755', function (err) {
        'callback...';
    });
    
amerigo (vespucci.js)

    var mkdirpSync = require('mkdirp').sync;

amerigo (vespucci.js)

    mkdirpSync(folderpath);

amerigo (pvespucci.js)

    mkdirpSync(padpath);

API

usage(name[, opts])

Create a readable stream that emits usage objects with keys

• dependant: The name of the module depending on name
• file: The path of the file where name is used
• code: The line where name is used
• node: The ast node where name is used, generated by esprima

Pass opts.registry to overwrite the default npm registry location.

CLI

$ npm install -g module-usage
$ module-usage intersect

Installation

$ npm install module-usage

License

MIT