concurrently 6.5.1 → 7.2.0

package/dist/src/flow-control/log-timings.js

@@ -0,0 +1,88 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.LogTimings = void 0;
+const format_1 = __importDefault(require("date-fns/format"));
+const lodash_1 = __importDefault(require("lodash"));
+const Rx = __importStar(require("rxjs"));
+const operators_1 = require("rxjs/operators");
+const defaults = __importStar(require("../defaults"));
+/**
+ * Logs timing information about commands as they start/stop and then a summary when all commands finish.
+ */
+class LogTimings {
+    constructor({ logger, timestampFormat = defaults.timestampFormat }) {
+        this.logger = logger;
+        this.timestampFormat = timestampFormat;
+    }
+    static mapCloseEventToTimingInfo({ command, timings, killed, exitCode }) {
+        const readableDurationMs = (timings.endDate.getTime() - timings.startDate.getTime()).toLocaleString();
+        return {
+            name: command.name,
+            duration: readableDurationMs,
+            'exit code': exitCode,
+            killed,
+            command: command.command,
+        };
+    }
+    printExitInfoTimingTable(exitInfos) {
+        var _a, _b;
+        const exitInfoTable = (0, lodash_1.default)(exitInfos)
+            .sortBy(({ timings }) => timings.durationSeconds)
+            .reverse()
+            .map(LogTimings.mapCloseEventToTimingInfo)
+            .value();
+        (_a = this.logger) === null || _a === void 0 ? void 0 : _a.logGlobalEvent('Timings:');
+        (_b = this.logger) === null || _b === void 0 ? void 0 : _b.logTable(exitInfoTable);
+        return exitInfos;
+    }
+    ;
+    handle(commands) {
+        if (!this.logger) {
+            return { commands };
+        }
+        // individual process timings
+        commands.forEach(command => {
+            command.timer.subscribe(({ startDate, endDate }) => {
+                var _a, _b;
+                if (!endDate) {
+                    const formattedStartDate = (0, format_1.default)(startDate, this.timestampFormat);
+                    (_a = this.logger) === null || _a === void 0 ? void 0 : _a.logCommandEvent(`${command.command} started at ${formattedStartDate}`, command);
+                }
+                else {
+                    const durationMs = endDate.getTime() - startDate.getTime();
+                    const formattedEndDate = (0, format_1.default)(endDate, this.timestampFormat);
+                    (_b = this.logger) === null || _b === void 0 ? void 0 : _b.logCommandEvent(`${command.command} stopped at ${formattedEndDate} after ${durationMs.toLocaleString()}ms`, command);
+                }
+            });
+        });
+        // overall summary timings
+        const closeStreams = commands.map(command => command.close);
+        const allProcessesClosed = Rx.merge(...closeStreams).pipe((0, operators_1.bufferCount)(closeStreams.length), (0, operators_1.take)(1));
+        allProcessesClosed.subscribe((exitInfos) => this.printExitInfoTimingTable(exitInfos));
+        return { commands };
+    }
+}
+exports.LogTimings = LogTimings;
+;

package/dist/src/flow-control/restart-process.d.ts

@@ -0,0 +1,22 @@
+import * as Rx from 'rxjs';
+import { Command } from '../command';
+import { Logger } from '../logger';
+import { FlowController } from './flow-controller';
+/**
+ * Restarts commands that fail up to a defined number of times.
+ */
+export declare class RestartProcess implements FlowController {
+    private readonly logger;
+    private readonly scheduler?;
+    readonly delay: number;
+    readonly tries: number;
+    constructor({ delay, tries, logger, scheduler }: {
+        delay?: number;
+        tries?: number;
+        logger: Logger;
+        scheduler?: Rx.SchedulerLike;
+    });
+    handle(commands: Command[]): {
+        commands: Command[];
+    };
+}

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

@@ -0,0 +1,71 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestartProcess = void 0;
+const Rx = __importStar(require("rxjs"));
+const operators_1 = require("rxjs/operators");
+const defaults = __importStar(require("../defaults"));
+/**
+ * Restarts commands that fail up to a defined number of times.
+ */
+class RestartProcess {
+    constructor({ delay, tries, logger, scheduler }) {
+        this.logger = logger;
+        this.delay = delay != null ? +delay : defaults.restartDelay;
+        this.tries = tries != null ? +tries : defaults.restartTries;
+        this.tries = this.tries < 0 ? Infinity : this.tries;
+        this.scheduler = scheduler;
+    }
+    handle(commands) {
+        if (this.tries === 0) {
+            return { commands };
+        }
+        commands.map(command => command.close.pipe((0, operators_1.take)(this.tries), (0, operators_1.takeWhile)(({ exitCode }) => exitCode !== 0))).map((failure, index) => Rx.merge(
+        // Delay the emission (so that the restarts happen on time),
+        // explicitly telling the subscriber that a restart is needed
+        failure.pipe((0, operators_1.delay)(this.delay, this.scheduler), (0, operators_1.mapTo)(true)), 
+        // Skip the first N emissions (as these would be duplicates of the above),
+        // meaning it will be empty because of success, or failed all N times,
+        // and no more restarts should be attempted.
+        failure.pipe((0, operators_1.skip)(this.tries), (0, operators_1.mapTo)(false), (0, operators_1.defaultIfEmpty)(false))).subscribe(restart => {
+            const command = commands[index];
+            if (restart) {
+                this.logger.logCommandEvent(`${command.command} restarted`, command);
+                command.start();
+            }
+        }));
+        return {
+            commands: commands.map(command => {
+                const closeStream = command.close.pipe((0, operators_1.filter)(({ exitCode }, emission) => {
+                    // We let all success codes pass, and failures only after restarting won't happen again
+                    return exitCode === 0 || emission >= this.tries;
+                }));
+                return new Proxy(command, {
+                    get(target, prop) {
+                        return prop === 'close' ? closeStream : target[prop];
+                    },
+                });
+            }),
+        };
+    }
+}
+exports.RestartProcess = RestartProcess;
+;

package/dist/src/get-spawn-opts.d.ts

@@ -0,0 +1,30 @@
+/// <reference types="node" />
+import { SpawnOptions } from 'child_process';
+import supportsColor from 'supports-color';
+export declare const getSpawnOpts: ({ colorSupport, cwd, process, raw, env, }: {
+    /**
+     * What the color support of the spawned processes should be.
+     * If set to `false`, then no colors should be output.
+     *
+     * Defaults to whatever the terminal's stdout support is.
+     */
+    colorSupport?: Pick<supportsColor.supportsColor.Level, 'level'> | false;
+    /**
+     * The NodeJS process.
+     */
+    process?: Pick<NodeJS.Process, 'cwd' | 'platform' | 'env'>;
+    /**
+     * A custom working directory to spawn processes in.
+     * Defaults to `process.cwd()`.
+     */
+    cwd?: string;
+    /**
+     * Whether to customize the options for spawning processes in raw mode.
+     * Defaults to false.
+     */
+    raw?: boolean;
+    /**
+     * Map of custom environment variables to include in the spawn options.
+     */
+    env?: Record<string, any>;
+}) => SpawnOptions;

package/dist/src/get-spawn-opts.js

@@ -0,0 +1,11 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getSpawnOpts = void 0;
+const supports_color_1 = __importDefault(require("supports-color"));
+const getSpawnOpts = ({ colorSupport = supports_color_1.default.stdout, cwd, process = global.process, raw = false, env = {}, }) => Object.assign({
+    cwd: cwd || process.cwd(),
+}, raw && { stdio: 'inherit' }, /^win/.test(process.platform) && { detached: false }, { env: Object.assign(colorSupport ? { FORCE_COLOR: colorSupport.level } : {}, process.env, env) });
+exports.getSpawnOpts = getSpawnOpts;

package/dist/src/index.d.ts

@@ -0,0 +1,74 @@
+/// <reference types="node" />
+import { Readable } from 'stream';
+import { CloseEvent, Command, CommandIdentifier, TimerEvent } from './command';
+import { concurrently, ConcurrentlyCommandInput, ConcurrentlyOptions as BaseConcurrentlyOptions, ConcurrentlyResult } from './concurrently';
+import { FlowController } from './flow-control/flow-controller';
+import { InputHandler } from './flow-control/input-handler';
+import { KillOnSignal } from './flow-control/kill-on-signal';
+import { KillOthers, ProcessCloseCondition } from './flow-control/kill-others';
+import { LogError } from './flow-control/log-error';
+import { LogExit } from './flow-control/log-exit';
+import { LogOutput } from './flow-control/log-output';
+import { LogTimings } from './flow-control/log-timings';
+import { RestartProcess } from './flow-control/restart-process';
+import { Logger } from './logger';
+export declare type ConcurrentlyOptions = BaseConcurrentlyOptions & {
+    /**
+     * Which command(s) should have their output hidden.
+     */
+    hide?: CommandIdentifier | CommandIdentifier[];
+    /**
+     * The prefix format to use when logging a command's output.
+     * Defaults to the command's index.
+     */
+    prefix?: string;
+    /**
+     * How many characters should a prefix have at most, used when the prefix format is `command`.
+     */
+    prefixLength?: number;
+    /**
+     * Whether output should be formatted to include prefixes and whether "event" logs will be logged.
+     */
+    raw?: boolean;
+    /**
+     * Date format used when logging date/time.
+     * @see https://date-fns.org/v2.0.1/docs/format
+     */
+    timestampFormat?: string;
+    defaultInputTarget?: CommandIdentifier;
+    inputStream?: Readable;
+    handleInput?: boolean;
+    pauseInputStreamOnFinish?: boolean;
+    /**
+     * How much time in milliseconds to wait before restarting a command.
+     *
+     * @see RestartProcess
+     */
+    restartDelay?: number;
+    /**
+     * How many times commands should be restarted when they exit with a failure.
+     *
+     * @see RestartProcess
+     */
+    restartTries?: number;
+    /**
+     * Under which condition(s) should other commands be killed when the first one exits.
+     *
+     * @see KillOthers
+     */
+    killOthers?: ProcessCloseCondition | ProcessCloseCondition[];
+    /**
+     * Whether to output timing information for processes.
+     *
+     * @see LogTimings
+     */
+    timings?: boolean;
+    /**
+     * List of additional arguments passed that will get replaced in each command.
+     * If not defined, no argument replacing will happen.
+     */
+    additionalArguments?: string[];
+};
+declare const _default: (commands: ConcurrentlyCommandInput[], options?: Partial<ConcurrentlyOptions>) => ConcurrentlyResult;
+export default _default;
+export { concurrently, ConcurrentlyCommandInput, ConcurrentlyResult, Logger, Command, CloseEvent, TimerEvent, CommandIdentifier, FlowController, InputHandler, KillOnSignal, KillOthers, LogError, LogExit, LogOutput, LogTimings, RestartProcess, };

package/dist/src/index.js

@@ -0,0 +1,70 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.RestartProcess = exports.LogTimings = exports.LogOutput = exports.LogExit = exports.LogError = exports.KillOthers = exports.KillOnSignal = exports.InputHandler = exports.Command = exports.Logger = exports.concurrently = void 0;
+const command_1 = require("./command");
+Object.defineProperty(exports, "Command", { enumerable: true, get: function () { return command_1.Command; } });
+const concurrently_1 = require("./concurrently");
+Object.defineProperty(exports, "concurrently", { enumerable: true, get: function () { return concurrently_1.concurrently; } });
+const input_handler_1 = require("./flow-control/input-handler");
+Object.defineProperty(exports, "InputHandler", { enumerable: true, get: function () { return input_handler_1.InputHandler; } });
+const kill_on_signal_1 = require("./flow-control/kill-on-signal");
+Object.defineProperty(exports, "KillOnSignal", { enumerable: true, get: function () { return kill_on_signal_1.KillOnSignal; } });
+const kill_others_1 = require("./flow-control/kill-others");
+Object.defineProperty(exports, "KillOthers", { enumerable: true, get: function () { return kill_others_1.KillOthers; } });
+const log_error_1 = require("./flow-control/log-error");
+Object.defineProperty(exports, "LogError", { enumerable: true, get: function () { return log_error_1.LogError; } });
+const log_exit_1 = require("./flow-control/log-exit");
+Object.defineProperty(exports, "LogExit", { enumerable: true, get: function () { return log_exit_1.LogExit; } });
+const log_output_1 = require("./flow-control/log-output");
+Object.defineProperty(exports, "LogOutput", { enumerable: true, get: function () { return log_output_1.LogOutput; } });
+const log_timings_1 = require("./flow-control/log-timings");
+Object.defineProperty(exports, "LogTimings", { enumerable: true, get: function () { return log_timings_1.LogTimings; } });
+const restart_process_1 = require("./flow-control/restart-process");
+Object.defineProperty(exports, "RestartProcess", { enumerable: true, get: function () { return restart_process_1.RestartProcess; } });
+const logger_1 = require("./logger");
+Object.defineProperty(exports, "Logger", { enumerable: true, get: function () { return logger_1.Logger; } });
+exports.default = (commands, options = {}) => {
+    const logger = new logger_1.Logger({
+        hide: options.hide,
+        prefixFormat: options.prefix,
+        prefixLength: options.prefixLength,
+        raw: options.raw,
+        timestampFormat: options.timestampFormat,
+    });
+    return (0, concurrently_1.concurrently)(commands, {
+        maxProcesses: options.maxProcesses,
+        raw: options.raw,
+        successCondition: options.successCondition,
+        cwd: options.cwd,
+        logger,
+        outputStream: options.outputStream || process.stdout,
+        group: options.group,
+        controllers: [
+            new log_error_1.LogError({ logger }),
+            new log_output_1.LogOutput({ logger }),
+            new log_exit_1.LogExit({ logger }),
+            new input_handler_1.InputHandler({
+                logger,
+                defaultInputTarget: options.defaultInputTarget,
+                inputStream: options.inputStream || (options.handleInput && process.stdin),
+                pauseInputStreamOnFinish: options.pauseInputStreamOnFinish,
+            }),
+            new kill_on_signal_1.KillOnSignal({ process }),
+            new restart_process_1.RestartProcess({
+                logger,
+                delay: options.restartDelay,
+                tries: options.restartTries,
+            }),
+            new kill_others_1.KillOthers({
+                logger,
+                conditions: options.killOthers,
+            }),
+            new log_timings_1.LogTimings({
+                logger: options.timings ? logger : null,
+                timestampFormat: options.timestampFormat,
+            }),
+        ],
+        prefixColors: options.prefixColors || [],
+        additionalArguments: options.additionalArguments,
+    });
+};

package/dist/src/logger.d.ts

@@ -0,0 +1,72 @@
+import * as Rx from 'rxjs';
+import { Command, CommandIdentifier } from './command';
+export declare class Logger {
+    private readonly hide;
+    private readonly raw;
+    private readonly prefixFormat?;
+    private readonly prefixLength;
+    private readonly timestampFormat;
+    /**
+     * Last character emitted.
+     * If `undefined`, then nothing has been logged yet.
+     */
+    private lastChar?;
+    /**
+     * Observable that emits when there's been output logged.
+     * If `command` is is `undefined`, then the log is for a global event.
+     */
+    readonly output: Rx.Subject<{
+        command: Command | undefined;
+        text: string;
+    }>;
+    constructor({ hide, prefixFormat, prefixLength, raw, timestampFormat }: {
+        /**
+         * Which command(s) should have their output hidden.
+         */
+        hide?: CommandIdentifier | CommandIdentifier[];
+        /**
+         * Whether output should be formatted to include prefixes and whether "event" logs will be
+         * logged.
+         */
+        raw?: boolean;
+        /**
+         * The prefix format to use when logging a command's output.
+         * Defaults to the command's index.
+         */
+        prefixFormat?: string;
+        /**
+         * How many characters should a prefix have at most, used when the prefix format is `command`.
+         */
+        prefixLength?: number;
+        /**
+         * Date format used when logging date/time.
+         * @see https://date-fns.org/v2.0.1/docs/format
+         */
+        timestampFormat?: string;
+    });
+    private shortenText;
+    private getPrefixesFor;
+    getPrefix(command: Command): string;
+    colorText(command: Command, text: string): string;
+    /**
+     * Logs an event for a command (e.g. start, stop).
+     *
+     * If raw mode is on, then nothing is logged.
+     */
+    logCommandEvent(text: string, command: Command): void;
+    logCommandText(text: string, command: Command): void;
+    /**
+     * Logs a global event (e.g. sending signals to processes).
+     *
+     * If raw mode is on, then nothing is logged.
+     */
+    logGlobalEvent(text: string): void;
+    /**
+     * Logs a table from an input object array, like `console.table`.
+     *
+     * Each row is a single input item, and they are presented in the input order.
+     */
+    logTable(tableContents: any[]): void;
+    log(prefix: string, text: string, command?: Command): void;
+    emit(command: Command | undefined, text: string): void;
+}