Makes it easy to run locally-installed package executables in a robust manner. Any executable available to an npm lifecycle script is available to npm-run.
Due to npm's install algorithm node_modules/.bin is not guaranteed to contain your executable. npm-run uses the same mechanism npm uses to locate the correct executable.
> npm install -g npm-run> npm install mocha
> npm-run mocha test/*
# uses local mocha executableThe API of npm-run basically wraps child_process methods such that Any executable available to an npm lifecycle script is on the PATH.
Alias of npmRun.exec.
Takes same arguments as node's exec.
npmRun.exec('mocha --debug-brk --sort', {cwd: __dirname + '/tests'}, function(err, stdout, stderr) {
// err Error or null if there was no error
// stdout Buffer|String
// stderr Buffer|String
})Alias of npmRun.execSync
Takes same arguments as node's execSync.
var stdout = npmRun.execSync(
'mocha --debug-brk --sort'
{cwd: __dirname + '/tests'}
)
stdout // command output as Buffer|StringTakes same arguments as node's spawnSync.
var child = npmRun.spawnSync(
'mocha',
'--debug-brk --sort'.split(' '),
{cwd: __dirname + '/tests'}
)
child.stdout // stdout Buffer|String
child.stderr // stderr Buffer|String
child.status // exit codeTakes same arguments as node's spawn.
var child = npmRun.spawn(
'mocha',
'--debug-brk --sort'.split(' '),
{cwd: __dirname + '/tests'}
)
child.stdout // stdout Stream
child.stderr // stderr Stream
child.on('exit', function(code) {
code // exit code
})MIT