npm-utils

npm-utils

Async NPM shell commands: install, test, etc.

Use

var npmUtils = require('npm-utils');
npmUtils.version()
  .then(function (semver) {
    console.log('NPM version %s', semver);
  });

API

path() // returns immediately path to npm command

install({
  name: string,
  version: string (optional),
  prefix: string (optional), // folder path prefix
  passThroughData: obj (optional),
  registry: string (optional) // registry url
})

returns a promise

version() // returns a promise, resolved with NPM version string

test() // spawns npm test command
test('grunt test'); // spawns new command "grunt test"

registryUrl(); // returns a promise
// same as `npm config get registry`

Custom message filtering

When running test() command you can pass custom logger object to control how the output and error messages are displayed. For example to filter messages, one can do

var npmUtils = require('npm-utils');
npmUtils.test('lint', {
  stdout: function (x) {
    console.log('LINT OUTPUT:', x);
  },
  stderr: function (x) {
    console.log('LINT ERROR:', x);
  }
});

Small print

Author: Gleb Bahmutov @ 2013 @bahmutov

License: MIT - do anything with the code, but don't blame me if it does not work.

• @bahmutov
• glebbahmutov.com
• blog