@travetto/cli 6.0.0-rc.3 → 6.0.1

package/README.md

@@ -50,6 +50,7 @@ Commands:
   test:watch        Invoke the test watcher
   web:http          Run a web server
   web:rpc-client    Generate the web-rpc client
+  web:server        Run a web server
 ```
 
 This listing is from the [Travetto](https://travetto.dev) monorepo, and represents the majority of tools that can be invoked from the command line. 
@@ -390,7 +391,7 @@ npx trv call:db --host localhost --port 3306 --username app --password <custom>
 ```
 
 ## VSCode Integration
-By default, cli commands do not expose themselves to the VSCode extension, as the majority of them are not intended for that sort of operation.  [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative api for Web Applications with support for the dependency injection.") does expose a cli target `web:http` that will show up, to help run/debug a web application.  Any command can mark itself as being a run target, and will be eligible for running from within the [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=arcsine.travetto-plugin). This is achieved by setting the `runTarget` field on the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L84) decorator.  This means the target will be visible within the editor tooling.
+By default, cli commands do not expose themselves to the VSCode extension, as the majority of them are not intended for that sort of operation.  [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications") does expose a cli target `web:http` that will show up, to help run/debug a web application.  Any command can mark itself as being a run target, and will be eligible for running from within the [VSCode plugin](https://marketplace.visualstudio.com/items?itemName=arcsine.travetto-plugin). This is achieved by setting the `runTarget` field on the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L84) decorator.  This means the target will be visible within the editor tooling.
 
 **Code: Simple Run Target**
 ```typescript
@@ -458,11 +459,11 @@ export interface CliCommandShape<T extends unknown[] = unknown[]> {
 ```
 
 ### Dependency Injection
-If the goal is to run a more complex application, which may include depending on [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support."), we can take a look at [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative api for Web Applications with support for the dependency injection.")'s target:
+If the goal is to run a more complex application, which may include depending on [Dependency Injection](https://github.com/travetto/travetto/tree/main/module/di#readme "Dependency registration/management and injection support."), we can take a look at [Web API](https://github.com/travetto/travetto/tree/main/module/web#readme "Declarative support for creating Web Applications")'s target:
 
 **Code: Simple Run Target**
 ```typescript
-import { Runtime, ShutdownManager, toConcrete } from '@travetto/runtime';
+import { Runtime, toConcrete, Util } from '@travetto/runtime';
 import { DependencyRegistry } from '@travetto/di';
 import { CliCommand, CliCommandShape } from '@travetto/cli';
 import { NetUtil } from '@travetto/web';
@@ -492,18 +493,13 @@ export class WebHttpCommand implements CliCommandShape {
     await RootRegistry.init();
     const instance = await DependencyRegistry.getInstance(toConcrete<WebHttpServer>());
 
-    let res;
-    try {
-      res = await instance.serve();
-    } catch (err) {
-      if (NetUtil.isPortUsedError(err) && !Runtime.production && this.killConflict) {
-        await NetUtil.freePort(err.port);
-        res = await instance.serve();
-      }
-      throw err;
-    }
-    ShutdownManager.onGracefulShutdown(res.kill, this);
-    return res.wait;
+    const handle = await Util.acquireWithRetry(
+      () => instance.serve(),
+      NetUtil.freePortOnConflict,
+      this.killConflict && !Runtime.production ? 5 : 1
+    );
+
+    await handle.complete;
   }
 }
 ```
@@ -555,14 +551,14 @@ Options:
 
 Available Services
 --------------------
- * dynamodb@2.5.3
+ * dynamodb@2.6.1
  * elasticsearch@8.17.0
  * firestore@latest
  * mongodb@8.0
- * mysql@9.1
- * postgresql@17.2
- * redis@7.4
- * s3@3.12.0
+ * mysql@9.3
+ * postgresql@17.5
+ * redis@8.0
+ * s3@4.2.0
 ```
 
 A sample of all services available to the entire framework:
@@ -573,14 +569,14 @@ $ trv service status
 
 Service          Version    Status
 -------------------------------------------------
-dynamodb           2.5.3    Running 93af422e793a
+dynamodb           2.6.1    Running 93af422e793a
 elasticsearch     8.17.0    Running ed76ee063d13
 firestore         latest    Running feec2e5e95b4
 mongodb              8.0    Running 5513eba6734e
-mysql                9.1    Running 307bc66d442a
-postgresql          17.2    Running e78291e71040
-redis                7.4    Running 77ba279b4e30
-s3                3.12.0    Running fdacfc55b9e3
+mysql                9.3    Running 307bc66d442a
+postgresql          17.5    Running e78291e71040
+redis                8.0    Running 77ba279b4e30
+s3                 4.2.0    Running fdacfc55b9e3
 ```
 
 ### Defining new Services

package/package.json

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

package/src/decorators.ts

@@ -80,6 +80,7 @@ const FIELD_CONFIG: {
  * Decorator to register a CLI command
  * @augments `@travetto/schema:Schema`
  * @augments `@travetto/cli:CliCommand`
+ * @schemaMethods `main`
  */
 export function CliCommand(cfg: CliCommandConfigOptions = {}) {
   return function <T extends CliCommandShape>(target: Class<T>): void {

package/src/error.ts

@@ -6,14 +6,13 @@ import { CliValidationError, CliCommandShape } from './types.ts';
 
 const COMMAND_PACKAGE = [
   [/^test(:watch)?$/, 'test', false],
-  [/^service$/, 'command', true],
-  [/^lint(:register)?$/, 'eslint', true],
+  [/^lint(:register)?$/, 'eslint', false],
   [/^model:(install|export)$/, 'model', true],
   [/^openapi:(spec|client)$/, 'openapi', true],
   [/^email:(compile|editor)$/, 'email-compiler', false],
   [/^pack(:zip|:docker)?$/, 'pack', false],
-  [/^web:http$/, 'web-http-server', false],
-  [/^web:rpc-client$/, 'web-rpc', false],
+  [/^web:(http|server)$/, 'web-http-server', true],
+  [/^web:rpc-client$/, 'web-rpc', true],
 ] as const;
 
 /**

package/src/execute.ts

@@ -75,7 +75,7 @@ export class ExecutionManager {
     } catch (err) {
       await this.#onError(err);
     } finally {
-      await ShutdownManager.gracefulShutdown();
+      await ShutdownManager.gracefulShutdown('@travetto/cli:execute');
     }
   }
 }

package/src/help.ts

@@ -76,7 +76,7 @@ export class HelpUtil {
     const descWidth = Math.max(...descWidths);
 
     const helpText = await (command.help?.() ?? []);
-    if (helpText.length && helpText[helpText.length - 1] !== '') {
+    if (helpText.length && helpText.at(-1) !== '') {
       helpText.push('');
     }
 

package/src/schema.ts

@@ -46,16 +46,11 @@ const fieldToInput = (x: FieldConfig): CliCommandInput => ({
  */
 export class CliCommandSchemaUtil {
 
-  static #schemas = new Map<Class, CliCommandSchema>();
-
   /**
    * Get schema for a given command
    */
   static async getSchema(src: Class | CliCommandShape): Promise<CliCommandSchema> {
     const cls = 'main' in src ? CliCommandRegistry.getClass(src) : src;
-    if (this.#schemas.has(cls)) {
-      return this.#schemas.get(cls)!;
-    }
 
     // Ensure finalized
     const parent = SchemaRegistry.getParentClass(cls);
@@ -112,7 +107,7 @@ export class CliCommandSchemaUtil {
       title: fullSchema.title ?? cls.name,
       description: fullSchema.description ?? ''
     };
-    this.#schemas.set(cls, cfg);
+
     return cfg;
   }
 

package/src/service.ts

@@ -68,7 +68,7 @@ export class ServiceRunner {
   }
 
   async #hasImage(): Promise<boolean> {
-    const result = await ExecUtil.getResult(spawn('docker', ['image', 'inspect', this.svc.image], { shell: false }), { catch: true });
+    const result = await ExecUtil.getResult(spawn('docker', ['image', 'inspect', this.svc.image]), { catch: true });
     return result.valid;
   }
 
@@ -96,15 +96,15 @@ export class ServiceRunner {
       await fs.mkdir(item, { recursive: true });
     }
 
-    return (await ExecUtil.getResult(spawn('docker', args, { shell: false, stdio: [0, 'pipe', 2] }))).stdout;
+    return (await ExecUtil.getResult(spawn('docker', args, { stdio: [0, 'pipe', 2] }))).stdout;
   }
 
   async #getContainerId(): Promise<string | undefined> {
-    return (await ExecUtil.getResult(spawn('docker', ['ps', '-q', '--filter', `label=trv-${this.svc.name}`], { shell: false }))).stdout.trim();
+    return (await ExecUtil.getResult(spawn('docker', ['ps', '-q', '--filter', `label=trv-${this.svc.name}`]))).stdout.trim();
   }
 
   async #killContainer(cid: string): Promise<void> {
-    await ExecUtil.getResult(spawn('docker', ['kill', cid], { shell: false }));
+    await ExecUtil.getResult(spawn('docker', ['kill', cid]));
   }
 
   async * action(op: ServiceAction): AsyncIterable<['success' | 'failure' | 'message', string]> {

package/support/transformer.cli.ts

@@ -1,53 +0,0 @@
-import ts from 'typescript';
-
-import { TransformerState, DecoratorMeta, AfterClass } from '@travetto/transformer';
-import { SchemaTransformUtil } from '@travetto/schema/support/transformer/util.ts';
-
-/**
- * Converts classes with `@CliCommand` to `@Schema` and maps the main method
- */
-export class CliCommandTransformer {
-
-  /**
-   * On presence of `@CliCommand`
-   */
-  @AfterClass('CliCommand')
-  static registerMainMethod(state: TransformerState, node: ts.ClassDeclaration, dm?: DecoratorMeta): typeof node {
-    const dec = dm?.dec;
-
-    if (!dec || !ts.isCallExpression(dec.expression)) { // If not valid
-      return node;
-    }
-
-    // Find runnable method
-    const mainMethod = node.members
-      .find((x): x is ts.MethodDeclaration =>
-        ts.isMethodDeclaration(x) && x.name!.getText() === 'main'
-      );
-
-    if (!mainMethod) {
-      return node;
-    }
-
-    const members = node.members.map(x => ts.isMethodDeclaration(x) && x === mainMethod ?
-      state.factory.updateMethodDeclaration(
-        x,
-        x.modifiers,
-        x.asteriskToken,
-        x.name,
-        x.questionToken,
-        x.typeParameters,
-        x.parameters.map(y => SchemaTransformUtil.computeField(state, y)),
-        x.type,
-        x.body
-      ) : x);
-
-    return state.factory.updateClassDeclaration(node,
-      node.modifiers,
-      node.name,
-      node.typeParameters,
-      node.heritageClauses,
-      members
-    );
-  }
-}