Skip to content

Latest commit

 

History

History
67 lines (46 loc) · 1.6 KB

.verb.md

File metadata and controls

67 lines (46 loc) · 1.6 KB

Usage

Similar in concept to matchdep and load-grunt-tasks, but returns an array of fully resolved file paths to any local modules or npm modules listed in package.json dependencies.

var resolve = require('resolve-dep');
resolve( patterns, options )

API

{%= apidocs('index.js') %}

patterns

Type: string|array

The file path, glob pattern, or name of the npm module to resolve.

File paths

resolve('templates/*.hbs')
resolve(['a/*.hbs', 'b/*.hbs'])

NPM modules

resolve('*')
resolve(['grunt-*', 'gulp-*'])
resolve(['grunt-*', 'gulp-*'], {type: 'devDependencies'})
resolve(['lodash', 'assemble']);

Options

Type: object

The options object supports any globby options, as well as the following:

options.config

Type: Object Default value: package.json

Pass an explicit config object to use instead of package.json.

options.type

Type: String|Array

Default value: all

Valid values: all|dependencies|devDepencies|peerDependencies

Any valid npm dependency field that can be used in package.json is a valid value for this option.

Examples:

// resolve chai and mocha, if in devDependencies, otherwise an empty array
resolve(['chai', 'mocha'], {type: 'devDependencies'});
// resolve lodash if in dependencies, otherwise an empty array
resolve(['lodash'], {type: 'dependencies'});
// all dependencies
resolve(['*'], {type: 'dependencies'});
// all dependencies, devDependencies and peerDependencies
resolve('*');