@travetto/cli 3.1.0-rc.0 → 3.1.0-rc.10

package/README.md

@@ -22,32 +22,32 @@ $ trv --help
 Usage:  [options] [command]
 
 Commands:
-  doc            Command line support for generating module docs.
-  doc:angular    Generate documentation into the angular webapp under related/travetto.github.io
-  doc:mapping    Generate module mapping for @travetto/doc
-  email:compile  CLI Entry point for running the email server
-  email:editor   The email editor compilation service and output serving
-  exec           Repo execution
-  lint           Command line support for linting
-  lint:register  Writes the lint configuration file
-  list           Allows for listing of modules
-  model:export   Exports model schemas
-  model:install  Installing models
-  openapi:client CLI for generating the cli client
-  openapi:spec   CLI for outputting the open api spec to a local file
-  pack           Standard pack support
-  pack:docker    Standard docker support for pack
-  pack:lambda    Standard lambda support for pack
-  pack:zip       Standard zip support for pack
-  repo:publish   Publish all pending modules
-  repo:version   Version all changed dependencies
-  run:double     Doubles a number
-  run:rest       Run a rest server as an application
-  scaffold       Command to run scaffolding
-  service        Allows for running services
-  test           Launch test framework and execute tests
-  test:watch     Invoke the test watcher
-  version-sync   Enforces all packages to write out their versions and dependencies
+  doc               Command line support for generating module docs.
+  doc:angular       Generate documentation into the angular webapp under related/travetto.github.io
+  doc:mapping       Generate module mapping for @travetto/doc
+  email:compile     CLI Entry point for running the email server
+  email:editor      The email editor compilation service and output serving
+  lint              Command line support for linting
+  lint:register     Writes the lint configuration file
+  model:export      Exports model schemas
+  model:install     Installing models
+  openapi:client    CLI for generating the cli client
+  openapi:spec      CLI for outputting the open api spec to a local file
+  pack              Standard pack support
+  pack:docker       Standard docker support for pack
+  pack:lambda       Standard lambda support for pack
+  pack:zip          Standard zip support for pack
+  repo:exec         Repo execution
+  repo:list         Allows for listing of modules
+  repo:publish      Publish all pending modules
+  repo:version      Version all changed dependencies
+  repo:version-sync Enforces all packages to write out their versions and dependencies
+  run:double        Doubles a number
+  run:rest          Run a rest server as an application
+  scaffold          Command to run scaffolding
+  service           Allows for running services
+  test              Launch test framework and execute tests
+  test:watch        Invoke the test watcher
 ```
 
 This listing is from the [Travetto](https://travetto.dev) monorepo, and represents the majority of tools that can be invoked from the command line. 
@@ -130,9 +130,9 @@ HELLO
 
 The [@CliCommand](https://github.com/travetto/travetto/tree/main/module/cli/src/decorators.ts#L20) 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#L179), [@Float](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L185), [@Precision](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L173), [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L114) and [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L124) decorators help provide additional validation.
-   *  String values. [@MinLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L114), [@MaxLength](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L124), [@Match](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L106) and [@Enum](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L85) provide additional constraints
-   *  Date values. The [@Min](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L114) and [@Max](https://github.com/travetto/travetto/tree/main/module/schema/src/decorator/field.ts#L124) decorators help provide additional validation.
+   *  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.
    *  String lists. Same as String, but allowing multiple values.
    *  Numeric lists. Same as Number, but allowing multiple values.
 
@@ -168,7 +168,7 @@ Options:
 $ trv basic:arg 20
 
 Execution failed:
- * volume is bigger than (10). [1]
+ * Argument volume is bigger than (10)
 
 Usage: doc/cli.basic:arg [options] [volume:number]
 
@@ -231,7 +231,7 @@ $ trv basic:arglist 10 5 3 9 8 1
 $ trv basic:arglist 10 5 3 9 20 1
 
 Execution failed:
- * volumes[4] is bigger than (10). [1]
+ * Argument volumes[4] is bigger than (10)
 
 Usage: doc/cli.basic:arglist [options] <volumes...:number>
 
@@ -358,7 +358,7 @@ 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).
+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#L20) decorator.  This means the target will be visible within the editor tooling.
 
 **Code: Simple Run Target**
 ```typescript
@@ -376,9 +376,43 @@ export class RunCommand {
 }
 ```
 
-Also, any command name that starts with `run:` (i.e. `support/cli.run_*.ts`), will be opted-in to the run behavior unless explicitly disabled.
-
 ## Advanced Usage
+
+**Code: Anatomy of a Command**
+```typescript
+export interface CliCommandShape {
+  /**
+   * Action target of the command
+   */
+  main(...args: unknown[]): OrProm<RunResponse>;
+  /**
+   * Setup environment before command runs
+   */
+  envInit?(): OrProm<GlobalEnvConfig>;
+  /**
+   * Extra help
+   */
+  help?(): OrProm<string[]>;
+  /**
+   * Is the command active/eligible for usage
+   */
+  isActive?(): boolean;
+  /**
+   * Run before binding occurs
+   */
+  initialize?(): OrProm<void>;
+  /**
+   * Run before validation occurs
+   */
+  finalize?(unknownArgs: string[]): OrProm<void>;
+  /**
+   * Validation method
+   */
+  validate?(...unknownArgs: unknown[]): OrProm<CliValidationError | CliValidationError[] | undefined>;
+}
+```
+
+### 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 [RESTful API](https://github.com/travetto/travetto/tree/main/module/rest#readme "Declarative api for RESTful APIs with support for the dependency injection module.")'s target:
 
 **Code: Simple Run Target**
@@ -390,7 +424,7 @@ import { ServerHandle } from '../src/types';
 /**
  * Run a rest server as an application
  */
-@CliCommand({ fields: ['module', 'env', 'profile'] })
+@CliCommand({ runTarget: true, fields: ['module', 'env', 'profile'] })
 export class RunRestCommand {
 
   /** Port to run on */
@@ -410,3 +444,32 @@ export class RunRestCommand {
 As noted in the example above, `fields` is specified in this execution, with support for `module`, `env`, and `profile`. These env and profile flags are directly tied to the GlobalEnv flags defined in the [Base](https://github.com/travetto/travetto/tree/main/module/base#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.
+
+### Custom Validation
+In addition to dependency injection, the command contract also allows for a custom validation function, which will have access to bound command (flags, and args) as well as the unknown arguments. When a command implements this method, any [CliValidationError](https://github.com/travetto/travetto/tree/main/module/cli/src/types.ts#L10) errors that are returned will be shared with the user, and fail to invoke the `main` method.
+
+**Code: CliValidationError**
+```typescript
+export type CliValidationError = {
+  /**
+   * The error message
+   */
+  message: string;
+  /**
+   * Source of validation
+   */
+  source?: 'flag' | 'arg' | 'custom';
+};
+```
+
+A simple example of the validation can be found in the `doc` command:
+
+**Code: Simple Validation Example**
+```typescript
+async validate(...args: unknown[]): Promise<CliValidationError | undefined> {
+    const docFile = path.resolve(this.input);
+    if (!(await fs.stat(docFile).catch(() => false))) {
+      return { message: `input: ${this.input} does not exist`, source: 'flag' };
+    }
+  }
+```

package/package.json

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

package/src/decorators.ts

@@ -35,12 +35,12 @@ export function CliCommand(cfg: { fields?: ExtraFields[], runTarget?: boolean, h
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       cls: target as ConcreteClass<T>,
       hidden: cfg.hidden,
-      runTarget: cfg.runTarget ?? name.startsWith('run:'),
+      runTarget: cfg.runTarget,
       preMain: (cmd: CliCommandShape & { env?: string, profile?: string[], module?: string }) => {
         if (addEnv) { defineGlobalEnv({ envName: cmd.env }); }
         if (addProfile) { defineGlobalEnv({ profiles: cmd.profile }); }
         if (addEnv || addProfile) { ConsoleManager.setDebugFromEnv(); }
-        if (addModule && cmd.module && cmd.module !== RootIndex.mainModule.name) { // Mono-repo support
+        if (addModule && cmd.module && cmd.module !== RootIndex.mainModuleName) { // Mono-repo support
           RootIndex.reinitForModule(cmd.module); // Reinit with specified module
         }
       }
@@ -72,10 +72,11 @@ export function CliCommand(cfg: { fields?: ExtraFields[], runTarget?: boolean, h
       });
 
       // Register validator for module
-      (pendingCls.validators ??= []).push(item =>
+      (pendingCls.validators ??= []).push(async item => {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-        CliModuleUtil.validateCommandModule(getMod(target), item as { module?: string })
-      );
+        const res = await CliModuleUtil.validateCommandModule(getMod(target), item as { module?: string });
+        return res ? { ...res, kind: 'custom', path: '.' } : res;
+      });
     }
   };
 }
@@ -83,7 +84,7 @@ export function CliCommand(cfg: { fields?: ExtraFields[], runTarget?: boolean, h
 /**
  * Decorator to register a CLI command flag
  */
-export function CliFlag(cfg: { name?: string, short?: string, desc?: string, file?: boolean, envVars?: string[] }) {
+export function CliFlag(cfg: { name?: string, short?: string, desc?: string, fileExtensions?: string[], envVars?: string[] }) {
   return function (target: ClassInstance, prop: string | symbol): void {
     const aliases: string[] = [];
     if (cfg.name) {
@@ -97,7 +98,8 @@ export function CliFlag(cfg: { name?: string, short?: string, desc?: string, fil
     }
     if (typeof prop === 'string') {
       SchemaRegistry.registerPendingFieldFacet(target.constructor, prop, {
-        aliases, description: cfg.desc, specifier: cfg.file ? 'file' : undefined
+        aliases, description: cfg.desc,
+        specifiers: cfg.fileExtensions?.length ? ['file', ...cfg.fileExtensions.map(x => `ext:${x.replace(/[*.]/g, '')}`)] : undefined
       });
     }
   };

package/src/execute.ts

@@ -7,7 +7,6 @@ import { ConsoleManager, defineGlobalEnv, ShutdownManager } from '@travetto/base
 import { HelpUtil } from './help';
 import { CliCommandShape, CliValidationResultError } from './types';
 import { CliCommandRegistry } from './registry';
-import { cliTpl } from './color';
 import { CliCommandSchemaUtil } from './schema';
 
 /**
@@ -116,7 +115,7 @@ export class ExecutionManager {
           console.error(await HelpUtil.renderValidationError(command, err));
           console.error!(await HelpUtil.renderHelp(command));
         } else {
-          console.error!(cliTpl`${{ failure: err.message }}`);
+          console.error!(err);
           console.error!();
         }
       }

package/src/help.ts

@@ -6,6 +6,12 @@ import { CliCommandShape, CliValidationResultError } from './types';
 import { CliCommandRegistry } from './registry';
 import { CliCommandSchemaUtil } from './schema';
 
+const validationSourceMap = {
+  custom: '',
+  arg: 'Argument',
+  flag: 'Flag'
+};
+
 /**
  * Utilities for showing help
  */
@@ -93,12 +99,20 @@ export class HelpUtil {
     const maxWidth = keys.reduce((a, b) => Math.max(a, stripAnsiCodes(b).length), 0);
 
     for (const cmd of keys) {
-      const inst = await CliCommandRegistry.getInstance(cmd);
-      if (inst) {
-        const cfg = await CliCommandRegistry.getConfig(inst);
-        if (!cfg.hidden) {
-          const schema = await CliCommandSchemaUtil.getSchema(inst);
-          rows.push(cliTpl`  ${{ param: cmd.padEnd(maxWidth, ' ') }} ${{ title: schema.title }}`);
+      try {
+        const inst = await CliCommandRegistry.getInstance(cmd);
+        if (inst) {
+          const cfg = await CliCommandRegistry.getConfig(inst);
+          if (!cfg.hidden) {
+            const schema = await CliCommandSchemaUtil.getSchema(inst);
+            rows.push(cliTpl`  ${{ param: cmd.padEnd(maxWidth, ' ') }} ${{ title: schema.title }}`);
+          }
+        }
+      } catch (err) {
+        if (err instanceof Error) {
+          rows.push(cliTpl`  ${{ param: cmd.padEnd(maxWidth, ' ') }} ${{ failure: err.message.split(/\n/)[0] }}`);
+        } else {
+          throw err;
         }
       }
     }
@@ -124,7 +138,9 @@ export class HelpUtil {
   static renderValidationError(cmd: CliCommandShape, err: CliValidationResultError): string {
     return [
       cliTpl`${{ failure: 'Execution failed' }}:`,
-      ...err.errors.map(e => cliTpl` * ${{ failure: e.message }}`),
+      ...err.errors.map(e => e.source && e.source !== 'custom' ?
+        cliTpl` * ${{ identifier: validationSourceMap[e.source] }} ${{ subtitle: e.message }}` :
+        cliTpl` * ${{ failure: e.message }}`),
       '',
     ].join('\n');
   }

package/src/module.ts

@@ -1,78 +1,18 @@
-import { ColorDefineUtil, NAMED_COLORS, Terminal, GlobalTerminal, TermLinePosition } from '@travetto/terminal';
-import { Env, ExecutionOptions, ExecutionResult, ExecutionState, TypedObject } from '@travetto/base';
-import { IndexedModule, PackageUtil, RootIndex } from '@travetto/manifest';
-import { IterableWorkSet, WorkPool, type Worker } from '@travetto/worker';
+import { IndexedModule, RootIndex } from '@travetto/manifest';
 
 import { CliScmUtil } from './scm';
 import { CliValidationError } from './types';
 import { CliUtil } from './util';
 
-type ModuleRunConfig<T = ExecutionResult> = {
-  progressMessage?: (mod: IndexedModule | undefined) => string;
-  filter?: (mod: IndexedModule) => boolean | Promise<boolean>;
-  transformResult?: (mod: IndexedModule, result: ExecutionResult) => T;
-  workerCount?: number;
-  progressPosition?: TermLinePosition;
-  prefixOutput?: boolean;
-  showStdout?: boolean;
-  showStderr?: boolean;
-};
-
 type ModuleGraphEntry = { children: Set<string>, name: string, active: Set<string>, parents?: string[] };
 
-const COLORS = TypedObject.keys(NAMED_COLORS)
-  .map(k => [k, ColorDefineUtil.defineColor(k).hsl] as const)
-  .filter(([, [, s, l]]) => l > .5 && l < .8 && s > .8)
-  .map(([k]) => GlobalTerminal.colorer(k));
-
-const colorize = (val: string, idx: number): string => COLORS[idx % COLORS.length](val);
-
-const modError = (message: string): CliValidationError => ({ kind: 'required', path: 'module', message });
+const modError = (message: string): CliValidationError => ({ source: 'flag', message: `module: ${message}` });
 
 /**
  * Simple utilities for understanding modules for CLI use cases
  */
 export class CliModuleUtil {
 
-  /**
-   * Generate execution options for running on modules
-   */
-  static #buildExecutionOptions<T = ExecutionState>(
-    mod: IndexedModule,
-    config: ModuleRunConfig<T>,
-    prefixes: Record<string, string>,
-    stdoutTerm: Terminal,
-    stderrTerm: Terminal
-  ): ExecutionOptions {
-    const folder = mod.sourceFolder;
-    const opts: ExecutionOptions = {
-      stdio: ['ignore', 'pipe', 'pipe', 'ignore'],
-      outputMode: 'text',
-      catchAsResult: true,
-      cwd: folder,
-      env: { TRV_MANIFEST: '', TRV_MODULE: mod.name },
-    };
-
-    if (config.showStdout) {
-      opts.onStdOutLine = (line: string): unknown => stdoutTerm.writeLines(`${prefixes[folder] ?? ''}${line}`);
-    }
-    if (config.showStderr) {
-      opts.onStdErrorLine = (line: string): unknown => stderrTerm.writeLines(`${prefixes[folder] ?? ''}${line}`);
-    }
-    return opts;
-  }
-
-  /**
-   * Build equal sized prefix labels for outputting
-   * @param mods
-   * @returns
-   */
-  static #buildPrefixes(mods: IndexedModule[]): Record<string, string> {
-    const folders = mods.map(x => x.sourceFolder);
-    const maxWidth = Math.max(...folders.map(x => x.length));
-    return Object.fromEntries(folders.map((x, i) => [x, colorize(x.padStart(maxWidth, ' ').padEnd(maxWidth + 1), i)]));
-  }
-
   /**
    * Find modules that changed, and the dependent modules
    * @param hash
@@ -115,86 +55,6 @@ export class CliModuleUtil {
     ).filter(x => x.sourcePath !== RootIndex.manifest.workspacePath);
   }
 
-  /**
-   * Synchronize all workspace modules to have the correct versions from the current packages
-   */
-  static async synchronizeModuleVersions(): Promise<Record<string, string>> {
-    const versions = {};
-    await PackageUtil.syncVersions((await this.findModules('all')).map(x => x.sourcePath), versions);
-    return versions;
-  }
-
-  /**
-   * Run on all modules
-   */
-  static async execOnModules<T = ExecutionResult>(
-    mode: 'all' | 'changed',
-    operation: (mod: IndexedModule, options: ExecutionOptions) => ExecutionState,
-    config: ModuleRunConfig<T> = {}
-  ): Promise<Map<IndexedModule, T>> {
-
-    config.showStdout = config.showStdout ?? (Env.isSet('DEBUG') && !Env.isFalse('DEBUG'));
-    config.showStderr = config.showStderr ?? true;
-
-    const workerCount = config.workerCount ?? WorkPool.DEFAULT_SIZE;
-
-    const mods = await CliModuleUtil.findModules(mode);
-    const results = new Map<IndexedModule, T>();
-    const processes = new Map<IndexedModule, ExecutionState>();
-
-    const prefixes = config.prefixOutput !== false ? this.#buildPrefixes(mods) : {};
-    const stdoutTerm = await Terminal.for({ output: process.stdout });
-    const stderrTerm = await Terminal.for({ output: process.stderr });
-
-    let id = 1;
-    const pool = new WorkPool(async () => {
-      const worker: Worker<IndexedModule> & { mod?: IndexedModule } = {
-        id: id += 1,
-        mod: undefined,
-        active: false,
-        async destroy() {
-          this.active = false;
-          processes.get(this.mod!)?.process.kill('SIGKILL');
-        },
-        async execute(mod: IndexedModule) {
-          try {
-            this.mod = mod;
-            this.active = true;
-
-            if (await config.filter?.(mod) === false) {
-              this.active = false;
-            } else {
-              const opts = CliModuleUtil.#buildExecutionOptions(mod, config, prefixes, stdoutTerm, stderrTerm);
-
-              const result = await operation(mod, opts).result;
-
-              // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-              const output = (config.transformResult ? config.transformResult(mod, result) : result) as T;
-              results.set(mod, output);
-            }
-          } finally {
-            this.active = false;
-            delete this.mod;
-          }
-        },
-      };
-      return worker;
-    }, { max: workerCount, min: workerCount });
-
-    const work = pool.iterateProcess(new IterableWorkSet(mods));
-
-    if (config.progressMessage) {
-      const cfg = { position: config.progressPosition ?? 'bottom' } as const;
-      await stdoutTerm.trackProgress(work, ev => ({ ...ev, text: config.progressMessage!(ev.value) }), cfg);
-    } else {
-      for await (const _ of work) {
-        // Ensure its all consumed
-      }
-    }
-
-    return results;
-  }
-
   /**
    * Get module dependency graph, fully collapsed
    */

package/src/schema.ts

@@ -5,23 +5,29 @@ import { CliCommandRegistry } from './registry';
 import { CliCommandInput, CliCommandSchema, CliCommandShape, CliValidationResultError } from './types';
 
 function fieldToInput(x: FieldConfig): CliCommandInput {
+  const type = x.type === Date ? 'date' :
+    x.type === Boolean ? 'boolean' :
+      x.type === String ? (x.specifiers?.includes('file') ? 'file' : 'string') :
+        x.type === Number ? 'number' :
+          x.type === RegExp ? 'regex' : 'string';
   return ({
     name: x.name,
     description: x.description,
     array: x.array,
     required: x.required?.active,
     choices: x.enum?.values,
-    type: x.type === Date ? 'date' :
-      x.type === Boolean ? 'boolean' :
-        x.type === String ? (x.specifier === 'file' ? 'file' : 'string') :
-          x.type === Number ? 'number' :
-            x.type === RegExp ? 'regex' : 'string',
+    fileExtensions: type === 'file' ? x.specifiers?.filter(s => s.startsWith('ext:')).map(s => s.split('ext:')[1]) : undefined,
+    type,
     default: x.default,
     flagNames: (x.aliases ?? []).slice(0).filter(v => !v.startsWith('env.')),
     envVars: (x.aliases ?? []).slice(0).filter(v => v.startsWith('env.')).map(v => v.replace('env.', ''))
   });
 }
 
+const VALID_FLAG = /^-{1,2}[a-z]/i;
+const LONG_FLAG = /^--[a-z]/i;
+const SHORT_FLAG = /^-[a-z]/i;
+
 const isBoolFlag = (x: CliCommandInput): boolean => x.type === 'boolean' && !x.array;
 
 /**
@@ -55,7 +61,7 @@ export class CliCommandSchemaUtil {
     }
 
     const schema = await SchemaRegistry.getViewSchema(cls);
-    const flags = [...Object.values(schema.schema)].filter(v => !v.forMethod).map(fieldToInput);
+    const flags = Object.values(schema.schema).map(fieldToInput);
 
     // Add help command
     flags.push({ name: 'help', flagNames: ['h'], description: 'display help for command', type: 'boolean' });
@@ -64,13 +70,13 @@ export class CliCommandSchemaUtil {
 
     const used = new Set(flags
       .flatMap(f => f.flagNames ?? [])
-      .filter(x => /^-[^-]/.test(x) || x.replaceAll('-', '').length < 3)
+      .filter(x => SHORT_FLAG.test(x) || x.replaceAll('-', '').length < 3)
       .map(x => x.replace(/^-+/, ''))
     );
 
     for (const flag of flags) {
-      let short = (flag.flagNames ?? []).find(x => /^-[^-]/.test(x) || x.replaceAll('-', '').length < 3)?.replace(/^-+/, '');
-      const long = (flag.flagNames ?? []).find(x => /^--[^-]/.test(x) || x.replaceAll('-', '').length > 2)?.replace(/^-+/, '') ??
+      let short = (flag.flagNames ?? []).find(x => SHORT_FLAG.test(x) || x.replaceAll('-', '').length < 3)?.replace(/^-+/, '');
+      const long = (flag.flagNames ?? []).find(x => LONG_FLAG.test(x) || x.replaceAll('-', '').length > 2)?.replace(/^-+/, '') ??
         flag.name.replace(/([a-z])([A-Z])/g, (_, l, r: string) => `${l}-${r.toLowerCase()}`);
       const aliases: string[] = flag.flagNames = [];
 
@@ -123,7 +129,7 @@ export class CliCommandSchemaUtil {
 
     for (const el of schema.args) {
       // Siphon off unrecognized flags, in order
-      while (i < copy.length && copy[i].startsWith('-')) {
+      while (i < copy.length && VALID_FLAG.test(copy[i])) {
         i += 1;
       }
 
@@ -132,7 +138,7 @@ export class CliCommandSchemaUtil {
       } else if (el.array) {
         const sub: string[] = [];
         while (i < copy.length) {
-          if (!copy[i].startsWith('-')) {
+          if (!VALID_FLAG.test(copy[i])) {
             sub.push(copy[i]);
             found[i] = true;
           }
@@ -196,7 +202,7 @@ export class CliCommandSchemaUtil {
       } else if (isBoolFlag(input)) {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         template[key] = !arg.startsWith('--no') as T[typeof key];
-      } else if (next === undefined || next.startsWith('-')) {
+      } else if (next === undefined || VALID_FLAG.test(next)) {
         // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
         template[key] = null as T[typeof key];
       } else if (input.array) {
@@ -232,16 +238,18 @@ export class CliCommandSchemaUtil {
       async (): Promise<void> => {
         const res = await cmd.validate?.(...args);
         if (res) {
-          throw new ValidationResultError(Array.isArray(res) ? res : [res]);
+          throw new CliValidationResultError(Array.isArray(res) ? res : [res]);
         }
       },
     ];
 
+    const SOURCES = ['flag', 'arg', 'custom'] as const;
+
     const results = validators.map((x, i) => x().catch(err => {
-      if (!(err instanceof ValidationResultError)) {
+      if (!(err instanceof CliValidationResultError) && !(err instanceof ValidationResultError)) {
         throw err;
       }
-      return err.errors.map(v => ({ ...v, message: `${v.message}. [${i}]`, index: i }));
+      return err.errors.map(v => ({ source: SOURCES[i], ...v }));
     }));
 
     const errors = (await Promise.all(results)).flatMap(x => (x ?? []));

package/src/scm.ts

@@ -47,7 +47,7 @@ export class CliScmUtil {
    */
   static async findChangedModulesSince(hash: string): Promise<IndexedModule[]> {
     const ws = RootIndex.manifest.workspacePath;
-    const res = await ExecUtil.spawn('git', ['diff', '--name-only', `HEAD..${hash}`], { cwd: ws }).result;
+    const res = await ExecUtil.spawn('git', ['diff', '--name-only', `HEAD..${hash}`, ':!**/DOC.tsx', ':!**/DOC.html', ':!**/README.md'], { cwd: ws }).result;
     const out = new Set<IndexedModule>();
     for (const line of res.stdout.split(/\n/g)) {
       const mod = RootIndex.getFromSource(path.resolve(ws, line));

package/src/types.ts

@@ -13,13 +13,9 @@ export type CliValidationError = {
    */
   message: string;
   /**
-   * The object path of the error
+   * Source of validation
    */
-  path: string;
-  /**
-   * The kind of validation
-   */
-  kind: string;
+  source?: 'flag' | 'arg' | 'custom';
 };
 
 /**
@@ -65,7 +61,7 @@ export interface CliCommandShape {
   /**
    * Validation method
    */
-  validate?(...args: unknown[]): OrProm<CliValidationError | CliValidationError[] | undefined>;
+  validate?(...unknownArgs: unknown[]): OrProm<CliValidationError | CliValidationError[] | undefined>;
 }
 
 /**
@@ -75,6 +71,7 @@ export type CliCommandInput = {
   name: string;
   description?: string;
   type: 'string' | 'file' | 'number' | 'boolean' | 'date' | 'regex';
+  fileExtensions?: string[];
   choices?: unknown[];
   required?: boolean;
   array?: boolean;

package/src/util.ts

@@ -12,7 +12,7 @@ export class CliUtil {
    * Get a simplified version of a module name
    * @returns
    */
-  static getSimpleModuleName(name = RootIndex.mainPackage.name): string {
+  static getSimpleModuleName(name = RootIndex.mainModuleName): string {
     return name.replace(/[\/]/, '_').replace(/@/, '');
   }
 }

package/support/cli.cli_schema.ts

@@ -17,9 +17,8 @@ export class CliSchemaCommand {
   async validate(name?: string): Promise<CliValidationError | undefined> {
     if (name && !CliCommandRegistry.getCommandMapping().has(name)) {
       return {
-        kind: 'invalid',
-        path: 'name',
-        message: `${name} is not a valid cli command`
+        source: 'arg',
+        message: `name: ${name} is not a valid cli command`
       };
     }
   }

package/support/cli.main.ts

@@ -25,11 +25,7 @@ export class MainCommand implements CliCommandShape {
   async validate(fileOrImport: string): Promise<CliValidationError | undefined> {
     const imp = await this.#getImport(fileOrImport);
     if (!imp) {
-      return {
-        message: `Unknown file: ${fileOrImport}`,
-        kind: 'required',
-        path: 'fileOrImport'
-      };
+      return { message: `Unknown file: ${fileOrImport}` };
     }
   }
 

package/support/cli.exec.ts

@@ -1,55 +0,0 @@
-import { CliCommand, CliCommandShape, CliModuleUtil } from '@travetto/cli';
-import { WorkPool } from '@travetto/worker';
-import { RootIndex } from '@travetto/manifest';
-import { ExecUtil, GlobalEnvConfig } from '@travetto/base';
-import { Max, Min } from '@travetto/schema';
-
-/**
- * Repo execution
- */
-@CliCommand()
-export class RepoExecCommand implements CliCommandShape {
-
-  #unknownArgs?: string[];
-
-  /** Only changed modules */
-  changed = true;
-
-  /** Number of concurrent workers */
-  @Min(1) @Max(WorkPool.MAX_SIZE)
-  workers = WorkPool.DEFAULT_SIZE;
-
-  /** Prefix output by folder */
-  prefixOutput = true;
-
-  /** Show stdout */
-  showStdout = true;
-
-  isActive(): boolean {
-    return !!RootIndex.manifest.monoRepo;
-  }
-
-  envInit(): GlobalEnvConfig {
-    return { debug: false };
-  }
-
-  finalize(unknownArgs?: string[] | undefined): void | Promise<void> {
-    this.#unknownArgs = unknownArgs;
-  }
-
-  async main(cmd: string, args: string[]): Promise<void> {
-    const finalArgs = [...args, ...this.#unknownArgs ?? []];
-
-    await CliModuleUtil.execOnModules(
-      this.changed ? 'changed' : 'all',
-      // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      (mod, opts) => ExecUtil.spawn(cmd, finalArgs, opts),
-      {
-        progressMessage: mod => `Running '${cmd} ${finalArgs.join(' ')}' [%idx/%total] ${mod?.sourceFolder ?? ''}`,
-        showStdout: this.showStdout,
-        prefixOutput: this.prefixOutput,
-        workerCount: this.workers,
-      }
-    );
-  }
-}

package/support/cli.list.ts

@@ -1,51 +0,0 @@
-import { CliCommandShape, CliCommand, CliModuleUtil } from '@travetto/cli';
-import { RootIndex } from '@travetto/manifest';
-
-const write = (line: string): Promise<void> => new Promise(r => process.stdout.write(`${line}\n`, () => r()));
-
-/**
- * Allows for listing of modules
- */
-@CliCommand()
-export class ListModuleCommand implements CliCommandShape {
-
-  /** Only show changed modules */
-  changed = false;
-
-  /** Output format */
-  format: 'graph' | 'json' | 'list' = 'list';
-
-  isActive(): boolean {
-    return !!RootIndex.manifest.monoRepo;
-  }
-
-  async main(): Promise<void> {
-
-    const mods = await CliModuleUtil.findModules(this.changed ? 'changed' : 'all');
-    switch (this.format) {
-      case 'list': {
-        for (const mod of mods.map(x => x.sourceFolder).sort()) {
-          await write(mod);
-        }
-        break;
-      }
-      case 'json': {
-        const outputMap = CliModuleUtil.getDependencyGraph(mods);
-        await write(JSON.stringify(Object.entries(outputMap).map(([name, children]) => ({ name, children })), null, 2));
-        break;
-      }
-      case 'graph': {
-        await write('digraph g {');
-        for (const el of mods) {
-          for (const dep of el.parents) {
-            if (dep !== RootIndex.mainPackage.name) {
-              await write(`  "${dep}" -> "${el.name}";`);
-            }
-          }
-        }
-        await write('}');
-        break;
-      }
-    }
-  }
-}

package/support/cli.version-sync.ts

@@ -1,16 +0,0 @@
-import { CliCommandShape, CliCommand, CliModuleUtil } from '@travetto/cli';
-import { RootIndex } from '@travetto/manifest';
-
-/**
- * Enforces all packages to write out their versions and dependencies
- */
-@CliCommand()
-export class VersionSyncCommand implements CliCommandShape {
-  isActive(): boolean {
-    return !!RootIndex.manifest.monoRepo;
-  }
-
-  async main(): Promise<void> {
-    await CliModuleUtil.synchronizeModuleVersions();
-  }
-}