concurrently 7.4.0 → 7.5.0

package/README.md

@@ -191,8 +191,9 @@ Prefix styling
                           - Available modifiers: reset, bold, dim, italic,
                           underline, inverse, hidden, strikethrough
                           - Available colors: black, red, green, yellow, blue,
-                          magenta, cyan, white, gray
-                          or any hex values for colors, eg #23de43
+                          magenta, cyan, white, gray,
+                          any hex values for colors (e.g. #23de43) or auto for
+                          an automatically picked color
                           - Available background colors: bgBlack, bgRed,
                           bgGreen, bgYellow, bgBlue, bgMagenta, bgCyan, bgWhite
                           See https://www.npmjs.com/package/chalk for more
@@ -250,6 +251,14 @@ Examples:
      $ concurrently --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold"
      "http-server" "npm run watch"
 
+ - Auto varying colored prefixes
+
+     $ concurrently -c "auto" "npm run watch" "http-server"
+
+ - Mixing auto and manual colored prefixes
+
+     $ concurrently -c "red,auto" "npm run watch" "http-server" "echo hello"
+
  - Configuring via environment variables with CONCURRENTLY_ prefix
 
      $ CONCURRENTLY_RAW=true CONCURRENTLY_KILL_OTHERS=true concurrently "echo
@@ -324,12 +333,12 @@ For more details, visit https://github.com/open-cli-tools/concurrently
   - `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.
-  - `prefixColors`: a list of colors as supported by [chalk](https://www.npmjs.com/package/chalk).
-    If concurrently would run more commands than there are colors, the last color is repeated.
+  - `prefixColors`: a list of colors as supported by [chalk](https://www.npmjs.com/package/chalk) or `auto` for an automatically picked color.
+    If concurrently would run more commands than there are colors, the last color is repeated, unless if the last color value is `auto` which means following colors are automatically picked to vary.
     Prefix colors specified per-command take precedence over this list.
   - `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.
+    be logged, without any prefixes, coloring or extra stuff.
   - `successCondition`: the condition to consider the run was successful.
     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.

package/dist/bin/concurrently.js

@@ -87,7 +87,7 @@ const args = (0, yargs_1.default)(argsBeforeSep)
             'and concurrently coloring.',
         type: 'boolean',
     },
-    // This one is provided for free. Chalk reads this itself and removes colours.
+    // This one is provided for free. Chalk reads this itself and removes colors.
     // https://www.npmjs.com/package/chalk#chalksupportscolor
     'no-color': {
         describe: 'Disables colors from logging',
@@ -140,8 +140,8 @@ const args = (0, yargs_1.default)(argsBeforeSep)
         describe: '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' +
-            'or any hex values for colors, eg #23de43\n' +
+            '- Available colors: black, red, green, yellow, blue, magenta, cyan, white, gray, \n' +
+            'any hex values for colors (e.g. #23de43) or auto for an automatically picked color\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/dist/bin/epilogue.js

@@ -20,6 +20,14 @@ const examples = [
         description: 'Custom names and colored prefixes',
         example: '$ $0 --names "HTTP,WATCH" -c "bgBlue.bold,bgMagenta.bold" "http-server" "npm run watch"',
     },
+    {
+        description: 'Auto varying colored prefixes',
+        example: '$ $0 -c "auto" "npm run watch" "http-server"',
+    },
+    {
+        description: 'Mixing auto and manual colored prefixes',
+        example: '$ $0 -c "red,auto" "npm run watch" "http-server" "echo hello"',
+    },
     {
         description: 'Configuring via environment variables with CONCURRENTLY_ prefix',
         example: '$ CONCURRENTLY_RAW=true CONCURRENTLY_KILL_OTHERS=true $0 "echo hello" "echo world"',

package/dist/src/command.d.ts

@@ -27,7 +27,7 @@ export interface CommandInfo {
      */
     cwd?: string;
     /**
-     * Color to use on prefix of command.
+     * Color to use on prefix of the command.
      */
     prefixColor?: string;
 }

package/dist/src/concurrently.js

@@ -16,6 +16,7 @@ const strip_quotes_1 = require("./command-parser/strip-quotes");
 const completion_listener_1 = require("./completion-listener");
 const get_spawn_opts_1 = require("./get-spawn-opts");
 const output_writer_1 = require("./output-writer");
+const prefix_color_selector_1 = require("./prefix-color-selector");
 const defaults = {
     spawn: spawn_command_1.default,
     kill: tree_kill_1.default,
@@ -33,6 +34,7 @@ function concurrently(baseCommands, baseOptions) {
     assert_1.default.ok(Array.isArray(baseCommands), '[concurrently] commands should be an array');
     assert_1.default.notStrictEqual(baseCommands.length, 0, '[concurrently] no commands provided');
     const options = lodash_1.default.defaults(baseOptions, defaults);
+    const prefixColorSelector = new prefix_color_selector_1.PrefixColorSelector(options.prefixColors);
     const commandParsers = [
         new strip_quotes_1.StripQuotes(),
         new expand_npm_shortcut_1.ExpandNpmShortcut(),
@@ -41,16 +43,13 @@ function concurrently(baseCommands, baseOptions) {
     if (options.additionalArguments) {
         commandParsers.push(new expand_arguments_1.ExpandArguments(options.additionalArguments));
     }
-    let lastColor = '';
     let commands = (0, lodash_1.default)(baseCommands)
         .map(mapToCommandInfo)
         .flatMap((command) => parseCommand(command, commandParsers))
         .map((command, index) => {
-        // Use documented behaviour of repeating last color when specifying more commands than colors
-        lastColor = (options.prefixColors && options.prefixColors[index]) || lastColor;
         return new command_1.Command({
             index,
-            prefixColor: lastColor,
+            prefixColor: prefixColorSelector.getNextColor(),
             ...command,
         }, (0, get_spawn_opts_1.getSpawnOpts)({
             raw: options.raw,

package/dist/src/flow-control/input-handler.d.ts

@@ -25,9 +25,6 @@ export declare class InputHandler implements FlowController {
     });
     handle(commands: Command[]): {
         commands: Command[];
-        onFinish?: undefined;
-    } | {
-        commands: Command[];
-        onFinish: () => void;
+        onFinish?: () => void | undefined;
     };
 }

package/dist/src/prefix-color-selector.d.ts

@@ -0,0 +1,11 @@
+import chalk from 'chalk';
+export declare class PrefixColorSelector {
+    private colorGenerator;
+    constructor(customColors?: string[]);
+    /** A list of colors that are readable in a terminal. */
+    static get ACCEPTABLE_CONSOLE_COLORS(): ("stderr" | keyof chalk.Chalk | "supportsColor" | "Level" | "Color" | "ForegroundColor" | "BackgroundColor" | "Modifiers")[];
+    /**
+     * @returns The given custom colors then a set of acceptable console colors indefinitely.
+     */
+    getNextColor(): string;
+}

package/dist/src/prefix-color-selector.js

@@ -0,0 +1,92 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.PrefixColorSelector = void 0;
+function getConsoleColorsWithoutCustomColors(customColors) {
+    return PrefixColorSelector.ACCEPTABLE_CONSOLE_COLORS.filter(
+    // Consider the "Bright" variants of colors to be the same as the plain color to avoid similar colors
+    (color) => !customColors.includes(color.replace(/Bright$/, '')));
+}
+/**
+ * Creates a generator that yields an infinite stream of colors.
+ */
+function* createColorGenerator(customColors) {
+    // Custom colors should be used as is, except for "auto"
+    const nextAutoColors = getConsoleColorsWithoutCustomColors(customColors);
+    let lastColor;
+    for (const customColor of customColors) {
+        let currentColor = customColor;
+        if (currentColor !== 'auto') {
+            yield currentColor; // Manual color
+        }
+        else {
+            // Find the first auto color that is not the same as the last color
+            while (currentColor === 'auto' || lastColor === currentColor) {
+                if (!nextAutoColors.length) {
+                    // There could be more "auto" values than auto colors so this needs to be able to refill
+                    nextAutoColors.push(...PrefixColorSelector.ACCEPTABLE_CONSOLE_COLORS);
+                }
+                currentColor = nextAutoColors.shift();
+            }
+            yield currentColor; // Auto color
+        }
+        lastColor = currentColor;
+    }
+    const lastCustomColor = customColors[customColors.length - 1] || '';
+    if (lastCustomColor !== 'auto') {
+        while (true) {
+            yield lastCustomColor; // If last custom color was not "auto" then return same color forever, to maintain existing behaviour
+        }
+    }
+    // Finish the initial set(s) of auto colors to avoid repetition
+    for (const color of nextAutoColors) {
+        yield color;
+    }
+    // Yield an infinite stream of acceptable console colors
+    //
+    // If the given custom colors use every ACCEPTABLE_CONSOLE_COLORS except one then there is a chance a color will be repeated,
+    // however its highly unlikely and low consequence so not worth the extra complexity to account for it
+    while (true) {
+        for (const color of PrefixColorSelector.ACCEPTABLE_CONSOLE_COLORS) {
+            yield color; // Repeat colors forever
+        }
+    }
+}
+class PrefixColorSelector {
+    constructor(customColors = []) {
+        this.colorGenerator = createColorGenerator(customColors);
+    }
+    /** A list of colors that are readable in a terminal. */
+    static get ACCEPTABLE_CONSOLE_COLORS() {
+        // Colors picked randomly, can be amended if required
+        return [
+            // Prevent duplicates, in case the list becomes significantly large
+            ...new Set([
+                // Text colors
+                'cyan',
+                'yellow',
+                'greenBright',
+                'blueBright',
+                'magentaBright',
+                'white',
+                'grey',
+                'red',
+                // Background colors
+                'bgCyan',
+                'bgYellow',
+                'bgGreenBright',
+                'bgBlueBright',
+                'bgMagenta',
+                'bgWhiteBright',
+                'bgGrey',
+                'bgRed',
+            ]),
+        ];
+    }
+    /**
+     * @returns The given custom colors then a set of acceptable console colors indefinitely.
+     */
+    getNextColor() {
+        return this.colorGenerator.next().value;
+    }
+}
+exports.PrefixColorSelector = PrefixColorSelector;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "concurrently",
-  "version": "7.4.0",
+  "version": "7.5.0",
   "description": "Run commands concurrently",
   "main": "index.js",
   "types": "dist/src/index.d.ts",
@@ -63,7 +63,7 @@
     "@hirez_io/observer-spy": "^2.2.0",
     "@swc/core": "^1.2.224",
     "@swc/jest": "^0.2.21",
-    "@types/jest": "^28.1.6",
+    "@types/jest": "^28.1.8",
     "@types/lodash": "^4.14.178",
     "@types/node": "^16.11.47",
     "@types/shell-quote": "^1.7.1",
@@ -77,16 +77,16 @@
     "eslint": "^8.21.0",
     "eslint-config-prettier": "^8.5.0",
     "eslint-plugin-import": "^2.26.0",
-    "eslint-plugin-jest": "^26.8.2",
+    "eslint-plugin-jest": "^27.0.4",
     "eslint-plugin-prettier": "^4.0.0",
-    "eslint-plugin-simple-import-sort": "^7.0.0",
+    "eslint-plugin-simple-import-sort": "^8.0.0",
     "jest": "^28.1.3",
     "jest-create-mock-instance": "^2.0.0",
     "lint-staged": "^12.4.1",
     "prettier": "^2.6.2",
     "simple-git-hooks": "^2.7.0",
     "string-argv": "^0.3.1",
-    "typescript": "^4.5.4"
+    "typescript": "~4.8.3"
   },
   "files": [
     "dist",