Async NPM shell commands
npm install npm-utilsAsync NPM shell commands: install, test, etc.
[![NPM info][nodei.co]][npm-url]
[![Build][npm-utils-ci-image]][npm-utils-ci-url]
[![dependencies][dependencies-image]][dependencies-url]
[![devDependencies][devDependencies-image]][devDependencies-url]
[![Codacy Badge][codacy-image]][codacy-url]
[![semantic-release][semantic-image] ][semantic-url]
[![next-update-travis badge][badge]][readme]
[![renovate-app badge][renovate-badge]][renovate-app]
[renovate-badge]: https://img.shields.io/badge/renovate-app-blue.svg
[renovate-app]: https://renovateapp.com/
``js`
var npmUtils = require('npm-utils');
npmUtils.version()
.then(function (semver) {
console.log('NPM version %s', semver);
});
`js`
path() // returns immediately path to npm command
`js
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; passednpm install
to unchanged, that can be any match.npm help install
See .
Without name property, it just runs npm install in the current folder.
Clones Git repository for given NPM module and installs dependencies in the
cloned folder.
`js`
repoInstall({
name: string, // NPM module name
folder: string // destination new folder to create
})
Returns a promise
`js`
version() // returns a promise, resolved with NPM version string
`js`
test() // spawns npm test command
test('grunt test'); // spawns new command "grunt test"
The child test process will inherit output streams from the parent.
`js`
registryUrl();
// returns a promise resolved with result of https://github.com/sindresorhus/registry-url
// pass scope for specific registry
registryUrl('@myCo')
.then(url => ...)
`js`
publish({ tag: '...'});
// the tag is optional
Loads package.json from a given folder
`js`
var pkg = npm.getPackage(folder);
console.log('%s version %s', pkg.name, pkg.version);
Runs npm pack command. Resolves with the name of the generated tarball file.
`js`
pack({ folder: 'path/to/folder' })
If folder is not provided, uses the current one
Please execute the npm login first!
`js`
setAuthToken()
.then(canPublishNow, onError)
Updates local .npmrc (if found) or profile ~/.npmrc file that can be used by CI
servers to publish to NPM.
The file will have the following line added (only the actual registry url will be used)
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
Read the [Deploying with npm private modules][deploying post] for details, see
project ci-publish for example how this could be
used to release from CI after successful tests.
[deploying post]: http://blog.npmjs.org/post/118393368555/deploying-with-npm-private-modules
Often the source of errors is that the environment does not have NPM_TOKEN set,.npmrc
or the file already has the authToken entry for this registry. For example,
when running locally
$ NPM_TOKEN=foo node src/set-auth-token.js
npmrc file already has auth token for registry
//registry.npmjs.org/:_authToken=
[Error: Auth token for registry exists //registry.npmjs.org/:_authToken=]
Runs npm version [major | minor | patch | version] command.
`js`
incrementVersion({
increment: 'major|minor|patch|semver version',
noGit: true // default false = Git commit happens
})
// example
incrementVersion({
increment: '2.0.1'
})
See npm help version.
`js`
require('npm-utils').prune().catch(console.error);
// same as "npm prune"
Often the CI needs an auth token for a registry to be able to install private
modules. The CI should have NPM_TOKEN environment variable set, and the.npmrc
next command adds the following to the or ~/.npmrc file
`
//registry.npmjs.org/:_authToken=${NPM_TOKEN}
You can use it like this. From the CI build file (circle.yml, .travis.yml
etc) first install this package, then call the command, and then install
all modules (including the private ones)
`sh`
npm i npm-utils
$(npm bin)/set-auth-token-var-name
npm i
* ggit - Git utils
Run the command with DEBUG=npm-utils` environment variable set, this package
uses debug
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
[nodei.co]: https://nodei.co/npm/npm-utils.svg?downloads=true
[npm-url]: https://npmjs.org/package/npm-utils
[npm-utils-ci-image]: https://secure.travis-ci.org/bahmutov/npm-utils.svg?branch=master
[npm-utils-ci-url]: https://travis-ci.org/bahmutov/npm-utils
[dependencies-image]: https://david-dm.org/bahmutov/npm-utils.svg
[dependencies-url]: https://david-dm.org/bahmutov/npm-utils
[devDependencies-image]: https://david-dm.org/bahmutov/npm-utils/dev-status.svg
[devDependencies-url]: https://david-dm.org/bahmutov/npm-utils#info=devDependencies
[codacy-image]: https://api.codacy.com/project/badge/grade/80f4a9c1aad545fa8aeb090d66a3a7d2
[codacy-url]: https://www.codacy.com/app/glebbahmutov_2600/npm-utils
[semantic-image]: https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg
[semantic-url]: https://github.com/semantic-release/semantic-release
[badge]: https://img.shields.io/badge/next--update--travis-%E2%9C%94%EF%B8%8F-green.svg
[readme]: https://github.com/bahmutov/next-update-travis#readme