superspawn

A Node.js spawn command that works on Windows too.

Original source from Apache Cordova's superspawn.js by Andrew Grieve. Requires Node.js 0.10+.

Windows extras

• Sets '/c' flag so files other than .exe can be run. Supported: .exe, .cmd, .bat, .js, .vbs
• Sets '/s' flags so commands (and paths) containing spaces or quotes are parsed correctly.

See this Node bug.

Install

1npm i --save superspawn

Usage

Superspawn uses the same signature as the native child_process.spawn. But instead of a reference to the child process it returns a Q.promise or undefined if a callback is passed.

API

1var spawn = require('superspawn').spawn
2
3/**
4 * A windows-compatible spawn method. Succeeds for child exit code === 0.
5 * @param {string} cmd
6 * @param {string[]} [args]
7 * @param {opts} [opts]
8 * @param {function} [callback] - standard Node callback, omit if you want to use a promise.
9 * @returns {Q.promise|undefined} - returns a promise or undefined if a callback is passed.
10 *
11 * @typedef {Object} opts
12 * @property {boolean} [printCommand=false] - Whether to log the command
13 * @property {string} stdio -
14 *     'default' is to capture output and returning it as a string to success (same as exec).
15 *     'ignore' means don't bother capturing it.
16 *     'inherit' means pipe the input & output. This is required for anything that prompts.
17 * @property {object} env - Map of extra environment variables.
18 * @property {string} cwd - Working directory for the command.
19 */
20spawn(cmd, args, opts, function(err, output) {
21    if (err) return err;
22});
23
24// or
25
26spawn(cmd, args, opts)
27    .catch(function(err) {}) // rejectedHandler
28    .then(function(stdout) {}) // resolvedHandler
29;

Examples

1spawn('echo', ['buffalo'], function(err, output) {
2    if (err) return err;
3    assert.equal(output, 'buffalo');
4});
5
6spawn('./script.sh', 'inherit', function(err) {
7    if (err) return err;
8});

Todo

• Write tests