base-npm

base-npm

Base plugin that adds methods for programmatically running npm commands.

You might also be interested in base-bower.

Install

Install with npm:

$ npm install base-npm --save

Usage

var npm = require('base-npm');
var Base = require('base');
var app = new Base();
app.use(npm());

// install npm packages `micromatch` and `is-absolute`
app.npm.saveDev(['micromatch', 'is-absolute'], function(err) {
  if (err) throw err;
});

API

.npm

Execute npm install with the given args, package names and callback.

Params

• args {String|Array}
• names {String|Array}
• cb {Function}: Callback

Example

app.npm('--save', ['isobject'], function(err) {
  if (err) throw err;
});

.npm.install

Install one or more packages. Does not save anything to package.json. Equivalent of npm install foo.

Params

• names {String|Array}: package names
• cb {Function}: Callback

Example

app.npm.install('isobject', function(err) {
  if (err) throw err;
});

.npm.latest

(Re-)install and save the latest version of all dependencies and devDependencies currently listed in package.json.

Params

• cb {Function}: Callback

Example

app.npm.latest(function(err) {
  if (err) throw err;
});

.npm.save

Execute npm install --save with one or more package names. Updates dependencies in package.json.

Params

• names {String|Array}
• cb {Function}: Callback

Example

app.npm.save('micromatch', function(err) {
  if (err) throw err;
});

.npm.saveDev

Execute npm install --save-dev with one or more package names. Updates devDependencies in package.json.

Params

• names {String|Array}
• cb {Function}: Callback

Example

app.npm.saveDev('isobject', function(err) {
  if (err) throw err;
});

.npm.askInstall

Prompts the user to ask if they want to install the given package(s). Requires the base-questions plugin to be registered first.

Params

• names {String|Array}: One or more package names.
• options {Object}
• callback {Function}

Example

app.npm.askInstall('isobject', function(err) {
  if (err) throw err;
});

Related projects

You might also be interested in these projects:

• base-questions: Plugin for base-methods that adds methods for prompting the user and storing the answers on… more | homepage
• base-task: base plugin that provides a very thin wrapper around https://github.com/doowb/composer for adding task methods to… more | homepage
• base: base is the foundation for creating modular, unit testable and highly pluggable node.js applications, starting… more | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

Generate readme and API documentation with verb:

$ npm install verb && npm run docs

Or, if verb is installed globally:

$ verb

Running tests

Install dev dependencies:

$ npm install -d && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2016, Jon Schlinkert. Released under the MIT license.

This file was generated by verb, v0.9.0, on May 19, 2016.