revert modified comments in codebase

src/command.ts

@@ -2,39 +2,59 @@ import { ChildProcess as BaseChildProcess, SpawnOptions } from 'child_process';
 import * as Rx from 'rxjs';
 import { EventEmitter, Writable } from 'stream';
 
-/** Identifier for a command; if string, it's the command's name, if number, it's the index.*/
+/**
+ * Identifier for a command; if string, it's the command's name, if number, it's the index.
+ */
 export type CommandIdentifier = string | number;
 
 export interface CommandInfo {
-    /**  Command's name. */
+    /**
+     * Command's name.
+     */
     name: string;
 
-    /** Which command line the command has. */
+    /**
+     * Which command line the command has.
+     */
     command: string;
 
-    /** Which environment variables should the spawned process have.*/
+    /**
+     * Which environment variables should the spawned process have.
+     */
     env?: Record<string, unknown>;
 
-    /** The current working directory of the process when spawned.*/
+    /**
+     * The current working directory of the process when spawned.
+     */
     cwd?: string;
 
-    /** Color to use on prefix of the command.*/
+    /**
+     * Color to use on prefix of the command.
+     */
     prefixColor?: string;
 
-    /** Output command in raw format.*/
+    /**
+     * Output command in raw format.
+     */
     raw?: boolean;
 }
 
 export interface CloseEvent {
     command: CommandInfo;
 
-    /** The command's index among all commands ran.*/
+    /**
+     * The command's index among all commands ran.
+     */
     index: number;
 
-    /** Whether the command exited because it was killed.*/
+    /**
+     * Whether the command exited because it was killed.
+     */
     killed: boolean;
 
-    /** The exit code or signal for the command.*/
+    /**
+     * The exit code or signal for the command.
+     */
     exitCode: string | number;
     timings: {
         startDate: Date;
@@ -48,14 +68,20 @@ export interface TimerEvent {
     endDate?: Date;
 }
 
-/** Subtype of NodeJS's child_process including only what's actually needed for a command to work. */
+/**
+ * Subtype of NodeJS's child_process including only what's actually needed for a command to work.
+ */
 export type ChildProcess = EventEmitter &
     Pick<BaseChildProcess, 'pid' | 'stdin' | 'stdout' | 'stderr'>;
 
-/** Interface for a function that must kill the process with `pid`, optionally sending `signal` to it. */
+/**
+ * Interface for a function that must kill the process with `pid`, optionally sending `signal` to it.
+ */
 export type KillProcess = (pid: number, signal?: string) => void;
 
-/** Interface for a function that spawns a command and returns its child process instance. */
+/**
+ * Interface for a function that spawns a command and returns its child process instance.
+ */
 export type SpawnCommand = (command: string, options: SpawnOptions) => ChildProcess;
 
 export class Command implements CommandInfo {
@@ -113,7 +139,9 @@ export class Command implements CommandInfo {
         this.spawnOpts = spawnOpts;
     }
 
-    /** Starts this command, piping output, error and close events onto the corresponding observables. */
+    /**
+     * Starts this command, piping output, error and close events onto the corresponding observables.
+     */
     start() {
         const child = this.spawn(this.command, this.spawnOpts);
         this.process = child;
@@ -162,7 +190,9 @@ export class Command implements CommandInfo {
         this.stdin = child.stdin || undefined;
     }
 
-    /** Kills this command, optionally specifying a signal to send to it. */
+    /**
+     * Kills this command, optionally specifying a signal to send to it.
+     */
     kill(code?: string) {
         if (Command.canKill(this)) {
             this.killed = true;
@@ -180,7 +210,9 @@ export class Command implements CommandInfo {
     }
 }
 
-/** Pipes all events emitted by `stream` into `subject`.s */
+/**
+ * Pipes all events emitted by `stream` into `subject`.
+ */
 function pipeTo<T>(stream: Rx.Observable<T>, subject: Rx.Subject<T>) {
     stream.subscribe((event) => subject.next(event));
 }

src/completion-listener.ts

@@ -19,7 +19,9 @@ export type SuccessCondition =
     | `command-${string | number}`
     | `!command-${string | number}`;
 
-/** Provides logic to determine whether lists of commands ran successfully. */
+/**
+ * Provides logic to determine whether lists of commands ran successfully.
+ */
 export class CompletionListener {
     private readonly successCondition: SuccessCondition;
     private readonly scheduler?: Rx.SchedulerLike;
@@ -36,7 +38,9 @@ export class CompletionListener {
          */
         successCondition?: SuccessCondition;
 
-        /** For testing only.*/
+        /**
+         * For testing only.
+         */
         scheduler?: Rx.SchedulerLike;
     }) {
         this.successCondition = successCondition;

src/concurrently.ts

@@ -34,7 +34,9 @@ const defaults: ConcurrentlyOptions = {
 export type ConcurrentlyCommandInput = string | ({ command: string } & Partial<CommandInfo>);
 
 export type ConcurrentlyResult = {
-    /** All commands created and ran by concurrently.*/
+    /**
+     * All commands created and ran by concurrently.
+     */
     commands: Command[];
 
     /**
@@ -49,10 +51,14 @@ export type ConcurrentlyResult = {
 export type ConcurrentlyOptions = {
     logger?: Logger;
 
-    /** Which stream should the commands output be written to. */
+    /**
+     * Which stream should the commands output be written to.
+     */
     outputStream?: Writable;
 
-    /** Whether the output should be ordered as if the commands were run sequentially.*/
+    /**
+     * Whether the output should be ordered as if the commands were run sequentially.
+     */
     group?: boolean;
 
     /**

src/defaults.ts

@@ -6,19 +6,29 @@ import { SuccessCondition } from './completion-listener';
 
 export const defaultInputTarget = 0;
 
-/** Whether process.stdin should be forwarded to child processes. */
+/**
+ * Whether process.stdin should be forwarded to child processes.
+ */
 export const handleInput = false;
 
-/** How many processes to run at once. */
+/**
+ * How many processes to run at once.
+ */
 export const maxProcesses = 0;
 
-/** Indices and names of commands whose output are not to be logged. */
+/**
+ * Indices and names of commands whose output are not to be logged.
+ */
 export const hide = '';
 
-/** The character to split <names> on.*/
+/**
+ * The character to split <names> on.
+ */
 export const nameSeparator = ',';
 
-/** Which prefix style to use when logging processes output.*/
+/**
+ * Which prefix style to use when logging processes output.
+ */
 export const prefix = '';
 
 /**
@@ -27,18 +37,26 @@ export const prefix = '';
  */
 export const prefixColors = 'reset';
 
-/** How many bytes we'll show on the command prefix.*/
+/**
+ * How many bytes we'll show on the command prefix.
+ */
 export const prefixLength = 10;
 
 export const raw = false;
 
-/** Number of attempts of restarting a process, if it exits with non-0 code. */
+/**
+ * Number of attempts of restarting a process, if it exits with non-0 code.
+ */
 export const restartTries = 0;
 
-/** How many milliseconds concurrently should wait before restarting a process. */
+/**
+ * How many milliseconds concurrently should wait before restarting a process.
+ */
 export const restartDelay = 0;
 
-/** Condition of success for concurrently itself. */
+/**
+ * Condition of success for concurrently itself.
+ */
 export const success = 'all' as SuccessCondition;
 
 /**
@@ -53,10 +71,14 @@ export const timestampFormat = 'yyyy-MM-dd HH:mm:ss.SSS';
  */
 export const cwd: string | undefined = undefined;
 
-/** Whether to show timing information for processes in console output. */
+/**
+ * Whether to show timing information for processes in console output.
+ */
 export const timings = false;
 
-/** Passthrough additional arguments to commands (accessible via placeholders) instead of treating them as commands. */
+/**
+ * Passthrough additional arguments to commands (accessible via placeholders) instead of treating them as commands.
+ */
 export const passthroughArguments = false;
 
 /**

src/get-spawn-opts.ts

@@ -16,7 +16,9 @@ export const getSpawnOpts = ({
      */
     colorSupport?: Pick<supportsColor.supportsColor.Level, 'level'> | false;
 
-    /** The NodeJS process. */
+    /**
+     * The NodeJS process.
+     */
     process?: Pick<NodeJS.Process, 'cwd' | 'platform' | 'env'>;
 
     /**
@@ -31,7 +33,9 @@ export const getSpawnOpts = ({
      */
     raw?: boolean;
 
-    /** Map of custom environment variables to include in the spawn options. */
+    /**
+     * Map of custom environment variables to include in the spawn options.
+     */
     env?: Record<string, unknown>;
 }): SpawnOptions => ({
     cwd: cwd || process.cwd(),

src/index.ts

@@ -18,9 +18,11 @@ import { LogTimings } from './flow-control/log-timings';
 import { RestartProcess } from './flow-control/restart-process';
 import { Logger } from './logger';
 
-/** Logger options  */
 export type ConcurrentlyOptions = BaseConcurrentlyOptions & {
-    /** Which command(s) should have their output hidden. */
+    // Logger options
+    /**
+     * Which command(s) should have their output hidden.
+     */
     hide?: CommandIdentifier | CommandIdentifier[];
 
     /**
@@ -29,10 +31,14 @@ export type ConcurrentlyOptions = BaseConcurrentlyOptions & {
      */
     prefix?: string;
 
-    /** How many characters should a prefix have at most, used when the prefix format is `command`. */
+    /**
+     * 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. */
+    /**
+     * Whether output should be formatted to include prefixes and whether "event" logs will be logged.
+     */
     raw?: boolean;
 
     /**

src/logger.ts

@@ -32,7 +32,9 @@ export class Logger {
         raw = false,
         timestampFormat,
     }: {
-        /** Which command(s) should have their output hidden. */
+        /**
+         * Which command(s) should have their output hidden.
+         */
         hide?: CommandIdentifier | CommandIdentifier[];
 
         /**
@@ -47,7 +49,9 @@ export class Logger {
          */
         prefixFormat?: string;
 
-        /** How many characters should a prefix have at most, used when the prefix format is `command`. */
+        /**
+         * How many characters should a prefix have at most, used when the prefix format is `command`.
+         */
         prefixLength?: number;
 
         /**