Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
JavaScript

This branch is 3 commits ahead, 27 commits behind defunctzombie:master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
bin
test
.gitignore
.travis.yml
README.md
index.js
package.json

README.md

required Build Status

Identifies which modules and files your script is using.

example

var required = require('required');

required('/path/to/entry/source/file/js', function(err, deps) {
    // deps is an array of dependency objects
    // see the api section below for a description of the object
});

api

required(filename, [opt], cb)

Reads the filename and traverses all the dependencies.

The return result to callback is (err, details) where details is and array of dependencies for the file.

Each object in the array takes the following form:

{
    // the local name of the require
    // i.e. the string in your "require" statement
    id: 'local-require-name',

    native: // true if a native module (i.e. events, cryto, etc)

    // full path to the entry file for the module
    // this does not exist for native modules
    filename: '/path/to/require/from/project/file.js',

    // an array of the dependencies for the file
    // each object is of the same form as described above
    deps: [
        ...
    ]
},

opt is an optional options object with the following defaults

{
    // if true, then missing modules will be silently ignored
    // useful if you don't care about some failed requires with native builds
    ignoreMissing: false,

    // if true, include the source contents for each file in the results
    // in a "source" field
    includeSource: false
}

install

npm install required

tests

Run tests with npm test

Rebuild the golden files with npm run-script test-generate

Generate a coverage report (requires cover module) npm run-script coverage

Something went wrong with that request. Please try again.