module-deps

Dependency Graph Generation

This feature allows you to generate a JSON file that represents the dependency graph of a given entry file. The code sample demonstrates how to use module-deps to analyze 'entry.js' and output the dependency graph to 'deps.json'.

const mdeps = require('module-deps');
const JSONStream = require('JSONStream');
const fs = require('fs');

const md = mdeps();
md.pipe(JSONStream.stringify()).pipe(fs.createWriteStream('deps.json'));
md.end({ file: 'entry.js' });

Custom Resolvers

This feature allows you to provide custom resolution logic for resolving module paths. The code sample shows how to use a custom resolver function to handle module resolution.

const mdeps = require('module-deps');
const JSONStream = require('JSONStream');
const fs = require('fs');

const md = mdeps({
  resolve: (id, parent, cb) => {
    // Custom resolution logic
    cb(null, id);
  }
});
md.pipe(JSONStream.stringify()).pipe(fs.createWriteStream('deps.json'));
md.end({ file: 'entry.js' });

Transform Streams

This feature allows you to apply transform streams to the source files before they are parsed. The code sample demonstrates how to replace all instances of 'require' with 'customRequire' in the source files.

const mdeps = require('module-deps');
const through = require('through2');
const JSONStream = require('JSONStream');
const fs = require('fs');

const md = mdeps({
  transform: (file) => {
    return through(function (buf, enc, next) {
      this.push(buf.toString('utf8').replace(/require/g, 'customRequire'));
      next();
    });
  }
});
md.pipe(JSONStream.stringify()).pipe(fs.createWriteStream('deps.json'));
md.end({ file: 'entry.js' });