Node's Pastoral Musicians

    detective-amd

    4.0.1 • Public • Published

    detective-amd CI npm npm

    Returns a list of dependencies for a given JavaScript file or AST using any of the AMD module syntaxes.

    Inspired by substack/node-detective but built for AMD.

    npm install detective-amd

    Usage

    Let's say we have the following file definitions:

    // a.js
    define(['./b', './c'], function (b, c) {
      console.log(b, c);
    });
    
    // b.js
    define({
      name: 'foo'
    });
    
    // c.js
    define(function () {
      return 'bar';
    });

    Here's how you can grab the list of dependencies of a.js synchronously.

    const fs = require('fs');
    const detective = require('detective-amd');
    
    const srca = fs.readFileSync('a.js', 'utf8');
    
    // Pass in the source code or an AST (if you've already parsed the file)
    console.log(detective(srca)); // prints ['./b', './c']

    You may also (optionally) configure the detective via a second object argument detective(src, options) that supports the following options:

    • skipLazyLoaded: (Boolean) whether or not to omit inner requires in the list of extracted dependencies.
    • Note: this does not affect the REM form since those inner requires are not "lazily" fetched.

    Syntax Support

    Supports the 4 forms of AMD module syntax:

    • "named": define('name', [deps], func)
    • "dependency list": define([deps], func)
    • "factory": define(func(require))
    • "no dependencies": define({})

    Extra forms:

    • "driver script" (or entry-point) syntax: require([deps], func)
    • "REM" (or CommonJS-like) form: define(function(require, exports, module) {}).

    Also handles dynamically loaded dependencies (ex: inner requires).

    Supports driver scripts

    You can also find the dependencies from a script that has a top-level require (an app initialization/driver/entry-point script):

    require([
      './a'
    ], function (a) {
      // My app will get booted up from here
    });

    Expression-based requires

    If there's a require call that doesn't have a string literal but an expression, a string (escodegen-generated) representation will be returned.

    For example, if a.js was of the "factory" form and contained a dynamic module name:

    // a.js
    
    define(function (require) {
      // Assume str is some variable that gets set to a string dynamically
      // const str = ...
    
      const b = require('./' + str);
      const c = require('./c');
    
      console.log(b, c);
    });

    The dependency list will be: [ '\'./\' + str', './c' ]

    • Even though that string representation isn't incredibly useful, it's still added to the list to represent/count that dependency

    Install

    npm i detective-amd

    DownloadsWeekly Downloads

    489,435

    Version

    4.0.1

    License

    MIT

    Unpacked Size

    9.24 kB

    Total Files

    5

    Last publish

    Collaborators

    • pahen
    • xhmikosr
    • mrjoelkemp