api: allow different env vars for each command (#184)

open-cli-tools · Feb 23, 2020 · af501f3 · af501f3
1 parent a0cc081
commit af501f3
Show file tree

Hide file tree

Showing 5 changed files with 35 additions and 13 deletions.
diff --git a/README.md b/README.md
@@ -225,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`.
@@ -259,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'],

diff --git a/src/concurrently.js b/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(
@@ -63,6 +63,7 @@ function mapToCommandInfo(command) {
         command: command.command || command,
         name: command.name || '',
         prefixColor: command.prefixColor || '',
+        env: command.env || {},
     };
 }
 

diff --git a/src/concurrently.spec.js b/src/concurrently.spec.js
@@ -97,3 +97,22 @@ it('passes commands wrapped from a controller to the next one', () => {
 
     expect(fakeCommand.start).toHaveBeenCalledTimes(1);
 });
+
+it('merges extra env vars into each command', () => {
+    create([
+        { command: 'echo', env: { foo: 'bar' } },
+        { command: 'echo', env: { foo: 'baz' } },
+        'kill'
+    ]);
+
+    expect(spawn).toHaveBeenCalledTimes(3);
+    expect(spawn).toHaveBeenCalledWith('echo', expect.objectContaining({
+        env: expect.objectContaining({ foo: 'bar' }) 
+    }));
+    expect(spawn).toHaveBeenCalledWith('echo', expect.objectContaining({
+        env: expect.objectContaining({ foo: 'baz' }) 
+    }));
+    expect(spawn).toHaveBeenCalledWith('kill', expect.objectContaining({
+        env: expect.not.objectContaining({ foo: expect.anything() }) 
+    }));
+});
diff --git a/src/get-spawn-opts.js b/src/get-spawn-opts.js
@@ -3,10 +3,11 @@ const supportsColor = require('supports-color');
 module.exports = ({
     colorSupport = supportsColor.stdout,
     process = global.process,
-    raw = false
+    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) }
 );
diff --git a/src/get-spawn-opts.spec.js b/src/get-spawn-opts.spec.js
@@ -10,7 +10,7 @@ it('sets stdio to inherit when raw', () => {
 
 it('merges FORCE_COLOR into env vars if color supported', () => {
     const process = { env: { foo: 'bar' } };
-    expect(getSpawnOpts({ process, colorSupport: false }).env).toBeUndefined();
+    expect(getSpawnOpts({ process, colorSupport: false }).env).toEqual(process.env);
     expect(getSpawnOpts({ process, colorSupport: { level: 1 } }).env).toEqual({
         FORCE_COLOR: 1,
         foo: 'bar'