concurrently 3.4.0 → 3.5.0

package/README.md

@@ -59,9 +59,10 @@ Options:
   -h, --help                       output usage information
   -V, --version                    output the version number
   -k, --kill-others                kill other processes if one exits or dies
+  --kill-others-on-fail            kill other processes if one exits with non zero status code
   --no-color                       disable colors from logging
   -p, --prefix <prefix>            prefix used in logging for each process.
-  Possible values: index, pid, time, command, name, none, or a template. Default: index. Example template: "{time}-{pid}"
+  Possible values: index, pid, time, command, name, none, or a template. Default: index or name (when --names is set). Example template: "{time}-{pid}"
 
   -n, --names <names>              List of custom names to be used in prefix template.
   Example names: "main,browser,server"
@@ -85,12 +86,21 @@ Options:
   The option can be used to shorten long commands.
   Works only if prefix is set to "command". Default: 10
 
+  --allow-restart                  Restart a process which died. Default: false
+
+  --restart-after <miliseconds>    delay time to respawn the process. Default: 0
+  
+  --restart-tries <times>          limit the number of respawn tries. Default: 1
 
 Examples:
 
  - Kill other processes if one exits or dies
 
      $ concurrently --kill-others "grunt watch" "http-server"
+     
+ - Kill other processes if one exits with non zero status code
+
+     $ concurrently --kill-others-on-fail "npm run build:client" "npm run build:server"
 
  - Output nothing more than stdout+stderr of child processes
 
@@ -106,7 +116,7 @@ Examples:
 
  - Custom names and colored prefixes
 
-     $ concurrently --prefix "[{name}]" --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold" "npm run watch" "http-server"
+     $ concurrently --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold" "http-server" "npm run watch"
 
 For more details, visit https://github.com/kimmobrunfeldt/concurrently
 ```
@@ -137,17 +147,3 @@ and you won't even notice the difference.
 
 Another option would be to just run all commands in separate terminals. I got
 tired of opening terminals and made **concurrently**.
-
-### NPM Issue
-
-Previously I thought this could fix some problems I had with watching scripts and this readme said:
-
-> When running watch or serve tasks, I'd recommend to use `--kill-others` option:
->
-> ```bash
-> concurrently --kill-others "npm run watch-js" "npm run watch-less"
-> ```
->
-> That way, if for some reason e.g. your `watch-less` died, you would notice it easier.
-
-However NPM didn't work as I hoped it would. See [this issue](https://github.com/kimmobrunfeldt/concurrently/issues/4).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "concurrently",
-  "version": "3.4.0",
+  "version": "3.5.0",
   "description": "Run commands concurrently",
   "main": "src/main.js",
   "bin": {

package/src/main.js

@@ -24,7 +24,7 @@ var config = {
 
     // Prefix logging with pid
     // Possible values: 'pid', 'none', 'time', 'command', 'index', 'name'
-    prefix: 'index',
+    prefix: '',
 
     // List of custom names to be used in prefix template
     names: '',
@@ -46,7 +46,16 @@ var config = {
     color: true,
 
     // If true, the output will only be raw output of processes, nothing more
-    raw: false
+    raw: false,
+
+    // If true, the process restart when it exited with status code non-zero
+    allowRestart: false,
+
+    // By default, restart instantly
+    restartAfter: 0,
+
+    // By default, restart once
+    restartTries: 1
 };
 
 function main() {
@@ -58,6 +67,8 @@ function main() {
 
     parseArgs();
     config = mergeDefaultsWithArgs(config);
+    applyDynamicDefaults(config)
+
     run(program.args);
 }
 
@@ -81,7 +92,7 @@ function parseArgs() {
             '-p, --prefix <prefix>',
             'prefix used in logging for each process.\n' +
             'Possible values: index, pid, time, command, name, none, or a template. Default: ' +
-            config.prefix + '. Example template: "{time}-{pid}"\n'
+            'index or name (when --names is set). Example template: "{time}-{pid}"\n'
         )
         .option(
             '-n, --names <names>',
@@ -126,6 +137,21 @@ function parseArgs() {
             'The option can be used to shorten long commands.\n' +
             'Works only if prefix is set to "command". Default: ' +
             config.prefixLength + '\n'
+        )
+        .option(
+            '--allow-restart',
+            'Restart a process which died. Default: ' +
+            config.allowRestart + '\n'
+        )
+        .option(
+            '--restart-after <miliseconds>',
+            'delay time to respawn the process. Default: ' +
+            config.restartAfter + '\n'
+        )
+        .option(
+            '--restart-tries <times>',
+            'limit the number of respawn tries. Default: ' +
+            config.restartTries + '\n'
         );
 
     program.on('--help', function() {
@@ -154,7 +180,7 @@ function parseArgs() {
             '',
             '   - Custom names and colored prefixes',
             '',
-            '       $ concurrently --prefix "[{name}]" --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold" "npm run watch" "http-server"',
+            '       $ concurrently --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold" "http-server" "npm run watch"',
             ''
         ];
         console.log(help.join('\n'));
@@ -172,6 +198,12 @@ function mergeDefaultsWithArgs(config) {
     return _.merge(config, program);
 }
 
+function applyDynamicDefaults(config) {
+    if (!config.prefix) {
+        config.prefix = config.names ? 'name' : 'index';
+    }
+}
+
 function stripCmdQuotes(cmd) {
     // Removes the quotes surrounding a command.
     if (cmd[0] === '"' || cmd[0] === '\'') {
@@ -198,14 +230,7 @@ function run(commands) {
           spawnOpts.env = Object.assign({FORCE_COLOR: supportsColor.level}, process.env)
         }
 
-        var child;
-        try {
-            child = spawn(cmd, spawnOpts);
-        } catch (e) {
-            logError('', chalk.gray.dim, 'Error occured when executing command: ' + cmd);
-            logError('', chalk.gray.dim, e.stack);
-            process.exit(1);
-        }
+        var child = spawnChild(cmd, spawnOpts);
 
         if (index < prefixColors.length) {
             var prefixColorPath = prefixColors[index];
@@ -217,13 +242,41 @@ function run(commands) {
             command: cmd,
             index: index,
             name: name,
+            options: spawnOpts,
+            restartTries: config.restartTries,
             prefixColor: lastPrefixColor
         };
         return child;
     });
 
+    var streams = toStreams(children);
+
+    handleChildEvents(streams, children, childrenInfo);
+
+    ['SIGINT', 'SIGTERM'].forEach(function(signal) {
+      process.on(signal, function() {
+        children.forEach(function(child) {
+          treeKill(child.pid, signal);
+        });
+      });
+    });
+}
+
+function spawnChild(cmd, options) {
+    var child;
+    try {
+        child = spawn(cmd, options);
+    } catch (e) {
+        logError('', chalk.gray.dim, 'Error occured when executing command: ' + cmd);
+        logError('', chalk.gray.dim, e.stack);
+        process.exit(1);
+    }
+    return child;
+}
+
+function toStreams(children) {
     // Transform all process events to rx streams
-    var streams = _.map(children, function(child) {
+    return _.map(children, function(child) {
         var childStreams = {
             error: Rx.Node.fromEvent(child, 'error'),
             close: Rx.Node.fromEvent(child, 'close')
@@ -241,21 +294,15 @@ function run(commands) {
             return memo;
         }, {});
     });
+}
 
+function handleChildEvents(streams, children, childrenInfo) {
     handleClose(streams, children, childrenInfo);
     handleError(streams, childrenInfo);
     if (!config.raw) {
         handleOutput(streams, childrenInfo, 'stdout');
         handleOutput(streams, childrenInfo, 'stderr');
     }
-
-    ['SIGINT', 'SIGTERM'].forEach(function(signal) {
-      process.on(signal, function() {
-        children.forEach(function(child) {
-          treeKill(child.pid, signal);
-        });
-      });
-    });
 }
 
 function handleOutput(streams, childrenInfo, source) {
@@ -283,14 +330,20 @@ function handleClose(streams, children, childrenInfo) {
         exitCodes.push(exitCode);
 
         var prefix = getPrefix(childrenInfo, event.child);
-        var prefixColor = childrenInfo[event.child.pid].prefixColor;
-        var command = childrenInfo[event.child.pid].command;
+        var childInfo = childrenInfo[event.child.pid];
+        var prefixColor = childInfo.prefixColor;
+        var command = childInfo.command;
         logEvent(prefix, prefixColor, command + ' exited with code ' + exitCode);
 
         aliveChildren = _.filter(aliveChildren, function(child) {
             return child.pid !== event.child.pid;
         });
 
+        if (nonSuccess && config.allowRestart && childInfo.restartTries--) {
+            respawnChild(event, childrenInfo);
+            return;
+        }
+
         if (aliveChildren.length === 0) {
             exit(exitCodes);
         }
@@ -306,6 +359,23 @@ function handleClose(streams, children, childrenInfo) {
     });
 }
 
+function respawnChild(event, childrenInfo) {
+    setTimeout(function() {
+        var childInfo = childrenInfo[event.child.pid];
+        var prefix = getPrefix(childrenInfo, event.child);
+        var prefixColor = childInfo.prefixColor;
+        logEvent(prefix, prefixColor, childInfo.command + ' restarted');
+        var newChild = spawnChild(childInfo.command, childInfo.options);
+
+        childrenInfo[newChild.pid] = childrenInfo[event.child.pid];
+        delete childrenInfo[event.child.pid];
+
+        var children = [newChild];
+        var streams = toStreams(children);
+        handleChildEvents(streams, children, childrenInfo);
+    }, config.restartAfter);
+}
+
 function killOtherProcesses(processes) {
     logEvent('--> ', chalk.gray.dim, 'Sending SIGTERM to other processes..');
 

package/test/test-functional.js

@@ -5,8 +5,8 @@ var assert = require('assert');
 var run = require('./utils').run;
 var IS_WINDOWS = /^win/.test(process.platform);
 
-// If true, output of commands are shown
-var DEBUG_TESTS = process.env.DEBUG_TESTS === 'true';
+// Note: Set the DEBUG_TESTS environment variable to `true` to see output of test commands.
+
 var TEST_DIR = 'dir/';
 
 // Abs path to test directory
@@ -17,7 +17,7 @@ describe('concurrently', function() {
     this.timeout(5000);
 
     it('help should be successful', () => {
-        return run('node ./src/main.js --help', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js --help')
             .then(function(exitCode) {
                 // exit code 0 means success
                 assert.strictEqual(exitCode, 0);
@@ -25,35 +25,35 @@ describe('concurrently', function() {
     });
 
     it('version should be successful', () => {
-        return run('node ./src/main.js -V', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js -V')
             .then(function(exitCode) {
                 assert.strictEqual(exitCode, 0);
             });
     });
 
     it('two successful commands should exit 0', () => {
-        return run('node ./src/main.js "echo test" "echo test"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js "echo test" "echo test"')
             .then(function(exitCode) {
                 assert.strictEqual(exitCode, 0);
             });
     });
 
     it('at least one unsuccessful commands should exit non-zero', () => {
-        return run('node ./src/main.js "echo test" "nosuchcmd" "echo test"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js "echo test" "nosuchcmd" "echo test"')
             .then(function(exitCode) {
                 assert.notStrictEqual(exitCode, 0);
             });
     });
 
     it('--kill-others should kill other commands if one dies', () => {
-        return run('node ./src/main.js --kill-others "sleep 1" "echo test" "sleep 0.1 && nosuchcmd"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js --kill-others "sleep 1" "echo test" "sleep 0.1 && nosuchcmd"')
             .then(function(exitCode) {
                 assert.notStrictEqual(exitCode, 0);
             });
     });
 
     it('--kill-others-on-fail should kill other commands if one exits with non-zero status code', () => {
-        return run('node ./src/main.js --kill-others-on-fail "sleep 1" "exit 1" "sleep 1"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js --kill-others-on-fail "sleep 1" "exit 1" "sleep 1"')
             .then(function(exitCode) {
                 assert.notStrictEqual(exitCode, 0);
             });
@@ -65,27 +65,15 @@ describe('concurrently', function() {
         var sigtermInOutput = false;
 
         run('node ./src/main.js --kill-others-on-fail "echo killTest1" "echo killTest2" "echo killTest3"', {
-            pipe: false,
-            callback: function(child) {
-                var rl = readline.createInterface({
-                  input: child.stdout,
-                  output: null
-                });
-
-                rl.on('line', function(line) {
-                    if (DEBUG_TESTS) {
-                        console.log(line);
-                    }
-
-                    if (/SIGTERM/.test(line)) {
-                        sigtermInOutput = true;
-                    }
-
-                    // waiting for exits
-                    if (/killTest\d$/.test(line)) {
-                        exits++;
-                    }
-                });
+            onOutputLine: function(line) {
+                if (/SIGTERM/.test(line)) {
+                    sigtermInOutput = true;
+                }
+
+                // waiting for exits
+                if (/killTest\d$/.test(line)) {
+                    exits++;
+                }
             }
         }).then(function() {
             if(sigtermInOutput) {
@@ -99,7 +87,7 @@ describe('concurrently', function() {
     });
 
     it('--success=first should return first exit code', () => {
-        return run('node ./src/main.js -k --success first "echo test" "sleep 0.1 && nosuchcmd"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js -k --success first "echo test" "sleep 0.1 && nosuchcmd"')
             // When killed, sleep returns null exit code
             .then(function(exitCode) {
                 assert.strictEqual(exitCode, 0);
@@ -108,26 +96,138 @@ describe('concurrently', function() {
 
     it('--success=last should return last exit code', () => {
         // When killed, sleep returns null exit code
-        return run('node ./src/main.js -k --success last "echo test" "sleep 0.1 && nosuchcmd"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js -k --success last "echo test" "sleep 0.1 && nosuchcmd"')
             .then(function(exitCode) {
                 assert.notStrictEqual(exitCode, 0);
             });
     });
 
     it('&& nosuchcmd should return non-zero exit code', () => {
-        return run('node ./src/main.js "echo 1 && nosuchcmd" "echo 1 && nosuchcmd" ', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js "echo 1 && nosuchcmd" "echo 1 && nosuchcmd" ')
             .then(function(exitCode) {
                 assert.strictEqual(exitCode, 1);
             });
     });
 
     it('--prefix-colors should handle non-existent colors without failing', () => {
-        return run('node ./src/main.js -c "not.a.color" "echo colors"', {pipe: DEBUG_TESTS})
+        return run('node ./src/main.js -c "not.a.color" "echo colors"')
             .then(function(exitCode) {
                 assert.strictEqual(exitCode, 0);
             });
     });
 
+    it('--prefix should default to "index"', () => {
+        var collectedLines = []
+
+        return run('node ./src/main.js "echo one" "echo two"', {
+            onOutputLine: (line) => {
+                if (/(one|two)$/.exec(line)) {
+                    collectedLines.push(line)
+                }
+            }
+        })
+            .then(function(exitCode) {
+                assert.strictEqual(exitCode, 0);
+
+                collectedLines.sort()
+                assert.deepEqual(collectedLines, [
+                    '[0] one',
+                    '[1] two'
+                ])
+            });
+    });
+
+    it('--names should set a different default prefix', () => {
+        var collectedLines = []
+
+        return run('node ./src/main.js -n aa,bb "echo one" "echo two"', {
+            onOutputLine: (line) => {
+                if (/(one|two)$/.exec(line)) {
+                    collectedLines.push(line)
+                }
+            }
+        })
+            .then(function(exitCode) {
+                assert.strictEqual(exitCode, 0);
+
+                collectedLines.sort()
+                assert.deepEqual(collectedLines, [
+                    '[aa] one',
+                    '[bb] two'
+                ])
+            });
+    });
+
+    it('--allow-restart should restart a proccess with non-zero exit code', (done) => {
+        var readline = require('readline');
+        var exitedWithOne = false;
+        var restarted = false;
+
+        run('node ./src/main.js --allow-restart "sleep 0.1 && exit 1" "sleep 1"', {
+            pipe: false,
+            onOutputLine: (line) => {
+                var re = /exited with code (.+)/.exec(line);
+                if (re && re[1] === '1') {
+                    exitedWithOne = true
+                }
+
+                if (/restarted/.test(line)) {
+                    restarted = true;
+                }
+            }
+        }).then(function() {
+            if (exitedWithOne && restarted) {
+                done();
+            } else {
+                done(new Error('No restarted process exited with code 1'));
+            }
+        });
+    });
+
+    it('--restart-after=n should restart a proccess after n miliseconds', (done) => {
+        var readline = require('readline');
+        var start, end;
+
+        run('node ./src/main.js --allow-restart --restart-after 300 "exit 1" "sleep 1"', {
+            pipe: false,
+            onOutputLine: (line) => {
+                if (!start && /exited with code (.+)/.test(line)) {
+                    start = new Date().getTime();
+                }
+
+                if (!end && /restarted/.test(line)) {
+                    end = new Date().getTime();
+                }
+            }
+        }).then(function() {
+            // we accept 100 miliseconds of error
+            if (end - start >= 300 && end - start < 400) {
+                done();
+            } else {
+                done(new Error('No restarted process after 300 miliseconds'));
+            }
+        });
+    });
+    it('--restart-tries=n should restart a proccess at most n times', (done) => {
+        var readline = require('readline');
+        var restartedTimes = 0;
+
+        run('node ./src/main.js --allow-restart --restart-tries 2 "exit 1" "sleep 1"', {
+            pipe: false,
+            onOutputLine: (line) => {
+                if (/restarted/.test(line)) {
+                    restartedTimes++;
+                }
+            }
+        }).then(function() {
+            if (restartedTimes == 2) {
+                done();
+            } else {
+                done(new Error('No restarted process twice'));
+            }
+        });
+    });
+
     ['SIGINT', 'SIGTERM'].forEach((signal) => {
       if (IS_WINDOWS) {
           console.log('IS_WINDOWS=true');
@@ -149,32 +249,20 @@ describe('concurrently', function() {
         }
 
         run('node ./src/main.js "node ./test/support/signal.js" "node ./test/support/signal.js"', {
-          pipe: false,
-          callback: function(child) {
-            var rl = readline.createInterface({
-              input: child.stdout,
-              output: null
-            });
+          onOutputLine: function(line, child) {
+            // waiting for startup
+            if (/STARTED/.test(line)) {
+              waitingStart--;
+            }
+            if (!waitingStart) {
+              // both processes are started
+              child.kill(signal);
+            }
 
-            rl.on('line', function(line) {
-              if (DEBUG_TESTS) {
-                console.log(line);
-              }
-
-              // waiting for startup
-              if (/STARTED/.test(line)) {
-                waitingStart--;
-              }
-              if (!waitingStart) {
-                // both processes are started
-                child.kill(signal);
-              }
-
-              // waiting for signal
-              if (new RegExp(signal).test(line)) {
-                waitingSignal--;
-              }
-            });
+            // waiting for signal
+            if (new RegExp(signal).test(line)) {
+              waitingSignal--;
+            }
           }
         }).then(function() {
           waitForSignal(done);

package/test/utils.js

@@ -1,31 +1,31 @@
 var childProcess = require('child_process');
 var _ = require('lodash');
+var readline = require('readline')
 var shellQuote = require('shell-quote');
 
+// If true, output of commands are shown
+var DEBUG_TESTS = process.env.DEBUG_TESTS === 'true';
+
 function run(cmd, opts) {
     opts = _.merge({
-        pipe: true,
-        cwd: undefined,
-        callback: function(child) {
-            // Since we return promise, we need to provide
-            // this callback if one wants to access the child
-            // process reference
-            // Called immediately after successful child process
-            // spawn
-        }
+        // If set to a function, it will be called for each line
+        // written to the child process's stdout as (line, child)
+        onOutputLine: undefined,
     }, opts);
 
     var child;
     var parts = shellQuote.parse(cmd);
     try {
         child = childProcess.spawn(_.head(parts), _.tail(parts), {
-            cwd: opts.cwd,
-            stdio: opts.pipe ? "inherit" : null
+            stdio: DEBUG_TESTS && !opts.onOutputLine ? 'inherit': null,
         });
     } catch (e) {
         return Promise.reject(e);
     }
-    opts.callback(child);
+
+    if (opts.onOutputLine) {
+        readLines(child, opts.onOutputLine);
+    }
 
     return new Promise(function(resolve, reject) {
         child.on('error', function(err) {
@@ -38,6 +38,21 @@ function run(cmd, opts) {
     });
 }
 
+function readLines(child, callback) {
+    var rl = readline.createInterface({
+        input: child.stdout,
+        output: null
+    });
+
+    rl.on('line', function(line) {
+        if (DEBUG_TESTS) {
+            console.log(line);
+        }
+
+        callback(line, child)
+    });
+}
+
 module.exports = {
     run: run
 };

package/.eslintrc

@@ -1,31 +0,0 @@
-{
-  "env": {
-    "browser": true,
-    "node": true
-  },
-  "globals": {},
-  "rules": {
-    "no-bitwise": 2,
-    "camelcase": 2,
-    "curly": 2,
-    "eqeqeq": 2,
-    "wrap-iife": [
-      2,
-      "any"
-    ],
-    "indent": [
-      2,
-      4,
-      {
-        "SwitchCase": 1
-      }
-    ],
-    "no-use-before-define": 0,
-    "new-cap": 2,
-    "no-caller": 2,
-    "quotes": [
-      2,
-      "single"
-    ]
-  }
-}

package/tst.js

@@ -1 +0,0 @@
-setTimeout(() =>console.log("i win!"), 3000);