concurrently 4.0.1 → 4.1.0

package/.travis.yml

@@ -6,3 +6,5 @@ node_js:
 script:
   - npm test
   - npm run lint
+after_success:
+  - npm run report-coverage

package/CONTRIBUTING.md

@@ -6,7 +6,6 @@ updated.
 
 **Pull requests:** You don't need to bump version numbers or modify anything related to releasing. That stuff is fully automated, just write the functionality.
 
-
 # Maintaining
 
 ## Test
@@ -14,11 +13,9 @@ updated.
 Tests can be run with command:
 
 ```bash
-mocha
+npm run test
 ```
 
-You need to have *mocha* installed globally with `npm install -g mocha`.
-
 ## Release
 
 * Commit all changes

package/README.md

@@ -225,25 +225,25 @@ For more details, visit https://github.com/kimmobrunfeldt/concurrently
 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 
+- `commands`: an array of either strings (containing the commands to run) or objects
   with the shape `{ command, name, prefixColor }`.
 - `options` (optional): an object containing any of the below:
-    - `defaultInputTarget`: the default input target when reading from `inputStream`. 
+    - `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) 
+    - `inputStream`: a [`Readable` stream](https://nodejs.org/dist/latest-v10.x/docs/api/stream.html#stream_readable_streams)
     to read the input from, eg `process.stdin`.
-    - `killOthers`: an array of exitting conditions that will cause a process to kill others.  
+    - `killOthers`: an array of exitting conditions that will cause a process to kill others.
     Can contain any of `success` or `failure`.
     - `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.  
-      Possible values: `index`, `pid`, `time`, `command`, `name`, `none`, or a template (eg `[{time} process: {pid}]`).  
+    - `prefix`: the prefix type to use when logging processes output.
+      Possible values: `index`, `pid`, `time`, `command`, `name`, `none`, or a template (eg `[{time} process: {pid}]`).
       Default: the name of the process, or its index if no name is set.
     - `prefixLength`: how many characters to show when prefixing with `command`. Default: `10`
     - `raw`: whether raw mode should be used, meaning strictly process output will
     be logged, without any prefixes, colouring or extra stuff.
     - `successCondition`: the condition to consider the run was successful.
-    If `first`, only the first process will make up the success of the run; if `last`, the last.  
+    If `first`, only the first process to exit will make up the success of the run; if `last`, the last process that exits will determine whether the run succeeds.
     Anything else means all processes should exit successfully.
     - `restartTries`: how many attempts to restart a process that dies will be made. Default: `0`.
     - `restartDelay`: how many milliseconds to wait between process restarts. Default: `0`.
@@ -258,7 +258,7 @@ Example:
 ```js
 const concurrently = require('concurrently');
 concurrently([
-    'npm:watch-*', 
+    'npm:watch-*',
     { command: 'nodemon', name: 'server' }
 ], {
     prefix: 'name',
@@ -282,3 +282,6 @@ concurrently([
     So *null* means the process didn't terminate normally. This will make **concurrent**
     to return non-zero exit code too.
 
+* Does this work with the npm-replacement [yarn](https://github.com/yarnpkg/yarn)?
+
+    Yes! In all examples above, you may replace "`npm`" with "`yarn`".

package/bin/concurrently.js

@@ -8,7 +8,7 @@ const args = yargs
     .usage('$0 [options] <command ...>')
     .help('h')
     .alias('h', 'help')
-    .version('v')
+    .version('v', require('../package.json').version)
     .alias('v', 'V')
     .alias('v', 'version')
     .options({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "concurrently",
-  "version": "4.0.1",
+  "version": "4.1.0",
   "description": "Run commands concurrently",
   "main": "index.js",
   "bin": {
@@ -11,6 +11,7 @@
   },
   "scripts": {
     "lint": "eslint . --ignore-path .gitignore",
+    "report-coverage": "cat coverage/lcov.info | coveralls",
     "test": "jest"
   },
   "repository": {
@@ -32,13 +33,14 @@
     "date-fns": "^1.23.0",
     "lodash": "^4.17.10",
     "read-pkg": "^4.0.1",
-    "rxjs": "6.2.2",
+    "rxjs": "^6.3.3",
     "spawn-command": "^0.0.2-1",
     "supports-color": "^4.5.0",
     "tree-kill": "^1.1.0",
     "yargs": "^12.0.1"
   },
   "devDependencies": {
+    "coveralls": "^3.0.2",
     "eslint": "^5.4.0",
     "jest": "^23.5.0",
     "jest-create-mock-instance": "^1.1.0"

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

@@ -1,13 +1,13 @@
 module.exports = class ExpandNpmShortcut {
     parse(commandInfo) {
-        const [, cmdName, args] = commandInfo.command.match(/^npm:(\S+)(.*)/) || [];
+        const [, npmCmd, cmdName, args] = commandInfo.command.match(/^(npm|yarn):(\S+)(.*)/) || [];
         if (!cmdName) {
             return commandInfo;
         }
 
         return Object.assign({}, commandInfo, {
             name: commandInfo.name || cmdName,
-            command: `npm run ${cmdName}${args}`
+            command: `${npmCmd} run ${cmdName}${args}`
         });
     }
 };

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

@@ -9,25 +9,28 @@ it('returns same command if no npm: prefix is present', () => {
     expect(parser.parse(commandInfo)).toBe(commandInfo);
 });
 
-describe('with npm: prefix', () => {
-    it('expands to "npm run <script> <args>"', () => {
-        const commandInfo = {
-            name: 'echo',
-            command: 'npm:foo -- bar'
-        };
-        expect(parser.parse(commandInfo)).toEqual({
-            name: 'echo',
-            command: 'npm run foo -- bar'
+for (const npmCmd of ['npm', 'yarn']) {
+    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: 'npm:foo -- bar'
-        };
-        expect(parser.parse(commandInfo)).toEqual({
-            name: 'foo',
-            command: 'npm 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.js

@@ -7,7 +7,7 @@ module.exports = class ExpandNpmWildcard {
     }
 
     parse(commandInfo) {
-        const [, cmdName, args] = commandInfo.command.match(/npm run (\S+)([^&]*)/) || [];
+        const [, npmCmd, cmdName, args] = commandInfo.command.match(/(npm|yarn) run (\S+)([^&]*)/) || [];
         const wildcardPosition = (cmdName || '').indexOf('*');
 
         // If the regex didn't match an npm script, or it has no wildcard,
@@ -27,7 +27,7 @@ module.exports = class ExpandNpmWildcard {
         return this.scripts
             .filter(script => wildcardRegex.test(script))
             .map(script => Object.assign({}, commandInfo, {
-                command: `npm run ${script}${args}`,
+                command: `${npmCmd} run ${script}${args}`,
                 name: script
             }));
     }

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

@@ -31,24 +31,28 @@ it('expands to nothing if no scripts exist in package.json', () => {
     expect(parser.parse({ command: 'npm run foo-*-baz qux' })).toEqual([]);
 });
 
-it('expands to all scripts matching pattern', () => {
-    readPkg.mockReturnValue({
-        scripts: {
-            'foo-bar-baz': '',
-            'foo--baz': '',
-        }
+for (const npmCmd of ['npm', 'yarn']) {
+    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);
+        });
     });
-
-    expect(parser.parse({ command: 'npm run foo-*-baz qux' })).toEqual([
-        { name: 'foo-bar-baz', command: 'npm run foo-bar-baz qux' },
-        { name: 'foo--baz', command: 'npm run foo--baz qux' },
-    ]);
-});
-
-it('caches scripts upon calls', () => {
-    readPkg.mockReturnValue({});
-    parser.parse({ command: 'npm run foo-*-baz qux' });
-    parser.parse({ command: 'npm run foo-*-baz qux' });
-
-    expect(readPkg).toHaveBeenCalledTimes(1);
-});
+}

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

@@ -13,6 +13,16 @@ beforeEach(() => {
     controller = new KillOnSignal({ process });
 });
 
+it('returns commands that keep non-close streams from original commands', () => {
+    const newCommands = controller.handle(commands);
+    newCommands.forEach((newCommand, i) => {
+        expect(newCommand.close).not.toBe(commands[i].close);
+        expect(newCommand.error).toBe(commands[i].error);
+        expect(newCommand.stdout).toBe(commands[i].stdout);
+        expect(newCommand.stderr).toBe(commands[i].stderr);
+    });
+});
+
 it('returns commands that map SIGINT to exit code 0', () => {
     const newCommands = controller.handle(commands);
     expect(newCommands).not.toBe(commands);
@@ -29,6 +39,18 @@ it('returns commands that map SIGINT to exit code 0', () => {
     expect(callback).toHaveBeenCalledWith(0);
 });
 
+it('returns commands that keep non-SIGINT exit codes', () => {
+    const newCommands = controller.handle(commands);
+    expect(newCommands).not.toBe(commands);
+    expect(newCommands).toHaveLength(commands.length);
+
+    const callback = jest.fn();
+    newCommands[0].close.subscribe(callback);
+    commands[0].close.next(1);
+
+    expect(callback).toHaveBeenCalledWith(1);
+});
+
 it('kills all commands on SIGINT', () => {
     controller.handle(commands);
     process.emit('SIGINT');

package/src/flow-control/restart-process.spec.js

@@ -116,4 +116,14 @@ describe('returned commands', () => {
         // 1 failure from commands[0], 1 success from commands[1]
         expect(callback).toHaveBeenCalledTimes(2);
     });
+
+    it('keep non-close streams from original commands', () => {
+        const newCommands = controller.handle(commands);
+        newCommands.forEach((newCommand, i) => {
+            expect(newCommand.close).not.toBe(commands[i].close);
+            expect(newCommand.error).toBe(commands[i].error);
+            expect(newCommand.stdout).toBe(commands[i].stdout);
+            expect(newCommand.stderr).toBe(commands[i].stderr);
+        });
+    });
 });