@travetto/cli 5.0.0-rc.1 → 5.0.0-rc.3

package/README.md

@@ -59,7 +59,7 @@ This module also has a tight integration with the [VSCode plugin](https://market
 At it's heart, a cli command is the contract defined by what flags, and what arguments the command supports. Within the framework this requires three criteria to be met:
    *  The file must be located in the `support/` folder, and have a name that matches `cli.*.ts`
    *  The file must be a class that has a main method
-   *  The class must use the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L15) decorator
+   *  The class must use the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L14) decorator
 
 **Code: Basic Command**
 ```typescript
@@ -93,7 +93,7 @@ Examples of mappings:
 The pattern is that underscores(_) translate to colons (:), and the `cli.` prefix, and `.ts` suffix are dropped.
 
 ## Binding Flags
-[@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L15) is a wrapper for [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14), and so every class that uses the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L15) decorator is now a full [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14) class. The fields of the class represent the flags that are available to the command.
+[@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L14) is a wrapper for [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14), and so every class that uses the [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L14) decorator is now a full [@Schema](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/schema.ts#L14) class. The fields of the class represent the flags that are available to the command.
 
 **Code: Basic Command with Flag**
 ```typescript
@@ -130,7 +130,7 @@ $ trv basic:flag --loud
 HELLO
 ```
 
-The [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L15) supports the following data types for flags:
+The [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L14) 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
@@ -388,7 +388,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.  [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") does expose a cli target `run:rest` that will show up, to help run/debug a rest 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#L15) 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.  [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.") does expose a cli target `run:rest` that will show up, to help run/debug a rest 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#L14) decorator.  This means the target will be visible within the editor tooling.
 
 **Code: Simple Run Target**
 ```typescript
@@ -459,7 +459,7 @@ If the goal is to run a more complex application, which may include depending on
 
 **Code: Simple Run Target**
 ```typescript
-import { Env } from '@travetto/base';
+import { Runtime } from '@travetto/runtime';
 import { DependencyRegistry } from '@travetto/di';
 import { CliCommand, CliCommandShape, CliUtil } from '@travetto/cli';
 
@@ -498,7 +498,7 @@ export class RunRestCommand implements CliCommandShape {
     try {
       return await DependencyRegistry.runInstance(RestApplication);
     } catch (err) {
-      if (RestNetUtil.isInuseError(err) && !Env.production && this.killConflict) {
+      if (RestNetUtil.isInuseError(err) && !Runtime.production && this.killConflict) {
         await RestNetUtil.freePort(err.port);
         return await DependencyRegistry.runInstance(RestApplication);
       }
@@ -508,7 +508,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/base/src/env.ts#L116) `name` defined in the [Base](https://github.com/travetto/travetto/tree/main/module/base#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.1",
+  "version": "5.0.0-rc.3",
   "description": "CLI infrastructure for Travetto framework",
   "keywords": [
     "cli",
@@ -29,8 +29,8 @@
     "directory": "module/cli"
   },
   "dependencies": {
-    "@travetto/schema": "^5.0.0-rc.0",
-    "@travetto/terminal": "^5.0.0-rc.0"
+    "@travetto/schema": "^5.0.0-rc.3",
+    "@travetto/terminal": "^5.0.0-rc.3"
   },
   "travetto": {
     "displayName": "Command Line Interface",

package/src/decorators.ts

@@ -1,5 +1,4 @@
-import { Class, ClassInstance, Env, RuntimeContext } from '@travetto/base';
-import { RuntimeIndex } from '@travetto/manifest';
+import { Class, ClassInstance, Env, Runtime, RuntimeIndex, describeFunction } from '@travetto/runtime';
 import { SchemaRegistry } from '@travetto/schema';
 
 import { CliCommandShape, CliCommandShapeFields } from './types';
@@ -14,8 +13,7 @@ import { CliParseUtil } from './parse';
  */
 export function CliCommand(cfg: CliCommandConfigOptions = {}) {
   return function <T extends CliCommandShape>(target: Class<T>): void {
-    const meta = RuntimeIndex.getFunctionMetadata(target);
-    if (!meta || meta.abstract) {
+    if (!target.Ⲑid || describeFunction(target)?.abstract) {
       return;
     }
 
@@ -27,7 +25,7 @@ export function CliCommand(cfg: CliCommandConfigOptions = {}) {
       runTarget: cfg.runTarget,
       preMain: async (cmd: CliCommandShape & { env?: string }) => {
         if (addEnv) {
-          Env.TRV_ENV.set(cmd.env || Env.name);
+          Env.TRV_ENV.set(cmd.env || Runtime.envName);
         }
       }
     });
@@ -47,7 +45,7 @@ export function CliCommand(cfg: CliCommandConfigOptions = {}) {
         aliases: ['m', CliParseUtil.toEnvField(Env.TRV_MODULE.key)],
         description: 'Module to run for',
         specifiers: ['module'],
-        required: { active: RuntimeContext.monoRoot }
+        required: { active: Runtime.monoRoot }
       });
     }
 
@@ -55,10 +53,10 @@ export function CliCommand(cfg: CliCommandConfigOptions = {}) {
       (pendingCls.validators ??= []).push(async item => {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         const { module: mod } = item as CliCommandShapeFields;
-        const runModule = (runtimeModule === 'command' ? commandModule : mod) || RuntimeContext.main.name;
+        const runModule = (runtimeModule === 'command' ? commandModule : mod) || Runtime.main.name;
 
         // If we need to run as a specific module
-        if (runModule !== RuntimeContext.main.name) {
+        if (runModule !== Runtime.main.name) {
           try {
             RuntimeIndex.reinitForModule(runModule);
           } catch (err) {

package/src/error.ts

@@ -1,4 +1,4 @@
-import { AppError, RuntimeContext } from '@travetto/base';
+import { AppError, Runtime } from '@travetto/runtime';
 import { PackageUtil } from '@travetto/manifest';
 import { cliTpl } from './color';
 import { CliValidationError, CliCommandShape } from './types';
@@ -23,7 +23,7 @@ export class CliUnknownCommandError extends Error {
     const matchedCfg = COMMAND_PACKAGE.find(([re]) => re.test(cmd));
     if (matchedCfg) {
       const [, pkg, prod] = matchedCfg;
-      const install = PackageUtil.getInstallCommand(RuntimeContext, `@travetto/${pkg}`, prod);
+      const install = PackageUtil.getInstallCommand(Runtime, `@travetto/${pkg}`, prod);
       return cliTpl`
 ${{ title: 'Missing Package' }}\n${'-'.repeat(20)}\nTo use ${{ input: cmd }} please run:\n
 ${{ identifier: install }}

package/src/execute.ts

@@ -1,4 +1,4 @@
-import { ConsoleManager, Env, ShutdownManager } from '@travetto/base';
+import { ConsoleManager, Runtime, ShutdownManager } from '@travetto/runtime';
 
 import { HelpUtil } from './help';
 import { CliCommandRegistry } from './registry';
@@ -54,7 +54,7 @@ export class ExecutionManager {
     await command._cfg!.preMain?.(command);
     await command.preMain?.();
 
-    ConsoleManager.debug(Env.debug);
+    ConsoleManager.debug(Runtime.debug);
     const result = await command.main(...boundArgs);
     await CliUtil.listenForResponse(result);
   }

package/src/module.ts

@@ -1,5 +1,5 @@
-import { RuntimeContext } from '@travetto/base';
-import { type IndexedModule, RuntimeIndex } from '@travetto/manifest';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
+import type { IndexedModule } from '@travetto/manifest';
 
 import { CliScmUtil } from './scm';
 
@@ -44,11 +44,11 @@ export class CliModuleUtil {
    * @param transitive
    * @returns
    */
-  static async findModules(mode: 'all' | 'changed', fromHash?: string, toHash?: string, emptyOnFail = false): Promise<IndexedModule[]> {
+  static async findModules(mode: 'all' | 'changed', fromHash?: string, toHash?: string): Promise<IndexedModule[]> {
     return (mode === 'changed' ?
-      await this.findChangedModulesRecursive(fromHash, toHash, emptyOnFail) :
+      await this.findChangedModulesRecursive(fromHash, toHash, true) :
       [...RuntimeIndex.getModuleList('all')].map(x => RuntimeIndex.getModule(x)!)
-    ).filter(x => x.sourcePath !== RuntimeContext.workspace.path);
+    ).filter(x => x.sourcePath !== Runtime.workspace.path);
   }
 
   /**

package/src/parse.ts

@@ -1,8 +1,7 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { RuntimeContext } from '@travetto/base';
-import { RuntimeIndex } from '@travetto/manifest';
+import { Runtime } from '@travetto/runtime';
 import { CliCommandInput, CliCommandSchema, ParsedState } from './types';
 
 type ParsedInput = ParsedState['all'][number];
@@ -86,16 +85,8 @@ export class CliParseUtil {
     const key = flag.replace(CONFIG_PRE, '');
 
     // We have a file
-    const rel = (key.includes('/') ? key : `@/support/pack.${key}.flags`)
-      .replace('@@/', `${RuntimeContext.workspace.path}/`)
-      .replace('@/', `${mod}/`)
-      .replace(/^(@[^\/]+\/[^\/]+)(\/.*)$/, (_, imp, rest) => {
-        const val = RuntimeIndex.getModule(imp);
-        if (!val) {
-          throw new Error(`Unknown module file: ${_}, unable to proceed`);
-        }
-        return `${val.sourcePath}${rest}`;
-      });
+    const rel = (key.includes('/') ? key : `@#support/pack.${key}.flags`)
+      .replace(/^(@[^#]*)#(.*)$/, (_, imp, rest) => `${Runtime.modulePath(imp)}/${rest}`);
 
     const file = path.resolve(rel);
 
@@ -146,7 +137,7 @@ export class CliParseUtil {
     const mod = args.reduce(
       (m, x, i, arr) =>
         (i < SEP ? check(arr[i - 1], x) ?? check(...x.split('=')) : undefined) ?? m,
-      process.env[ENV_KEY] || RuntimeContext.main.name
+      process.env[ENV_KEY] || Runtime.main.name
     );
     return (await Promise.all(args.map((x, i) =>
       x.startsWith(CONFIG_PRE) && (i < SEP || SEP < 0) ? this.readFlagFile(x, mod) : x))).flat();

package/src/registry.ts

@@ -1,5 +1,4 @@
-import { Class, ConcreteClass, Env } from '@travetto/base';
-import { RuntimeIndex } from '@travetto/manifest';
+import { Class, ConcreteClass, Runtime, RuntimeIndex } from '@travetto/runtime';
 
 import { CliCommandConfig, CliCommandShape } from './types';
 import { CliUnknownCommandError } from './error';
@@ -37,7 +36,7 @@ class $CliCommandRegistry {
     if (!this.#fileMapping) {
       const all = new Map<string, string>();
       for (const e of RuntimeIndex.find({
-        module: m => !Env.production || m.prod,
+        module: m => !Runtime.production || m.prod,
         folder: f => f === 'support',
         file: f => f.role === 'std' && CLI_FILE_REGEX.test(f.sourceFile)
       })) {
@@ -52,7 +51,7 @@ class $CliCommandRegistry {
    * Registers a cli command
    */
   registerClass(cls: Class, cfg: Partial<CliCommandConfig>): CliCommandConfig {
-    const source = RuntimeIndex.getFunctionMetadata(cls)!.source;
+    const source = Runtime.getSource(cls);
     this.#commands.set(cls, {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       cls: cls as ConcreteClass,

package/src/schema.ts

@@ -1,4 +1,4 @@
-import { Class } from '@travetto/base';
+import { Class } from '@travetto/runtime';
 import { BindUtil, FieldConfig, SchemaRegistry, SchemaValidator, ValidationResultError } from '@travetto/schema';
 
 import { CliCommandRegistry } from './registry';

package/src/scm.ts

@@ -2,8 +2,8 @@ import { spawn } from 'node:child_process';
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { ExecUtil, RuntimeContext } from '@travetto/base';
-import { type IndexedModule, RuntimeIndex } from '@travetto/manifest';
+import { AppError, ExecUtil, Runtime, RuntimeIndex } from '@travetto/runtime';
+import type { IndexedModule } from '@travetto/manifest';
 
 export class CliScmUtil {
   /**
@@ -35,7 +35,7 @@ export class CliScmUtil {
    * @returns
    */
   static async findLastRelease(): Promise<string | undefined> {
-    const result = await ExecUtil.getResult(spawn('git', ['log', '--pretty=oneline'], { cwd: RuntimeContext.workspace.path }));
+    const result = await ExecUtil.getResult(spawn('git', ['log', '--pretty=oneline'], { cwd: Runtime.workspace.path }));
     return result.stdout
       .split(/\n/)
       .find(x => /Publish /.test(x))?.split(/\s+/)?.[0];
@@ -46,12 +46,11 @@ export class CliScmUtil {
    * @param fromHash
    * @returns
    */
-  static async findChangedFiles(fromHash: string, toHash: string = 'HEAD', emptyOnFail = false): Promise<string[]> {
-    const ws = RuntimeContext.workspace.path;
+  static async findChangedFiles(fromHash: string, toHash: string = 'HEAD'): Promise<string[]> {
+    const ws = Runtime.workspace.path;
     const res = await ExecUtil.getResult(spawn('git', ['diff', '--name-only', `${fromHash}..${toHash}`, ':!**/DOC.*', ':!**/README.*'], { cwd: ws }), { catch: true });
-    if (!res.valid && emptyOnFail) {
-      console.warn('Unable to detect changes between', fromHash, toHash, 'with', (res.stderr || res.stdout));
-      return [];
+    if (!res.valid) {
+      throw new AppError('Unable to detect changes between', 'data', { fromHash, toHash, output: (res.stderr || res.stdout) });
     }
     const out = new Set<string>();
     for (const line of res.stdout.split(/\n/g)) {

package/src/trv.d.ts

@@ -1,4 +1,4 @@
-import '@travetto/base';
+import '@travetto/runtime';
 
 declare global {
   interface TravettoEnv {

package/src/types.ts

@@ -1,4 +1,4 @@
-import { ConcreteClass } from '@travetto/base';
+import { ConcreteClass } from '@travetto/runtime';
 
 type OrProm<T> = T | Promise<T>;
 

package/src/util.ts

@@ -1,6 +1,6 @@
 import { spawn } from 'node:child_process';
 
-import { Env, ExecUtil, ShutdownManager, RuntimeContext } from '@travetto/base';
+import { Env, ExecUtil, ShutdownManager, Runtime } from '@travetto/runtime';
 
 import { CliCommandShape, CliCommandShapeFields, RunResponse } from './types';
 
@@ -14,10 +14,10 @@ export class CliUtil {
    * @returns
    */
   static getSimpleModuleName(placeholder: string, module?: string): string {
-    const simple = (module ?? RuntimeContext.main.name).replace(/[\/]/, '_').replace(/@/, '');
+    const simple = (module ?? Runtime.main.name).replace(/[\/]/, '_').replace(/@/, '');
     if (!simple) {
       return placeholder;
-    } else if (!module && RuntimeContext.monoRoot) {
+    } else if (!module && Runtime.monoRoot) {
       return placeholder;
     } else {
       return placeholder.replace('<module>', simple);
@@ -31,7 +31,7 @@ export class CliUtil {
     if (ipc && process.connected) {
       process.once('disconnect', () => process.exit());
     }
-    if (Env.TRV_CAN_RESTART.isFalse || !(cmd.canRestart ?? !Env.production)) {
+    if (Env.TRV_CAN_RESTART.isFalse || !(cmd.canRestart ?? !Runtime.production)) {
       Env.TRV_CAN_RESTART.clear();
       return;
     }
@@ -64,7 +64,7 @@ export class CliUtil {
       data: {
         name: cmd._cfg!.name, env,
         commandModule: cmd._cfg!.commandModule,
-        module: RuntimeContext.main.name,
+        module: Runtime.main.name,
         args: process.argv.slice(3),
       }
     };
@@ -79,7 +79,7 @@ export class CliUtil {
    * Debug if IPC available
    */
   static async debugIfIpc<T extends CliCommandShapeFields & CliCommandShape>(cmd: T): Promise<boolean> {
-    return (cmd.debugIpc ?? !Env.production) && this.triggerIpc('run', cmd);
+    return (cmd.debugIpc ?? !Runtime.production) && this.triggerIpc('run', cmd);
   }
 
   /**

package/support/cli.cli_schema.ts

@@ -1,4 +1,4 @@
-import { Env } from '@travetto/base';
+import { Env } from '@travetto/runtime';
 
 import { CliCommand } from '../src/decorators';
 import { CliCommandSchema, CliCommandShape, CliValidationError } from '../src/types';

package/support/cli.main.ts

@@ -1,9 +1,8 @@
 import fs from 'node:fs/promises';
 import path from 'node:path';
 
-import { RuntimeContext } from '@travetto/base';
+import { Runtime, RuntimeIndex } from '@travetto/runtime';
 import { CliCommandShape, CliCommand, CliValidationError, ParsedState } from '@travetto/cli';
-import { RuntimeIndex } from '@travetto/manifest';
 import { Ignore } from '@travetto/schema';
 
 /**
@@ -19,7 +18,7 @@ export class MainCommand implements CliCommandShape {
     // If referenced file exists
     let file = fileOrImport;
     if (await (fs.stat(path.resolve(fileOrImport)).then(() => true, () => false))) {
-      file = path.join(RuntimeContext.main.name, fileOrImport);
+      file = path.join(Runtime.main.name, fileOrImport);
     }
 
     return RuntimeIndex.getFromImport(file)?.import;