concurrently 3.1.0 → 3.5.0

package/.travis.yml

@@ -1,5 +1,6 @@
 language: node_js
 node_js:
+  - 7
   - 6
   - 4
 before_script:

package/CONTRIBUTING.md

@@ -22,7 +22,5 @@ You need to have *mocha* installed globally with `npm install -g mocha`.
 ## Release
 
 * Commit all changes
-* Run `./tools/release.js minor`, which will create new tag and publish code to GitHub and npm
+* Run `./node_modules/.bin/releasor --bump minor`, which will create new tag and publish code to GitHub and npm. See https://github.com/kimmobrunfeldt/releasor for options
 * Edit GitHub release notes
-
-

package/README.md

@@ -14,7 +14,7 @@ Like `npm run watch-js & npm run watch-less` but better.
 * Cross platform, works also in Windows
 * Output is easy to follow with prefixes
 * With `--kill-others` switch, all commands are killed if one dies
-* Spawns commands with [spawn-default-shell](https://github.com/kimmobrunfeldt/spawn-default-shell)
+* Spawns commands with [spawn-command](https://github.com/mmalecki/spawn-command)
 
 ## Install
 
@@ -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"
@@ -76,7 +77,7 @@ Options:
   See https://www.npmjs.com/package/chalk for more information.
   Default: "gray.dim". Example: "black.bgWhite,cyan,gray.dim"
 
-  -t, --timestamp-format <format>  specify the timestamp in moment format. Default: YYYY-MM-DD HH:mm:ss.SSS
+  -t, --timestamp-format <format>  specify the timestamp in moment/date-fns format. Default: YYYY-MM-DD HH:mm:ss.SSS
 
   -r, --raw                        output only raw output of processes, disables prettifying and concurrently coloring
   -s, --success <first|last|all>   Return exit code of zero or one based on the success or failure of the "first" child to terminate, the "last" child, or succeed  only if "all" child processes succeed. Default: all
@@ -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,31 +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).
-
-
-## Debugging
-
-A few common debugging commands.
-
-### spawn-default-shell
-
-Which shell and flag does [spawn-default-shell](https://github.com/kimmobrunfeldt/spawn-default-shell/)
-use?
-
-```bash
-npm i spawn-default-shell && node -e "console.log(require('spawn-default-shell/src/get-shell')())"
-```

package/appveyor.yml

@@ -1,5 +1,6 @@
 environment:
   matrix:
+    - nodejs_version: '7'
     - nodejs_version: '6'
     - nodejs_version: '4'
 install:

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "concurrently",
-  "version": "3.1.0",
+  "version": "3.5.0",
   "description": "Run commands concurrently",
   "main": "src/main.js",
   "bin": {
     "concurrent": "./src/main.js",
     "concurrently": "./src/main.js"
   },
+  "engines": {
+    "node": ">=4.0.0"
+  },
   "scripts": {
     "test": "mocha"
   },
@@ -29,13 +32,13 @@
   },
   "homepage": "https://github.com/kimmobrunfeldt/concurrently",
   "dependencies": {
-    "bluebird": "2.9.6",
     "chalk": "0.5.1",
     "commander": "2.6.0",
+    "date-fns": "^1.23.0",
     "lodash": "^4.5.1",
-    "moment": "^2.11.2",
     "rx": "2.3.24",
-    "spawn-default-shell": "^1.1.0",
+    "spawn-command": "^0.0.2-1",
+    "supports-color": "^3.2.3",
     "tree-kill": "^1.1.0"
   },
   "devDependencies": {

package/src/main.js

@@ -2,21 +2,21 @@
 
 var Rx = require('rx');
 var path = require('path');
-var Promise = require('bluebird');
-var moment = require('moment');
+var formatDate = require('date-fns/format');
 var program = require('commander');
 var _ = require('lodash');
 var treeKill = require('tree-kill');
 var chalk = require('chalk');
-var defaultShell = require('spawn-default-shell');
+var spawn = require('spawn-command');
+var supportsColor = require('supports-color');
 var IS_WINDOWS = /^win/.test(process.platform);
 
 var config = {
     // Kill other processes if one dies
     killOthers: false,
 
-    // How much in ms we wait before killing other processes
-    killDelay: 1000,
+    // Kill other processes if one exits with non zero status code
+    killOthersOnFail: false,
 
     // Return success or failure of the 'first' child to terminate, the 'last' child,
     // or succeed only if 'all' children succeed
@@ -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: '',
@@ -35,7 +35,7 @@ var config = {
     // Comma-separated list of chalk color paths to use on prefixes.
     prefixColors: 'gray.dim',
 
-    // moment format
+    // moment/date-fns format
     timestampFormat: 'YYYY-MM-DD HH:mm:ss.SSS',
 
     // How many characters to display from start of command in prefix if
@@ -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);
 }
 
@@ -69,6 +80,10 @@ function parseArgs() {
             '-k, --kill-others',
             'kill other processes if one exits or dies'
         )
+        .option(
+            '--kill-others-on-fail',
+            'kill other processes if one exits with non zero status code'
+        )
         .option(
             '--no-color',
             'disable colors from logging'
@@ -77,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>',
@@ -101,7 +116,7 @@ function parseArgs() {
         )
         .option(
             '-t, --timestamp-format <format>',
-            'specify the timestamp in moment format. Default: ' +
+            'specify the timestamp in moment/date-fns format. Default: ' +
             config.timestampFormat + '\n'
         )
         .option(
@@ -122,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() {
@@ -132,6 +162,10 @@ function parseArgs() {
             '',
             '       $ 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',
             '',
             '       $ concurrently --raw "npm run watch-less" "npm run watch-js"',
@@ -146,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'));
@@ -164,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] === '\'') {
@@ -186,19 +226,15 @@ function run(commands) {
         if (IS_WINDOWS) {
             spawnOpts.detached = false;
         }
-
-        var child;
-        try {
-            child = defaultShell.spawn(cmd, spawnOpts);
-        } catch (e) {
-            logError('', chalk.gray.dim, 'Error occured when executing command: ' + cmd);
-            logError('', chalk.gray.dim, e.stack);
-            process.exit(1);
+        if (supportsColor) {
+          spawnOpts.env = Object.assign({FORCE_COLOR: supportsColor.level}, process.env)
         }
 
+        var child = spawnChild(cmd, spawnOpts);
+
         if (index < prefixColors.length) {
             var prefixColorPath = prefixColors[index];
-            lastPrefixColor = _.get(chalk, prefixColorPath);
+            lastPrefixColor = _.get(chalk, prefixColorPath, chalk.gray.dim);
         }
 
         var name = index < names.length ? names[index] : '';
@@ -206,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')
@@ -230,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) {
-          child.kill(signal);
-        });
-      });
-    });
 }
 
 function handleOutput(streams, childrenInfo, source) {
@@ -263,39 +321,68 @@ function handleClose(streams, children, childrenInfo) {
     var exitCodes = [];
     var closeStreams = _.map(streams, 'close');
     var closeStream = Rx.Observable.merge.apply(this, closeStreams);
+    var othersKilled = false
 
     // TODO: Is it possible that amount of close events !== count of spawned?
     closeStream.subscribe(function(event) {
         var exitCode = event.data;
+        var nonSuccess = exitCode !== 0;
         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);
         }
+        if (!othersKilled) {
+          if (config.killOthers) {
+            killOtherProcesses(aliveChildren);
+            othersKilled = true;
+          } else if (config.killOthersOnFail && nonSuccess) {
+            killOtherProcesses(aliveChildren);
+            othersKilled = true;
+          }
+        }
     });
+}
 
-    if (config.killOthers) {
-        // Give other processes some time to stop cleanly before killing them
-        var delayedExit = closeStream.delay(config.killDelay);
+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);
 
-        delayedExit.subscribe(function() {
-            logEvent('--> ', chalk.gray.dim, 'Sending SIGTERM to other processes..');
+        childrenInfo[newChild.pid] = childrenInfo[event.child.pid];
+        delete childrenInfo[event.child.pid];
 
-            // Send SIGTERM to alive children
-            _.each(aliveChildren, function(child) {
-                treeKill(child.pid, 'SIGTERM');
-            });
-        });
-    }
+        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..');
+
+    // Send SIGTERM to alive children
+    _.each(processes, function(child) {
+        treeKill(child.pid, 'SIGTERM');
+    });
 }
 
 function exit(childExitCodes) {
@@ -354,7 +441,7 @@ function getPrefixes(childrenInfo, child) {
     prefixes.pid = child.pid;
     prefixes.index = childrenInfo[child.pid].index;
     prefixes.name = childrenInfo[child.pid].name;
-    prefixes.time = moment().format(config.timestampFormat);
+    prefixes.time = formatDate(Date.now(), config.timestampFormat);
 
     var command = childrenInfo[child.pid].command;
     prefixes.command = shortenText(command, config.prefixLength);