README.md

babel-plugin-module-deps

This Babel plugin redefines require within all (CJS) modules to record any required modules in an array of resolved filenames called module.deps. (Note that the array may have duplicates.) It only works with Node.js CommonJS modules (though with @babel/plugin-transform-modules-commonjs you can still use ESM syntax).

The module.deps arrays let a tool later discover what other modules each module depends on, by inspecting require.cache[filename].deps. This can be useful to deep-reload a module, or to detect when a module should be called according to whether a generated file is older than the module or dependency code. For example, SVG Tiler uses this plugin to determine when to rebuild figures whose symbols are defined by JavaScript or CoffeeScript files.

Usage

Either compile all your code via Babel and run the compiled code, or use @babel/register to automatically run Babel as you require modules.

Add the module as a plugin to your Babel configuration, as in:

{
  "plugins": ["babel-plugin-module-deps"]
}

Generally you want this plugin to run last, so list it last in the "plugins" array. In particular, this plugin should run after @babel/plugin-transform-modules-commonjs (if you're using ESM syntax in CJS), so that require is redefined before imports get executed (as they are simulated by require).

Then you can access the current module's dependencies via module.deps, or an arbitrary module's dependencies via require.cache[filename].deps, where filename is the require.resolved filename for a module.

Recursive Dependencies

If you've just run require(modname), then calling the function below as walkDeps(modname) should give an array of all recursive module dependencies that modname requires or imports as require.resolved filenames (including require.resolve(modname) itself, but excluding duplicates).

function walkDeps(modname) {
  const deps = {};
  function recurse(submodname) {
    deps[submodname] = true;
    const submod = require.cache[submodname];
    if (!submod) return;
    const subdeps = submod.deps;
    if (!subdeps) return;
    for (dep of subdeps)
      if (!dep in deps)
        recurse(dep);
  }
  recurse(require.resolve(modname));
  return Object.keys(deps);
}