@travetto/cli 4.0.0-rc.6 → 4.0.0-rc.8

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cli",
-  "version": "4.0.0-rc.6",
+  "version": "4.0.0-rc.8",
   "description": "CLI infrastructure for Travetto framework",
   "keywords": [
     "cli",
@@ -29,8 +29,8 @@
     "directory": "module/cli"
   },
   "dependencies": {
-    "@travetto/schema": "^4.0.0-rc.6",
-    "@travetto/terminal": "^4.0.0-rc.6"
+    "@travetto/schema": "^4.0.0-rc.8",
+    "@travetto/terminal": "^4.0.0-rc.8"
   },
   "travetto": {
     "displayName": "Command Line Interface",

package/src/error.ts

@@ -1,6 +1,6 @@
 import { PackageUtil, RuntimeContext } from '@travetto/manifest';
 import { cliTpl } from './color';
-import { CliValidationError } from './types';
+import { CliValidationError, CliCommandShape } from './types';
 
 const COMMAND_PACKAGE = [
   [/^test(:watch)?$/, 'test', false],
@@ -50,9 +50,11 @@ ${{ identifier: install }}
  */
 export class CliValidationResultError extends Error {
   errors: CliValidationError[];
+  command: CliCommandShape;
 
-  constructor(errors: CliValidationError[]) {
+  constructor(command: CliCommandShape, errors: CliValidationError[]) {
     super('');
+    this.command = command;
     this.errors = errors;
   }
 }

package/src/execute.ts

@@ -1,7 +1,6 @@
 import { ConsoleManager, Env, ShutdownManager } from '@travetto/base';
 
 import { HelpUtil } from './help';
-import { CliCommandShape } from './types';
 import { CliCommandRegistry } from './registry';
 import { CliCommandSchemaUtil } from './schema';
 import { CliUnknownCommandError, CliValidationResultError } from './error';
@@ -13,51 +12,44 @@ import { CliUtil } from './util';
  */
 export class ExecutionManager {
 
-  /** Prepare command for execution */
-  static async #prepareAndBind(cmd: CliCommandShape, args: string[]): Promise<unknown[]> {
-    const schema = await CliCommandSchemaUtil.getSchema(cmd);
-    args = await CliParseUtil.expandArgs(schema, args);
-    cmd._parsed = await CliParseUtil.parse(schema, args);
-
-    await cmd.preBind?.();
-    try {
-      const known = await CliCommandSchemaUtil.bindInput(cmd, cmd._parsed);
-
-      await cmd.preValidate?.();
-      await CliCommandSchemaUtil.validate(cmd, known);
-
-      await cmd._cfg!.preMain?.(cmd);
-      await cmd.preMain?.();
-
-      return known;
-    } catch (err) {
-      if (err instanceof CliValidationResultError) {
-        console.error!(await HelpUtil.renderValidationError(cmd, err));
-        console.error!(await HelpUtil.renderCommandHelp(cmd));
-        process.exit(1);
+  /** Error handler */
+  static async #onError(err: unknown): Promise<void> {
+    process.exitCode ??= 1;
+    if (err instanceof CliValidationResultError) {
+      console.error!(await HelpUtil.renderValidationError(err));
+      console.error!(await HelpUtil.renderCommandHelp(err.command));
+    } else if (err instanceof CliUnknownCommandError) {
+      if (err.help) {
+        console.error!(err.help);
       } else {
-        throw err;
+        console.error!(err.defaultMessage, '\n');
+        console.error!(await HelpUtil.renderAllHelp(''));
       }
+    } else {
+      console.error!(err);
     }
+    console.error!();
   }
 
-  /** Fetch a single command */
-  static async #getCommand(cmd: string): Promise<CliCommandShape> {
-    try {
-      return await CliCommandRegistry.getInstance(cmd, true);
-    } catch (err) {
-      if (err instanceof CliUnknownCommandError) {
-        if (err.help) {
-          console.error!(err.help);
-        } else {
-          console.error!(err.defaultMessage, '\n');
-          console.error!(await HelpUtil.renderAllHelp(''));
-        }
-        process.exit(1);
-      } else {
-        throw err;
-      }
-    }
+  /** Run command */
+  static async #runCommand(cmd: string, args: string[]): Promise<void> {
+    const command = await CliCommandRegistry.getInstance(cmd, true);
+    const schema = await CliCommandSchemaUtil.getSchema(command);
+    const fullArgs = await CliParseUtil.expandArgs(schema, args);
+    const state = command._parsed = await CliParseUtil.parse(schema, fullArgs);
+
+    await command.preBind?.();
+    const boundArgs = await CliCommandSchemaUtil.bindInput(command, state);
+
+    await command.preValidate?.();
+    await CliCommandSchemaUtil.validate(command, boundArgs);
+
+    await command._cfg!.preMain?.(command);
+    await command.preMain?.();
+
+    ConsoleManager.debug(Env.debug);
+    const result = await command.main(...boundArgs);
+    await CliUtil.listenForResponse(result);
   }
 
   /**
@@ -67,29 +59,17 @@ export class ExecutionManager {
   static async run(argv: string[]): Promise<void> {
     try {
       const { cmd, args, help } = CliParseUtil.getArgs(argv);
-
       if (!cmd) {
         console.info!(await HelpUtil.renderAllHelp());
-        return;
-      }
-
-      const command = await this.#getCommand(cmd);
-
-      if (help) {
-        console.log!(await HelpUtil.renderCommandHelp(command));
-        return;
+      } else if (help) {
+        console.log!(await HelpUtil.renderCommandHelp(cmd));
       } else {
-        const known = await this.#prepareAndBind(command, args);
-        ConsoleManager.debug(Env.debug);
-        const result = await command.main(...known);
-        await CliUtil.listenForResponse(result);
+        await this.#runCommand(cmd, args);
       }
     } catch (err) {
-      process.exitCode ??= 1;
-      console.error!(err);
-      console.error!();
+      await this.#onError(err);
     } finally {
-      await ShutdownManager.gracefulShutdown(process.exitCode);
+      await ShutdownManager.gracefulShutdown();
     }
   }
 }

package/src/help.ts

@@ -23,7 +23,8 @@ export class HelpUtil {
    * Render command-specific help
    * @param command
    */
-  static async renderCommandHelp(command: CliCommandShape): Promise<string> {
+  static async renderCommandHelp(cmd: CliCommandShape | string): Promise<string> {
+    const command = typeof cmd === 'string' ? await CliCommandRegistry.getInstance(cmd, true) : cmd;
     const commandName = CliCommandRegistry.getName(command);
 
     await command.preHelp?.();
@@ -130,7 +131,7 @@ export class HelpUtil {
   /**
    * Render validation error to a string
    */
-  static renderValidationError(cmd: CliCommandShape, err: CliValidationResultError): string {
+  static renderValidationError(err: CliValidationResultError): string {
     return [
       cliTpl`${{ failure: 'Execution failed' }}:`,
       ...err.errors.map(e => e.source && e.source !== 'custom' ?

package/src/schema.ts

@@ -171,7 +171,7 @@ export class CliCommandSchemaUtil {
       async (): Promise<void> => {
         const res = await cmd.validate?.(...args);
         if (res) {
-          throw new CliValidationResultError(Array.isArray(res) ? res : [res]);
+          throw new CliValidationResultError(cmd, Array.isArray(res) ? res : [res]);
         }
       },
     ];
@@ -187,7 +187,7 @@ export class CliCommandSchemaUtil {
 
     const errors = (await Promise.all(results)).flatMap(x => (x ?? []));
     if (errors.length) {
-      throw new CliValidationResultError(errors);
+      throw new CliValidationResultError(cmd, errors);
     }
     return cmd;
   }

package/src/util.ts

@@ -28,7 +28,10 @@ export class CliUtil {
   /**
    * Run a command as restartable, linking into self
    */
-  static runWithRestart<T extends CliCommandShapeFields & CliCommandShape>(cmd: T): Promise<unknown> | undefined {
+  static runWithRestart<T extends CliCommandShapeFields & CliCommandShape>(cmd: T, ipc?: boolean): Promise<unknown> | undefined {
+    if (ipc && process.connected) {
+      ExecUtil.exitOnDisconnect();
+    }
     if (Env.TRV_CAN_RESTART.isFalse || !(cmd.canRestart ?? !Env.production)) {
       Env.TRV_CAN_RESTART.clear();
       return;
@@ -38,7 +41,7 @@ export class CliUtil {
         ...process.env,
         ...Env.TRV_CAN_RESTART.export(false)
       },
-      stdio: [0, 1, 2, 'ipc']
+      stdio: [0, 1, 2, ipc ? 'ipc' : undefined]
     }));
   }