Package Exports

npm-utils

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (npm-utils) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

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,
  flags: ['--save', '--verbose'] // list of command line flags to pass to NPM
})

returns a promise

Note: the name could be another folder or a tar archive; passed to npm install <name> unchanged, that can be any match. See npm help install

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

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

The child test process will inherit output streams from the parent.

registryUrl(); // returns a promise
// same as `npm config get registry` - which only uses
// .npmrc in the CURRENT folder (if there is .npmrc file)

publish({ tag: '...'});
// the tag is optional

getPackage

Loads package.json from a given folder

var pkg = npm.getPackage(folder);
console.log('%s version %s', pkg.name, pkg.version);

pack

Runs npm pack <folder name> command. Resolves with the name of the generated tarball file.

pack({ folder: 'path/to/folder' })

If folder is not provided, uses the current one

Troubleshooting

Run the command with DEBUG=npm-utils environment variable set, this package uses debug

Small print

Author: Gleb Bahmutov @ 2013 @bahmutov

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