Skip to content

deps

Directory actions

More options

Directory actions

More options

Latest commit

 

History

History
 
 

deps

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
bin
bin
 
 
docs
docs
 
 
etc
etc
 
 
examples
examples
 
 
lib
lib
 
 
test
test
 
 
README.md
README.md
 
 
package.json
package.json
 
 

README.md

Package Dependencies

Resolve package dependencies.

Usage

var pkgDeps = require( '@stdlib/_tools/pkgs/deps' );

pkgDeps( pkgs, [options,] clbk )

Asynchronously resolves package dependencies.

var pkgs = [ 'tape', 'browserify' ];

pkgDeps( pkgs, clbk );

function clbk( error, results ) {
    if ( error ) {
        throw error;
    }
    console.dir( results );
}

Each package is represented by an object having the following fields:

  • pkg: package name, as specified in pkgs.
  • dir: package directory path.
  • files: an array of module dependencies.
  • deps: an array of package dependencies.
  • devDeps: an array of package dev dependencies. Note that this field is only present if options.dev is true.

The function accepts the following options:

  • dir: root directory from which to resolve packages. May be either an absolute path or a path relative to the current working directory.
  • builtins: boolean indicating whether to include built-in package dependencies. Default: false.
  • dev: boolean indicating whether to resolve dev dependencies. Default: false.

By default, the function resolves packages relative to the current working directory. To resolve relative to an alternative directory, set the dir option.

var opts = {
    'dir': '/foo/bar/baz'
};

var pkgs = [ 'tape', 'browserify' ];

pkgDeps( pkgs, opts, clbk );

function clbk( error, results ) {
    if ( error ) {
        throw error;
    }
    console.dir( results );
}

pkgDeps.sync( pkgs[, options] )

Synchronously resolves package dependencies.

var pkgs = [ 'tape', 'browserify' ];

var results = pkgDeps.sync( pkgs );
// returns [...]

The function accepts the same options as pkgDeps() above.

Examples

var resolve = require( 'path' ).resolve;
var pkgDeps = require( '@stdlib/_tools/pkgs/deps' );

var pkg = resolve( __dirname, '../' );
var pkgs = [ pkg, 'tape' ];

var opts = {
    'dev': true
};

pkgDeps( pkgs, opts, clbk );

function clbk( error, results ) {
    if ( error ) {
        throw error;
    }
    console.dir( results );
}

CLI

Usage

Usage: pkg-deps [options] [<pkg> <pkg> <pkg> ...]

Options:

  -h,    --help                Print this message.
  -V,    --version             Print the package version.
         --dir dir             Base directory.
         --builtins            Include built-in package dependencies.
         --dev                 Resolve dev dependencies.
         --split sep           Separator for stdin data. Default: '/\r?\n/'.

Notes

  • If the split separator is a regular expression, ensure that the split option is properly escaped.

    # Not escaped...
$ echo -n $'tape\nbrowserify\n' | pkg-deps --split /\r?\n/

# Escaped...
$ echo -n $'tape\nbrowserify\n' | pkg-deps --split /\\r?\\n/

  • Results are printed to stdout as newline-delimited JSON (NDJSON).

Examples

$ pkg-deps tape browserify
{...}
{...}
$ echo -n $'tape\nbrowserify\n' | pkg-deps --split /\\r?\\n/
{...}
{...}