Skip to content

Latest commit

 

History

History
66 lines (43 loc) · 1.41 KB

.verb.md

File metadata and controls

66 lines (43 loc) · 1.41 KB

{%= name %} {%= badge("fury") %}

{%= description %}

What does it do!?

Builds a recursive tree of all dependencies currently installed in node_modules. Allows you to easily get information from the package.json of any locally installed module.

Examples:

Get the version of the specified dependency:

deps.get('markdown-utils', 'version');
//=> '0.1.0'

Use glob patterns to get the specified property from every dependency:

deps.get('*', 'homepage')

// returns an object like this:
{ globby: 'https://github.com/sindresorhus/globby',
 'is-relative': 'https://github.com/jonschlinkert/is-relative',
 'is-absolute': 'https://github.com/jonschlinkert/is-absolute', ...}

If an object is returned with null values, this means that the package wasn't found at the given path. e.g. it was symlinked by npm.

To get around this, you can pass {findup: true} to the constructor and [findup-sync] will be used to find the nearest match. This is disabled by default since this is an exception to the rule and it considerably slows down searches.

Install

{%= include("install") %}

Run tests

npm test

Usage

var Deps = require('{%= name %}');
var deps = new Deps();

API

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

Author

{%= include("author") %}

License

{%= copyright({year: 2014}) %} {%= license() %}


{%= include("footer") %}

{%= reflinks() %}