concurrently 5.3.0 → 6.1.0

package/README.md

@@ -10,11 +10,13 @@ Like `npm run watch-js & npm run watch-less` but better.
 ![](docs/demo.gif)
 
 **Table of contents**
-- [Why](#why)
-- [Install](#install)
-- [Usage](#usage)
-- [Programmatic Usage](#programmatic-usage)
-- [FAQ](#faq)
+- [Concurrently](#concurrently)
+  - [Why](#why)
+  - [Install](#install)
+  - [Usage](#usage)
+  - [Programmatic Usage](#programmatic-usage)
+    - [`concurrently(commands[, options])`](#concurrentlycommands-options)
+  - [FAQ](#faq)
 
 ## Why
 
@@ -140,11 +142,12 @@ Prefix styling
                           - Available modifiers: reset, bold, dim, italic,
                           underline, inverse, hidden, strikethrough
                           - Available colors: black, red, green, yellow, blue,
-                          magenta, cyan, white, gray
+                          magenta, cyan, white, gray, or any hex values for
+                          colors, eg #23de43
                           - Available background colors: bgBlack, bgRed,
                           bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite
                           See https://www.npmjs.com/package/chalk for more
-                          information.            [string] [default: "gray.dim"]
+                          information.            [string] [default: "reset"]
   -l, --prefix-length     Limit how many characters of the command is displayed
                           in prefix. The option can be used to shorten the
                           prefix when it is set to "command"
@@ -225,8 +228,10 @@ 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, env }`.
+  with the shape `{ command, name, prefixColor, env, cwd }`.
 - `options` (optional): an object containing any of the below:
+    - `cwd`: the working directory to be used by all commands. Can be overriden per command.
+    Default: `process.cwd()`.
     - `defaultInputTarget`: the default input target when reading from `inputStream`.
     Default: `0`.
     - `inputStream`: a [`Readable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_readable_streams)
@@ -263,11 +268,13 @@ const concurrently = require('concurrently');
 concurrently([
     'npm:watch-*',
     { command: 'nodemon', name: 'server' },
-    { command: 'deploy', name: 'deploy', env: { PUBLIC_KEY: '...' } }
+    { command: 'deploy', name: 'deploy', env: { PUBLIC_KEY: '...' } },
+    { command: 'watch', name: 'watch', cwd: path.resolve(__dirname, 'scripts/watchers')}
 ], {
     prefix: 'name',
     killOthers: ['failure', 'success'],
     restartTries: 3,
+    cwd: path.resolve(__dirname, 'scripts'),
 }).then(success, failure);
 ```
 

package/bin/concurrently.js

@@ -83,7 +83,8 @@ const args = yargs
                 'Comma-separated list of chalk colors to use on prefixes. ' +
                 'If there are more commands than colors, the last color will be repeated.\n' +
                 '- Available modifiers: reset, bold, dim, italic, underline, inverse, hidden, strikethrough\n' +
-                '- Available colors: black, red, green, yellow, blue, magenta, cyan, white, gray\n' +
+                '- Available colors: black, red, green, yellow, blue, magenta, cyan, white, gray \n' +
+                'or any hex values for colors, eg #23de43\n' +
                 '- Available background colors: bgBlack, bgRed, bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite\n' +
                 'See https://www.npmjs.com/package/chalk for more information.',
             default: defaults.prefixColors,

package/bin/concurrently.spec.js

@@ -0,0 +1,365 @@
+const readline = require('readline');
+const _ = require('lodash');
+const Rx = require('rxjs');
+const { buffer, map } = require('rxjs/operators');
+const spawn = require('spawn-command');
+
+const isWindows = process.platform === 'win32';
+const createKillMessage = prefix => new RegExp(
+    _.escapeRegExp(prefix) +
+    ' exited with code ' +
+    (isWindows ? 1 : '(SIGTERM|143)')
+);
+
+const run = args => {
+    const child = spawn('node ./concurrently.js ' + args, {
+        cwd: __dirname,
+        env: Object.assign({}, process.env, {
+            // When upgrading from jest 23 -> 24, colors started printing in the test output.
+            // They are forcibly disabled here
+            FORCE_COLOR: 0
+        }),
+    });
+
+    const stdout = readline.createInterface({
+        input: child.stdout,
+        output: null
+    });
+
+    const stderr = readline.createInterface({
+        input: child.stderr,
+        output: null
+    });
+
+    const close = Rx.fromEvent(child, 'close');
+    const log = Rx.merge(
+        Rx.fromEvent(stdout, 'line'),
+        Rx.fromEvent(stderr, 'line')
+    ).pipe(map(data => data.toString()));
+
+    return {
+        close,
+        log,
+        stdin: child.stdin,
+        pid: child.pid
+    };
+};
+
+it('has help command', done => {
+    run('--help').close.subscribe(event => {
+        expect(event[0]).toBe(0);
+        done();
+    }, done);
+});
+
+it('has version command', done => {
+    Rx.combineLatest(
+        run('--version').close,
+        run('-V').close,
+        run('-v').close
+    ).subscribe(events => {
+        expect(events[0][0]).toBe(0);
+        expect(events[1][0]).toBe(0);
+        expect(events[2][0]).toBe(0);
+        done();
+    }, done);
+});
+
+describe('exiting conditions', () => {
+    it('is of success by default when running successful commands', done => {
+        run('"echo foo" "echo bar"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBe(0);
+                done();
+            }, done);
+    });
+
+    it('is of failure by default when one of the command fails', done => {
+        run('"echo foo" "exit 1"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBeGreaterThan(0);
+                done();
+            }, done);
+    });
+
+    it('is of success when --success=first and first command to exit succeeds', done => {
+        run('--success=first "echo foo" "sleep 0.5 && exit 1"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBe(0);
+                done();
+            }, done);
+    });
+
+    it('is of failure when --success=first and first command to exit fails', done => {
+        run('--success=first "exit 1" "sleep 0.5 && echo foo"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBeGreaterThan(0);
+                done();
+            }, done);
+    });
+
+    it('is of success when --success=last and last command to exit succeeds', done => {
+        run('--success=last "exit 1" "sleep 0.5 && echo foo"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBe(0);
+                done();
+            }, done);
+    });
+
+    it('is of failure when --success=last and last command to exit fails', done => {
+        run('--success=last "echo foo" "sleep 0.5 && exit 1"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBeGreaterThan(0);
+                done();
+            }, done);
+    });
+
+    it.skip('is of success when a SIGINT is sent', done => {
+        const child = run('"node fixtures/read-echo.js"');
+        child.close.subscribe(exit => {
+            // TODO This is null within Node, but should be 0 outside (eg from real terminal)
+            expect(exit[0]).toBe(0);
+            done();
+        }, done);
+
+        process.kill(child.pid, 'SIGINT');
+    });
+
+    it('is aliased to -s', done => {
+        run('-s last "exit 1" "sleep 0.5 && echo foo"')
+            .close
+            .subscribe(exit => {
+                expect(exit[0]).toBe(0);
+                done();
+            }, done);
+    });
+});
+
+describe('--raw', () => {
+    it('is aliased to -r', done => {
+        const child = run('-r "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toHaveLength(2);
+            expect(lines).toContainEqual(expect.stringContaining('foo'));
+            expect(lines).toContainEqual(expect.stringContaining('bar'));
+            done();
+        }, done);
+    });
+
+    it('does not log any extra output', done => {
+        const child = run('--raw "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toHaveLength(2);
+            expect(lines).toContainEqual(expect.stringContaining('foo'));
+            expect(lines).toContainEqual(expect.stringContaining('bar'));
+            done();
+        }, done);
+    });
+});
+
+describe('--names', () => {
+    it('is aliased to -n', done => {
+        const child = run('-n foo,bar "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[foo] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[bar] bar'));
+            done();
+        }, done);
+    });
+
+    it('prefixes with names', done => {
+        const child = run('--names foo,bar "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[foo] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[bar] bar'));
+            done();
+        }, done);
+    });
+
+    it('is split using --name-separator arg', done => {
+        const child = run('--names "foo|bar" --name-separator "|" "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[foo] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[bar] bar'));
+            done();
+        }, done);
+    });
+});
+
+describe('--prefix', () => {
+    it('is alised to -p', done => {
+        const child = run('-p command "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[echo foo] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[echo bar] bar'));
+            done();
+        }, done);
+    });
+
+    it('specifies custom prefix', done => {
+        const child = run('--prefix command "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[echo foo] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[echo bar] bar'));
+            done();
+        }, done);
+    });
+});
+
+describe('--prefix-length', () => {
+    it('is alised to -l', done => {
+        const child = run('-p command -l 5 "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[ec..o] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[ec..r] bar'));
+            done();
+        }, done);
+    });
+
+    it('specifies custom prefix length', done => {
+        const child = run('--prefix command --prefix-length 5 "echo foo" "echo bar"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[ec..o] foo'));
+            expect(lines).toContainEqual(expect.stringContaining('[ec..r] bar'));
+            done();
+        }, done);
+    });
+});
+
+describe('--restart-tries', () => {
+    it('changes how many times a command will restart', done => {
+        const child = run('--restart-tries 1 "exit 1"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toEqual([
+                expect.stringContaining('[0] exit 1 exited with code 1'),
+                expect.stringContaining('[0] exit 1 restarted'),
+                expect.stringContaining('[0] exit 1 exited with code 1'),
+            ]);
+            done();
+        }, done);
+    });
+});
+
+describe('--kill-others', () => {
+    it('is alised to -k', done => {
+        const child = run('-k "sleep 10" "exit 0"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[1] exit 0 exited with code 0'));
+            expect(lines).toContainEqual(expect.stringContaining('Sending SIGTERM to other processes'));
+            expect(lines).toContainEqual(expect.stringMatching(createKillMessage('[0] sleep 10')));
+            done();
+        }, done);
+    });
+
+    it('kills on success', done => {
+        const child = run('--kill-others "sleep 10" "exit 0"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[1] exit 0 exited with code 0'));
+            expect(lines).toContainEqual(expect.stringContaining('Sending SIGTERM to other processes'));
+            expect(lines).toContainEqual(expect.stringMatching(createKillMessage('[0] sleep 10')));
+            done();
+        }, done);
+    });
+
+    it('kills on failure', done => {
+        const child = run('--kill-others "sleep 10" "exit 1"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[1] exit 1 exited with code 1'));
+            expect(lines).toContainEqual(expect.stringContaining('Sending SIGTERM to other processes'));
+            expect(lines).toContainEqual(expect.stringMatching(createKillMessage('[0] sleep 10')));
+            done();
+        }, done);
+    });
+});
+
+describe('--kill-others-on-fail', () => {
+    it('does not kill on success', done => {
+        const child = run('--kill-others-on-fail "sleep 0.5" "exit 0"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[1] exit 0 exited with code 0'));
+            expect(lines).toContainEqual(expect.stringContaining('[0] sleep 0.5 exited with code 0'));
+            done();
+        }, done);
+    });
+
+    it('kills on failure', done => {
+        const child = run('--kill-others-on-fail "sleep 10" "exit 1"');
+        child.log.pipe(buffer(child.close)).subscribe(lines => {
+            expect(lines).toContainEqual(expect.stringContaining('[1] exit 1 exited with code 1'));
+            expect(lines).toContainEqual(expect.stringContaining('Sending SIGTERM to other processes'));
+            expect(lines).toContainEqual(expect.stringMatching(createKillMessage('[0] sleep 10')));
+            done();
+        }, done);
+    });
+});
+
+describe('--handle-input', () => {
+    it('is alised to -i', done => {
+        const child = run('-i "node fixtures/read-echo.js"');
+        child.log.subscribe(line => {
+            if (/READING/.test(line)) {
+                child.stdin.write('stop\n');
+            }
+
+            if (/\[0\] stop/.test(line)) {
+                done();
+            }
+        }, done);
+    });
+
+    it('forwards input to first process by default', done => {
+        const child = run('--handle-input "node fixtures/read-echo.js"');
+        child.log.subscribe(line => {
+            if (/READING/.test(line)) {
+                child.stdin.write('stop\n');
+            }
+
+            if (/\[0\] stop/.test(line)) {
+                done();
+            }
+        }, done);
+    });
+
+
+    it('forwards input to process --default-input-target', done => {
+        const lines = [];
+        const child = run('-ki --default-input-target 1 "node fixtures/read-echo.js" "node fixtures/read-echo.js"');
+        child.log.subscribe(line => {
+            lines.push(line);
+            if (/\[1\] READING/.test(line)) {
+                child.stdin.write('stop\n');
+            }
+        }, done);
+
+        child.close.subscribe(exit => {
+            expect(exit[0]).toBeGreaterThan(0);
+            expect(lines).toContainEqual(expect.stringContaining('[1] stop'));
+            expect(lines).toContainEqual(expect.stringMatching(createKillMessage('[0] node fixtures/read-echo.js')));
+            done();
+        }, done);
+    });
+
+    it('forwards input to specified process', done => {
+        const lines = [];
+        const child = run('-ki "node fixtures/read-echo.js" "node fixtures/read-echo.js"');
+        child.log.subscribe(line => {
+            lines.push(line);
+            if (/\[1\] READING/.test(line)) {
+                child.stdin.write('1:stop\n');
+            }
+        }, done);
+
+        child.close.subscribe(exit => {
+            expect(exit[0]).toBeGreaterThan(0);
+            expect(lines).toContainEqual(expect.stringContaining('[1] stop'));
+            expect(lines).toContainEqual(expect.stringMatching(createKillMessage('[0] node fixtures/read-echo.js')));
+            done();
+        }, done);
+    });
+});

package/index.js

@@ -22,6 +22,7 @@ module.exports = (commands, options = {}) => {
         maxProcesses: options.maxProcesses,
         raw: options.raw,
         successCondition: options.successCondition,
+        cwd: options.cwd,
         controllers: [
             new LogError({ logger }),
             new LogOutput({ logger }),

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "concurrently",
-  "version": "5.3.0",
+  "version": "6.1.0",
   "description": "Run commands concurrently",
   "main": "index.js",
   "bin": {
     "concurrently": "./bin/concurrently.js"
   },
   "engines": {
-    "node": ">=6.0.0"
+    "node": ">=10.0.0"
   },
   "scripts": {
     "lint": "eslint . --ignore-path .gitignore",
@@ -29,20 +29,20 @@
   "author": "Kimmo Brunfeldt",
   "license": "MIT",
   "dependencies": {
-    "chalk": "^2.4.2",
-    "date-fns": "^2.0.1",
-    "lodash": "^4.17.15",
-    "read-pkg": "^4.0.1",
-    "rxjs": "^6.5.2",
+    "chalk": "^4.1.0",
+    "date-fns": "^2.16.1",
+    "lodash": "^4.17.21",
+    "read-pkg": "^5.2.0",
+    "rxjs": "^6.6.3",
     "spawn-command": "^0.0.2-1",
-    "supports-color": "^6.1.0",
+    "supports-color": "^8.1.0",
     "tree-kill": "^1.2.2",
-    "yargs": "^13.3.0"
+    "yargs": "^16.2.0"
   },
   "devDependencies": {
-    "coveralls": "^3.0.4",
-    "eslint": "^5.16.0",
-    "jest": "^24.8.0",
+    "coveralls": "^3.1.0",
+    "eslint": "^7.17.0",
+    "jest": "^26.6.3",
     "jest-create-mock-instance": "^1.1.0"
   },
   "files": [

package/src/command-parser/expand-npm-shortcut.spec.js

@@ -0,0 +1,36 @@
+const ExpandNpmShortcut = require('./expand-npm-shortcut');
+const parser = new ExpandNpmShortcut();
+
+it('returns same command if no npm: prefix is present', () => {
+    const commandInfo = {
+        name: 'echo',
+        command: 'echo foo'
+    };
+    expect(parser.parse(commandInfo)).toBe(commandInfo);
+});
+
+for (const npmCmd of ['npm', 'yarn', 'pnpm']) {
+    describe(`with ${npmCmd}: prefix`, () => {
+        it(`expands to "${npmCmd} run <script> <args>"`, () => {
+            const commandInfo = {
+                name: 'echo',
+                command: `${npmCmd}:foo -- bar`
+            };
+            expect(parser.parse(commandInfo)).toEqual({
+                name: 'echo',
+                command: `${npmCmd} run foo -- bar`
+            });
+        });
+
+        it('sets name to script name if none', () => {
+            const commandInfo = {
+                command: `${npmCmd}:foo -- bar`
+            };
+            expect(parser.parse(commandInfo)).toEqual({
+                name: 'foo',
+                command: `${npmCmd} run foo -- bar`
+            });
+        });
+    });
+
+}

package/src/command-parser/expand-npm-wildcard.spec.js

@@ -0,0 +1,58 @@
+const ExpandNpmWildcard = require('./expand-npm-wildcard');
+
+let parser, readPkg;
+
+beforeEach(() => {
+    readPkg = jest.fn();
+    parser = new ExpandNpmWildcard(readPkg);
+});
+
+it('returns same command if not an npm run command', () => {
+    const commandInfo = {
+        command: 'npm test'
+    };
+
+    expect(readPkg).not.toHaveBeenCalled();
+    expect(parser.parse(commandInfo)).toBe(commandInfo);
+});
+
+it('returns same command if no wildcard present', () => {
+    const commandInfo = {
+        command: 'npm run foo bar'
+    };
+
+    expect(readPkg).not.toHaveBeenCalled();
+    expect(parser.parse(commandInfo)).toBe(commandInfo);
+});
+
+it('expands to nothing if no scripts exist in package.json', () => {
+    readPkg.mockReturnValue({});
+
+    expect(parser.parse({ command: 'npm run foo-*-baz qux' })).toEqual([]);
+});
+
+for (const npmCmd of ['npm', 'yarn', 'pnpm']) {
+    describe(`with an ${npmCmd}: prefix`, () => {
+        it('expands to all scripts matching pattern', () => {
+            readPkg.mockReturnValue({
+                scripts: {
+                    'foo-bar-baz': '',
+                    'foo--baz': '',
+                }
+            });
+
+            expect(parser.parse({ command: `${npmCmd} run foo-*-baz qux` })).toEqual([
+                { name: 'foo-bar-baz', command: `${npmCmd} run foo-bar-baz qux` },
+                { name: 'foo--baz', command: `${npmCmd} run foo--baz qux` },
+            ]);
+        });
+
+        it('caches scripts upon calls', () => {
+            readPkg.mockReturnValue({});
+            parser.parse({ command: `${npmCmd} run foo-*-baz qux` });
+            parser.parse({ command: `${npmCmd} run foo-*-baz qux` });
+
+            expect(readPkg).toHaveBeenCalledTimes(1);
+        });
+    });
+}

package/src/command-parser/strip-quotes.spec.js

@@ -0,0 +1,20 @@
+const StripQuotes = require('./strip-quotes');
+const parser = new StripQuotes();
+
+it('returns command as is if no single/double quote at the beginning', () => {
+    expect(parser.parse({ command: 'echo foo' })).toEqual({ command: 'echo foo' });
+});
+
+it('strips single quotes', () => {
+    expect(parser.parse({ command: '\'echo foo\'' })).toEqual({ command: 'echo foo' });
+});
+
+it('strips double quotes', () => {
+    expect(parser.parse({ command: '"echo foo"' })).toEqual({ command: 'echo foo' });
+});
+
+it('does not remove quotes if they are impaired', () => {
+    expect(parser.parse({ command: '"echo foo' })).toEqual({ command: '"echo foo' });
+    expect(parser.parse({ command: 'echo foo\'' })).toEqual({ command: 'echo foo\'' });
+    expect(parser.parse({ command: '"echo foo\'' })).toEqual({ command: '"echo foo\'' });
+});