@travetto/cli 5.0.0-rc.8 → 5.0.0-rc.9

package/README.md

@@ -132,9 +132,9 @@ HELLO
 
 The [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L85) supports the following data types for flags:
    *  Boolean values
-   *  Number values. The [@Integer](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L172), [@Float](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L178), [@Precision](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L166), [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L107) and [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L117) decorators help provide additional validation.
-   *  String values. [@MinLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L107), [@MaxLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L117), [@Match](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L99) and [@Enum](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L78) provide additional constraints
-   *  Date values. The [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L107) and [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L117) decorators help provide additional validation.
+   *  Number values. The [@Integer](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L171), [@Float](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L177), [@Precision](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L165), [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L106) and [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L116) decorators help provide additional validation.
+   *  String values. [@MinLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L106), [@MaxLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L116), [@Match](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L98) and [@Enum](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L77) provide additional constraints
+   *  Date values. The [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L106) and [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L116) decorators help provide additional validation.
    *  String lists. Same as String, but allowing multiple values.
    *  Numeric lists. Same as Number, but allowing multiple values.
 
@@ -411,6 +411,7 @@ export class RunCommand {
 **Code: Anatomy of a Command**
 ```typescript
 export interface CliCommandShape<T extends unknown[] = unknown[]> {
+
   /**
    * Parsed state
    */
@@ -499,7 +500,7 @@ export class RunRestCommand implements CliCommandShape {
 }
 ```
 
-As noted in the example above, `fields` is specified in this execution, with support for `module`, and `env`. These env flag is directly tied to the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L108) `name` defined in the [Base](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Environment config and common utilities for travetto applications.") module. 
+As noted in the example above, `fields` is specified in this execution, with support for `module`, and `env`. These env flag is directly tied to the [Runtime](https://github.com/travetto/travetto/tree/main/module/runtime/src/env.ts#L109) `name` defined in the [Base](https://github.com/travetto/travetto/tree/main/module/runtime#readme "Environment config and common utilities for travetto applications.") module. 
 
 The `module` field is slightly more complex, but is geared towards supporting commands within a monorepo context.  This flag ensures that a module is specified if running from the root of the monorepo, and that the module provided is real, and can run the desired command.  When running from an explicit module folder in the monorepo, the module flag is ignored.
 

package/package.json

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

package/src/decorators.ts

@@ -109,16 +109,14 @@ export function CliCommand(cfg: CliCommandConfigOptions = {}) {
     const runtimeModule = cfg.runtimeModule ?? (cfg.with?.module ? 'current' : undefined);
 
     if (runtimeModule) { // Validate module
-      (pendingCls.validators ??= []).push(async item => {
-        // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        const { module: mod } = item as CliCommandShapeFields;
+      (pendingCls.validators ??= []).push(async ({ module: mod }: Partial<CliCommandShapeFields>) => {
         const runModule = (runtimeModule === 'command' ? commandModule : mod) || Runtime.main.name;
 
         // If we need to run as a specific module
         if (runModule !== Runtime.main.name) {
           try {
             RuntimeIndex.reinitForModule(runModule);
-          } catch (err) {
+          } catch {
             return { source: 'flag', message: `${runModule} is an unknown module`, kind: 'custom', path: '.' };
           }
         }

package/src/help.ts

@@ -1,6 +1,6 @@
 import util from 'node:util';
 
-import { Primitive } from '@travetto/runtime';
+import { castKey, castTo, Primitive } from '@travetto/runtime';
 
 import { cliTpl } from './color';
 import { CliCommandShape } from './types';
@@ -41,13 +41,11 @@ export class HelpUtil {
     }
 
     const params: string[] = [];
-    const descs: string[] = [];
+    const descriptions: string[] = [];
 
     for (const flag of flags) {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const key = flag.name as keyof CliCommandShape;
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      const flagVal = command[key] as unknown as Primitive;
+      const key = castKey<CliCommandShape>(flag.name);
+      const flagVal: Primitive = castTo(command[key]);
 
       let aliases = flag.flagNames ?? [];
       if (isBoolFlag(flag)) {
@@ -68,11 +66,11 @@ export class HelpUtil {
       if (key !== 'help' && flagVal !== null && flagVal !== undefined && flagVal !== '') {
         desc.push(cliTpl`(default: ${{ input: JSON.stringify(flagVal) }})`);
       }
-      descs.push(desc.join(' '));
+      descriptions.push(desc.join(' '));
     }
 
     const paramWidths = params.map(x => util.stripVTControlCharacters(x).length);
-    const descWidths = descs.map(x => util.stripVTControlCharacters(x).length);
+    const descWidths = descriptions.map(x => util.stripVTControlCharacters(x).length);
 
     const paramWidth = Math.max(...paramWidths);
     const descWidth = Math.max(...descWidths);
@@ -87,7 +85,7 @@ export class HelpUtil {
       '',
       cliTpl`${{ title: 'Options:' }}`,
       ...params.map((_, i) =>
-        `  ${params[i]}${' '.repeat((paramWidth - paramWidths[i]))}  ${descs[i].padEnd(descWidth)}${' '.repeat((descWidth - descWidths[i]))}`
+        `  ${params[i]}${' '.repeat((paramWidth - paramWidths[i]))}  ${descriptions[i].padEnd(descWidth)}${' '.repeat((descWidth - descWidths[i]))}`
       ),
       '',
       ...helpText

package/src/parse.ts

@@ -191,7 +191,7 @@ export class CliParseUtil {
       } else {
         const field = schema.args[argIdx];
         out.push(getInput({ field, input, index: argIdx }));
-        // Move argIdx along if not in a vararg situation
+        // Move argIdx along if not in a var arg situation
         if (!field?.array) {
           argIdx += 1;
         }

package/src/registry.ts

@@ -1,4 +1,4 @@
-import { Class, ConcreteClass, describeFunction, Runtime, RuntimeIndex } from '@travetto/runtime';
+import { asConstructable, Class, classConstruct, describeFunction, Runtime, RuntimeIndex } from '@travetto/runtime';
 
 import { CliCommandConfig, CliCommandShape } from './types';
 import { CliUnknownCommandError } from './error';
@@ -14,9 +14,8 @@ class $CliCommandRegistry {
     return this.#commands.get(cls);
   }
 
-  #getClass(cmd: CliCommandShape): Class<CliCommandShape> {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    return cmd.constructor as Class;
+  getClass(cmd: CliCommandShape): Class<CliCommandShape> {
+    return asConstructable<CliCommandShape>(cmd).constructor;
   }
 
   /**
@@ -40,11 +39,10 @@ class $CliCommandRegistry {
   /**
    * Registers a cli command
    */
-  registerClass(cls: Class, cfg: Partial<CliCommandConfig>): CliCommandConfig {
+  registerClass<T extends CliCommandShape>(cls: Class<T>, cfg: Partial<CliCommandConfig>): CliCommandConfig {
     const meta = describeFunction(cls);
     this.#commands.set(cls, {
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      cls: cls as ConcreteClass,
+      cls,
       name: getName(meta.import),
       commandModule: meta.module,
       ...cfg,
@@ -56,7 +54,7 @@ class $CliCommandRegistry {
    * Get config for a given instance
    */
   getConfig(cmd: CliCommandShape): CliCommandConfig {
-    return this.getByClass(this.#getClass(cmd))!;
+    return this.getByClass(this.getClass(cmd))!;
   }
 
   /**
@@ -80,7 +78,7 @@ class $CliCommandRegistry {
       for (const v of values) {
         const cfg = this.getByClass(v);
         if (cfg) {
-          const inst = new cfg.cls();
+          const inst = classConstruct(cfg.cls);
           if (!inst.isActive || inst.isActive()) {
             inst._cfg = this.getConfig(inst);
             return inst;

package/src/schema.ts

@@ -1,4 +1,4 @@
-import { Class } from '@travetto/runtime';
+import { castKey, castTo, Class } from '@travetto/runtime';
 import { BindUtil, FieldConfig, SchemaRegistry, SchemaValidator, ValidationResultError } from '@travetto/schema';
 
 import { CliCommandRegistry } from './registry';
@@ -52,8 +52,7 @@ export class CliCommandSchemaUtil {
    * Get schema for a given command
    */
   static async getSchema(src: Class | CliCommandShape): Promise<CliCommandSchema> {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const cls = 'main' in src ? src.constructor as Class : src;
+    const cls = 'main' in src ? CliCommandRegistry.getClass(src) : src;
     if (this.#schemas.has(cls)) {
       return this.#schemas.get(cls)!;
     }
@@ -127,22 +126,18 @@ export class CliCommandSchemaUtil {
     for (const arg of state.all) {
       switch (arg.type) {
         case 'flag': {
-          // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-          const key = arg.fieldName as keyof T;
+          const key = castKey<T>(arg.fieldName);
           const value = arg.value!;
           if (arg.array) {
-            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-            ((template[key] as unknown[]) ??= []).push(value);
+            castTo<unknown[]>(template[key] ??= castTo([])).push(value);
           } else {
-            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-            template[key] = value as unknown as T[typeof key];
+            template[key] = castTo(value);
           }
           break;
         }
         case 'arg': {
           if (arg.array) {
-            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-            ((bound[arg.index] ??= []) as unknown[]).push(arg.input);
+            castTo<unknown[]>(bound[arg.index] ??= []).push(arg.input);
           } else {
             bound[arg.index] = arg.input;
           }
@@ -150,8 +145,7 @@ export class CliCommandSchemaUtil {
       }
     }
 
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const cls = cmd.constructor as Class<CliCommandShape>;
+    const cls = CliCommandRegistry.getClass(cmd);
     BindUtil.bindSchemaToObject(cls, cmd, template);
     return BindUtil.coerceMethodParams(cls, 'main', bound);
   }
@@ -160,9 +154,7 @@ export class CliCommandSchemaUtil {
    * Validate command shape with the given arguments
    */
   static async validate(cmd: CliCommandShape, args: unknown[]): Promise<typeof cmd> {
-    // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-    const cls = cmd.constructor as Class<CliCommandShape>;
-
+    const cls = CliCommandRegistry.getClass(cmd);
     const paramNames = SchemaRegistry.getMethodSchema(cls, 'main').map(x => x.name);
 
     const validators = [

package/src/types.ts

@@ -1,4 +1,4 @@
-import { ConcreteClass } from '@travetto/runtime';
+import { Class } from '@travetto/runtime';
 
 type OrProm<T> = T | Promise<T>;
 
@@ -19,7 +19,7 @@ export type CliCommandConfig = {
   name: string;
   commandModule: string;
   runTarget?: boolean;
-  cls: ConcreteClass<CliCommandShape>;
+  cls: Class<CliCommandShape>;
   hidden?: boolean;
   preMain?: (cmd: CliCommandShape) => void | Promise<void>;
 };
@@ -49,6 +49,7 @@ export type CliValidationError = {
  * CLI Command Contract
  */
 export interface CliCommandShape<T extends unknown[] = unknown[]> {
+
   /**
    * Parsed state
    */
@@ -116,7 +117,7 @@ export type CliCommandShapeFields = {
 /**
  * CLI Command argument/flag shape
  */
-export type CliCommandInput = {
+export type CliCommandInput<K extends string = string> = {
   name: string;
   description?: string;
   type: 'string' | 'file' | 'number' | 'boolean' | 'date' | 'regex' | 'module';
@@ -125,19 +126,19 @@ export type CliCommandInput = {
   required?: boolean;
   array?: boolean;
   default?: unknown;
-  flagNames?: string[];
+  flagNames?: K[];
   envVars?: string[];
 };
 
 /**
  * CLI Command schema shape
  */
-export type CliCommandSchema = {
+export interface CliCommandSchema<K extends string = string> {
   name: string;
   title: string;
   commandModule: string;
   runTarget?: boolean;
   description?: string;
   args: CliCommandInput[];
-  flags: CliCommandInput[];
-};
+  flags: CliCommandInput<K>[];
+}