@travetto/cli 3.0.0-rc.7 → 3.0.0-rc.9

package/README.md

@@ -27,8 +27,6 @@ Options:
 Commands:
   echo [options] [args...]
   help [command]            display help for command
-
-
 ```
 
 This will show all the available options/choices that are exposed given the currently installed modules.
@@ -50,7 +48,7 @@ export class CliEchoCommand extends CliCommand {
   name = 'echo';
 
   getOptions() {
-    return { uppercase: this.boolOption({ desc: 'Upper case', def: false }) };
+    return { uppercase: this.boolOption({ desc: 'Upper case' }) };
   }
 
   getArgs() {
@@ -75,10 +73,8 @@ $ trv echo --help
 Usage:  echo [options] [args...]
 
 Options:
-  -u, --uppercase  Upper case (default: false)
+  -u, --uppercase  Upper case
   -h, --help       display help for command
-
-
 ```
 
 And actually using it:
@@ -88,5 +84,4 @@ And actually using it:
 $ trv echo -u bOb rOb DRoP
 
 [ 'BOB', 'ROB', 'DROP' ]
-
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/cli",
-  "version": "3.0.0-rc.7",
+  "version": "3.0.0-rc.9",
   "description": "CLI infrastructure for travetto framework",
   "keywords": [
     "cli",
@@ -26,10 +26,10 @@
     "directory": "module/cli"
   },
   "dependencies": {
-    "@travetto/base": "^3.0.0-rc.7",
-    "@travetto/terminal": "^3.0.0-rc.4",
-    "@travetto/worker": "^3.0.0-rc.7",
-    "commander": "^9.5.0"
+    "@travetto/base": "^3.0.0-rc.8",
+    "@travetto/terminal": "^3.0.0-rc.6",
+    "@travetto/worker": "^3.0.0-rc.8",
+    "commander": "^10.0.0"
   },
   "travetto": {
     "displayName": "Command Line Interface"

package/src/command-manager.ts

@@ -24,8 +24,8 @@ export class CliCommandManager {
    */
   static getCommandMapping(): Map<string, string> {
     const all = new Map<string, string>();
-    for (const { output } of RootIndex.findSupport({ filter: /\/cli[.]/, checkProfile: false })) {
-      all.set(output.replace(/^.*\/cli[.](.*?)[.][^.]+$/, (_, f) => f), output);
+    for (const { outputFile: output, import: imp } of RootIndex.findSupport({ filter: /\/cli[.]/, checkProfile: false })) {
+      all.set(output.replace(/^.*\/cli[.](.*?)[.][^.]+$/, (_, f) => f), imp);
     }
     return all;
   }

package/src/command.ts

@@ -1,5 +1,5 @@
 import { appendFile, mkdir } from 'fs/promises';
-import type * as commander from 'commander';
+import type commander from 'commander';
 
 import { path } from '@travetto/manifest';
 import { ConsoleManager, DataUtil, defineGlobalEnv, GlobalEnvConfig, ShutdownManager } from '@travetto/base';
@@ -74,7 +74,7 @@ export abstract class CliCommand<V extends OptionMap = OptionMap> {
   /**
     * Get args
     */
-  getArgs?(): string;
+  getArgs?(): string | undefined;
   /**
    * Initialization code for adding options
    */
@@ -135,8 +135,8 @@ export abstract class CliCommand<V extends OptionMap = OptionMap> {
   boolOption(cfg: OptionConfig<boolean>): OptionConfig<boolean> {
     return {
       type: Boolean,
-      // TODO: This needs to be resolved?
-      combine: (val, curr): boolean => DataUtil.coerceType(val, Boolean, false) ?? true,
+      combine: (val, curr): boolean =>
+        (val !== undefined ? DataUtil.coerceType(val, Boolean, false) : undefined) ?? curr,
       completion: true,
       ...cfg
     };
@@ -217,18 +217,23 @@ export abstract class CliCommand<V extends OptionMap = OptionMap> {
     if (this.init) {
       cmd = await this.init?.(cmd);
     }
-    if (this.getArgs) {
-      cmd = cmd.arguments(this.getArgs?.());
+    const args = this.getArgs?.();
+    if (args) {
+      cmd = cmd.arguments(args);
     }
     for (const cfg of await this.finalizeOptions()) {
-      let key = `${cfg.short ? `-${cfg.short}, ` : ''}--${cfg.name}`;
-      if (cfg.type !== Boolean || cfg.def) {
-        key = `${key} <${cfg.name}>`;
-      }
-      cmd = cfg.combine ?
+      const pre = cfg.short ? `-${cfg.short}, ` : '';
+      if (cfg.type === Boolean) {
+        if (cfg.def) {
+          cmd.option(`${pre}--no-${cfg.name}`, `Disables: ${cfg.desc}`);
+        } else {
+          cmd.option(`${pre}--${cfg.name}`, cfg.desc);
+        }
+      } else {
+        const key = `${pre}--${cfg.name} <${cfg.name}>`;
         // @ts-expect-error
-        cmd.option(key, cfg.desc, cfg.combine, cfg.def) :
-        cmd.option(key, cfg.desc, (cur, acc) => cur, cfg.def);
+        cmd = cmd.option(key, cfg.desc, cfg.combine ?? ((cur, acc): unknown => cur), cfg.def);
+      }
     }
 
     cmd = cmd.action(this.runAction.bind(this));

package/src/execute.ts

@@ -1,8 +1,9 @@
+import fs from 'fs/promises';
 import { program as commander } from 'commander';
 
-import { RootIndex, PackageUtil, path } from '@travetto/manifest';
+import { PackageUtil, path, RootIndex } from '@travetto/manifest';
 import { GlobalTerminal } from '@travetto/terminal';
-import { runMain } from '@travetto/base/support/init.main';
+import { ShutdownManager } from '@travetto/base';
 
 import { CliCommandManager } from './command-manager';
 import { HelpUtil } from './help';
@@ -15,9 +16,7 @@ export class ExecutionManager {
   /**
    * Run command
    */
-  static async runCommand(args: string[]): Promise<void> {
-    const cmd = args[2];
-
+  static async runCommand(cmd: string, args: string[]): Promise<void> {
     let command;
 
     try {
@@ -32,7 +31,7 @@ export class ExecutionManager {
       if (args.includes('-h') || args.includes('--help')) {
         return command.showHelp();
       } else {
-        await commander.parseAsync(args);
+        await commander.parseAsync([process.argv[0], process.argv[1], cmd, ...args]);
       }
     } catch (err) {
       if (!(err instanceof Error)) {
@@ -44,27 +43,47 @@ export class ExecutionManager {
     }
   }
 
+  /**
+   * Run file expecting a main method
+   */
+  static async runMain(file: string, args: string[]): Promise<void> {
+    try {
+      // If referenced file exists
+      if (await (fs.stat(path.resolve(file)).then(() => true, () => false))) {
+        file = path.join(RootIndex.manifest.mainModule, file);
+      }
+
+      const imp = RootIndex.getFromImport(file)?.import;
+      if (!imp) {
+        throw new Error(`Unknown file: ${file}`);
+      }
+
+      const mod = await import(imp);
+      await ShutdownManager.exitWithResponse(await mod.main(...args));
+    } catch (err) {
+      await ShutdownManager.exitWithResponse(err, true);
+    }
+  }
+
   /**
    * Execute the command line
    * @param args
    */
-  static async run(args: string[]): Promise<void> {
+  static async run(argv: string[]): Promise<void> {
+    const { init } = await import('@travetto/base/support/init.js');
+    await init();
+
     const width = GlobalTerminal.width;
     commander
       .version(PackageUtil.getFrameworkVersion())
       .configureOutput({ getOutHelpWidth: () => width, getErrHelpWidth: () => width });
 
-    const cmd = args[2];
-
+    const [, , cmd, ...args] = argv;
     if (cmd === 'main') {
-      let mainFile = RootIndex.resolveFileImport(process.argv[3])!;
-      if (!mainFile.startsWith('/')) {
-        mainFile = path.join(RootIndex.manifest.mainModule, mainFile);
-        mainFile = RootIndex.resolveFileImport(mainFile);
-      }
-      await runMain((await import(mainFile)).main, process.argv.slice(4));
+      const [file, ...rest] = args;
+      await this.runMain(file, rest);
     } else if (cmd && !cmd.startsWith('-')) {
-      await this.runCommand(args);
+      await this.runCommand(cmd, args);
     } else {
       // Load all commands
       await CliCommandManager.loadAllCommands(x => x.setup(commander));

package/src/help.ts

@@ -1,8 +1,9 @@
-import type * as commander from 'commander';
+import type commander from 'commander';
 
 import { cliTpl } from './color';
 
 const TYPE_PATTERN = /(\[[^\]]+\])/g;
+const REQ_TYPE_PATTERN = /(<[^>]+>)/g;
 const TITLE_PATTERN = /^(\S[^:]+:)/gim;
 
 const OPTIONS_PATTERN = new RegExp([
@@ -32,7 +33,7 @@ const COMMANDS_PATTERN = new RegExp([
   '(?<space>[ ]+)',
   '(?<name>\\S+)',
   '(?<optionsSpace>[ ]+)?',
-  '(?<options>\\[.*\\])?',
+  '(?<options>(?:\\[|<).*(?:\\]|>))?',
   '((?<descriptionSpace>[ ]+)(?<description>[a-z][^\\n\\[]+))?',
   '(?:[ ]+)?',
   '$',
@@ -50,7 +51,7 @@ const USAGE_PATTERN = new RegExp([
   '(?<space>[ ]+)?',
   '(?<name>[^\\[ ]+)?',
   '(?<nameSpace>[ ]+)?',
-  '(?<options>\\[.*\\])?',
+  '(?<options>(?:\\[|<).*(?:\\]|>))?',
   '(?:[ ]+)?',
   '$',
 ].join(''), 'gim');
@@ -135,7 +136,7 @@ export class HelpUtil {
         space,
         cliTpl`${{ param: name }}`,
         optionsSpace,
-        options?.replace(TYPE_PATTERN, input => cliTpl`${{ input }}`),
+        options?.replace(TYPE_PATTERN, input => cliTpl`${{ input }}`).replace(REQ_TYPE_PATTERN, type => cliTpl`${{ type }}`),
         descriptionSpace,
         cliTpl`${{ description }}`
       ]

package/src/module.ts

@@ -38,13 +38,13 @@ export class CliModuleUtil {
     stdoutTerm: Terminal,
     stderrTerm: Terminal
   ): ExecutionOptions {
-    const folder = mod.workspaceRelative;
+    const folder = mod.sourceFolder;
     const opts: ExecutionOptions = {
       stdio: ['ignore', 'pipe', 'pipe', 'ignore'],
       outputMode: 'text',
       catchAsResult: true,
       cwd: folder,
-      env: { TRV_MANIFEST: '' },
+      env: { TRV_MANIFEST: '', TRV_MODULE: mod.name },
     };
 
     if (config.showStdout) {
@@ -62,7 +62,7 @@ export class CliModuleUtil {
    * @returns
    */
   static #buildPrefixes(mods: IndexedModule[]): Record<string, string> {
-    const folders = mods.map(x => x.workspaceRelative);
+    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)]));
   }
@@ -102,14 +102,14 @@ export class CliModuleUtil {
     return (mode === 'changed' ?
       await this.findChangedModulesRecursive() :
       [...RootIndex.getModuleList('all')].map(x => RootIndex.getModule(x)!)
-    ).filter(x => x.source !== RootIndex.manifest.workspacePath);
+    ).filter(x => x.sourcePath !== RootIndex.manifest.workspacePath);
   }
 
   /**
    * Synchronize all workspace modules to have the correct versions from the current packages
    */
   static async synchronizeModuleVersions(): Promise<void> {
-    await PackageUtil.syncVersions((await this.findModules('all')).map(x => x.source));
+    await PackageUtil.syncVersions((await this.findModules('all')).map(x => x.sourcePath));
   }
 
   /**

package/support/cli.exec.ts

@@ -30,7 +30,7 @@ export class RepoExecCommand extends CliCommand<Options> {
   }
 
   getArgs(): string {
-    return '[command] [...args]';
+    return '<command> [...args]';
   }
 
   envInit(): GlobalEnvConfig {
@@ -43,7 +43,7 @@ export class RepoExecCommand extends CliCommand<Options> {
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
       (mod, opts) => ExecUtil.spawn(this.args[0], this.args.slice(1), opts),
       {
-        progressMessage: mod => `Running '${this.args.join(' ')}' [%idx/%total] ${mod?.workspaceRelative ?? ''}`,
+        progressMessage: mod => `Running '${this.args.join(' ')}' [%idx/%total] ${mod?.sourceFolder ?? ''}`,
         showStdout: this.cmd.showStdout,
         prefixOutput: this.cmd.prefixOutput,
         workerCount: this.cmd.workers,

package/support/cli.list.ts

@@ -29,7 +29,7 @@ export class RepoListCommand extends CliCommand<Options> {
   async action(...args: unknown[]): Promise<void> {
     const mods = await CliModuleUtil.findModules(this.cmd.changed ? 'changed' : 'all');
     if (!this.cmd.graph) {
-      for (const mod of mods.map(x => x.workspaceRelative).sort()) {
+      for (const mod of mods.map(x => x.sourceFolder).sort()) {
         console.log!(mod);
       }
     } else {

package/support/cli.ts

@@ -0,0 +1,3 @@
+import { ExecutionManager } from '@travetto/cli';
+
+ExecutionManager.run(process.argv);

package/support/main.cli.ts

@@ -1,8 +0,0 @@
-import { ExecutionManager } from '@travetto/cli';
-
-/**
- * Entry point
- */
-export async function main(): Promise<void> {
-  return ExecutionManager.run(process.argv); // Run cli
-}