concurrently 5.1.0 → 5.2.0

package/README.md

@@ -113,18 +113,21 @@ Help:
 concurrently [options] <command ...>
 
 General
-  -n, --names       List of custom names to be used in prefix template.
-                    Example names: "main,browser,server"                [string]
-  --name-separator  The character to split <names> on. Example usage:
-                    concurrently -n "styles|scripts|server" --name-separator "|"
-                                                                  [default: ","]
-  -r, --raw         Output only raw output of processes, disables prettifying
-                    and concurrently coloring.                         [boolean]
-  -s, --success     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.
+  -m, --max-processes  How many processes should run at once.
+                       New processes only spawn after all restart tries of a
+                       process.                                         [number]
+  -n, --names          List of custom names to be used in prefix template.
+                       Example names: "main,browser,server"             [string]
+  --name-separator     The character to split <names> on. Example usage:
+                       concurrently -n "styles|scripts|server" --name-separator
+                       "|"                                        [default: ","]
+  -r, --raw            Output only raw output of processes, disables prettifying
+                       and concurrently coloring.                      [boolean]
+  -s, --success        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.
                               [choices: "first", "last", "all"] [default: "all"]
-  --no-color        Disables colors from logging                       [boolean]
+  --no-color           Disables colors from logging                    [boolean]
 
 Prefix styling
   -p, --prefix            Prefix used in logging for each process.
@@ -222,7 +225,7 @@ concurrently can be used programmatically by using the API documented below:
 
 ### `concurrently(commands[, options])`
 - `commands`: an array of either strings (containing the commands to run) or objects
-  with the shape `{ command, name, prefixColor }`.
+  with the shape `{ command, name, prefixColor, env }`.
 - `options` (optional): an object containing any of the below:
     - `defaultInputTarget`: the default input target when reading from `inputStream`.
     Default: `0`.
@@ -230,6 +233,7 @@ concurrently can be used programmatically by using the API documented below:
     to read the input from, eg `process.stdin`.
     - `killOthers`: an array of exitting conditions that will cause a process to kill others.
     Can contain any of `success` or `failure`.
+    - `maxProcesses`: how many processes should run at once.
     - `outputStream`: a [`Writable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_writable_streams)
     to write logs to. Default: `process.stdout`.
     - `prefix`: the prefix type to use when logging processes output.
@@ -255,7 +259,8 @@ Example:
 const concurrently = require('concurrently');
 concurrently([
     'npm:watch-*',
-    { command: 'nodemon', name: 'server' }
+    { command: 'nodemon', name: 'server' },
+    { command: 'deploy', name: 'deploy', env: { PUBLIC_KEY: '...' } }
 ], {
     prefix: 'name',
     killOthers: ['failure', 'success'],

package/bin/concurrently.js

@@ -13,6 +13,13 @@ const args = yargs
     .alias('v', 'version')
     .options({
         // General
+        'm': {
+            alias: 'max-processes',
+            describe:
+                'How many processes should run at once.\n' +
+                'New processes only spawn after all restart tries of a process.',
+            type: 'number'
+        },
         'n': {
             alias: 'names',
             describe:
@@ -125,7 +132,7 @@ const args = yargs
                 'Can be either the index or the name of the process.'
         }
     })
-    .group(['n', 'name-separator', 'raw', 's', 'no-color'], 'General')
+    .group(['m', 'n', 'name-separator', 'raw', 's', 'no-color'], 'General')
     .group(['p', 'c', 'l', 't'], 'Prefix styling')
     .group(['i', 'default-input-target'], 'Input handling')
     .group(['k', 'kill-others-on-fail'], 'Killing other processes')
@@ -152,6 +159,7 @@ concurrently(args._.map((command, index) => {
     killOthers: args.killOthers
         ? ['success', 'failure']
         : (args.killOthersOnFail ? ['failure'] : []),
+    maxProcesses: args.maxProcesses,
     raw: args.raw,
     prefix: args.prefix,
     prefixLength: args.prefixLength,

package/index.js

@@ -19,6 +19,7 @@ module.exports = (commands, options = {}) => {
     });
 
     return concurrently(commands, {
+        maxProcesses: options.maxProcesses,
         raw: options.raw,
         successCondition: options.successCondition,
         controllers: [
@@ -30,7 +31,7 @@ module.exports = (commands, options = {}) => {
                 defaultInputTarget: options.defaultInputTarget,
                 inputStream: options.inputStream,
             }),
-            new KillOnSignal(),
+            new KillOnSignal({ process }),
             new RestartProcess({
                 logger,
                 delay: options.restartDelay,
@@ -47,6 +48,7 @@ module.exports = (commands, options = {}) => {
 // Export all flow controllers and the main concurrently function,
 // so that 3rd-parties can use them however they want
 exports.concurrently = concurrently;
+exports.Logger = Logger;
 exports.InputHandler = InputHandler;
 exports.KillOnSignal = KillOnSignal;
 exports.KillOthers = KillOthers;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "concurrently",
-  "version": "5.1.0",
+  "version": "5.2.0",
   "description": "Run commands concurrently",
   "main": "index.js",
   "bin": {

package/src/concurrently.js

@@ -31,17 +31,17 @@ module.exports = (commands, options) => {
         new ExpandNpmWildcard()
     ];
 
-    const spawnOpts = getSpawnOpts({ raw: options.raw });
-
     commands = _(commands)
         .map(mapToCommandInfo)
         .flatMap(command => parseCommand(command, commandParsers))
-        .map((command, index) => new Command(Object.assign({
-            index,
-            spawnOpts,
-            killProcess: options.kill,
-            spawn: options.spawn,
-        }, command)))
+        .map((command, index) => new Command(
+            Object.assign({
+                index,
+                spawnOpts: getSpawnOpts({ raw: options.raw, env: command.env }),
+                killProcess: options.kill,
+                spawn: options.spawn,
+            }, command)
+        ))
         .value();
 
     commands = options.controllers.reduce(
@@ -49,7 +49,12 @@ module.exports = (commands, options) => {
         commands
     );
 
-    commands.forEach(command => command.start());
+    const commandsLeft = commands.slice();
+    const maxProcesses = Math.max(1, Number(options.maxProcesses) || commandsLeft.length);
+    for (let i = 0; i < maxProcesses; i++) {
+        maybeRunMore(commandsLeft);
+    }
+
     return new CompletionListener({ successCondition: options.successCondition }).listen(commands);
 };
 
@@ -58,6 +63,7 @@ function mapToCommandInfo(command) {
         command: command.command || command,
         name: command.name || '',
         prefixColor: command.prefixColor || '',
+        env: command.env || {},
     };
 }
 
@@ -67,3 +73,15 @@ function parseCommand(command, parsers) {
         _.castArray(command)
     );
 }
+
+function maybeRunMore(commandsLeft) {
+    const command = commandsLeft.shift();
+    if (!command) {
+        return;
+    }
+
+    command.start();
+    command.close.subscribe(() => {
+        maybeRunMore(commandsLeft);
+    });
+}

package/src/defaults.js

@@ -8,6 +8,8 @@ module.exports = {
     defaultInputTarget: 0,
     // Whether process.stdin should be forwarded to child processes
     handleInput: false,
+    // How many processes to run at once
+    maxProcesses: 0,
     nameSeparator: ',',
     // Which prefix style to use when logging processes output.
     prefix: '',

package/src/flow-control/kill-on-signal.js

@@ -2,7 +2,7 @@ const { map } = require('rxjs/operators');
 
 
 module.exports = class KillOnSignal {
-    constructor({ process = global.process } = {}) {
+    constructor({ process }) {
         this.process = process;
     }
 

package/src/get-spawn-opts.js

@@ -3,10 +3,11 @@ const supportsColor = require('supports-color');
 module.exports = ({
     colorSupport = supportsColor.stdout,
     process = global.process,
-    raw = false
-} = {}) => Object.assign(
+    raw = false,
+    env = {}
+}) => Object.assign(
     {},
     raw && { stdio: 'inherit' },
     /^win/.test(process.platform) && { detached: false },
-    colorSupport && { env: Object.assign({ FORCE_COLOR: colorSupport.level }, process.env) }
+    { env: Object.assign(colorSupport ? { FORCE_COLOR: colorSupport.level } : {}, process.env, env) }
 );