@travetto/cli 3.0.0-rc.8 → 3.0.0

package/README.md

@@ -1,11 +1,15 @@
 <!-- This file was generated by @travetto/doc and should not be modified directly -->
 <!-- Please modify https://github.com/travetto/travetto/tree/main/module/cli/DOC.ts and execute "npx trv doc" to rebuild -->
 # Command Line Interface
-## CLI infrastructure for travetto framework
+## CLI infrastructure for Travetto framework
 
 **Install: @travetto/cli**
 ```bash
 npm install @travetto/cli
+
+# or
+
+yarn add @travetto/cli
 ```
 
 The cli is the primary structure for interacting with the external requirements of the framework.  This can range from running tests, to running applications, to generating email templates. The main executable can be installed globally or locally.  If installed globally and locally, it will defer to the local installation for execution.
@@ -21,14 +25,13 @@ $ trv --help
 Usage:  [options] [command]
 
 Options:
-  -V, --version             output the version number
-  -h, --help                display help for command
+  -V, --version                  output the version number
+  -h, --help                     display help for command
 
 Commands:
   echo [options] [args...]
-  help [command]            display help for command
-
-
+  main <fileOrImport> [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 +53,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 +78,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 +89,4 @@ And actually using it:
 $ trv echo -u bOb rOb DRoP
 
 [ 'BOB', 'ROB', 'DROP' ]
-
 ```

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/cli",
-  "version": "3.0.0-rc.8",
-  "description": "CLI infrastructure for travetto framework",
+  "version": "3.0.0",
+  "description": "CLI infrastructure for Travetto framework",
   "keywords": [
     "cli",
     "travetto",
@@ -16,20 +16,18 @@
   "files": [
     "__index__.ts",
     "src",
-    "support",
-    "bin"
+    "support"
   ],
-  "bin": "trv.js",
   "main": "__index__.ts",
   "repository": {
     "url": "https://github.com/travetto/travetto.git",
     "directory": "module/cli"
   },
   "dependencies": {
-    "@travetto/base": "^3.0.0-rc.7",
-    "@travetto/terminal": "^3.0.0-rc.5",
-    "@travetto/worker": "^3.0.0-rc.7",
-    "commander": "^9.5.0"
+    "@travetto/base": "^3.0.0",
+    "@travetto/terminal": "^3.0.0",
+    "@travetto/worker": "^3.0.0",
+    "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;
   }
@@ -46,9 +46,14 @@ export class CliCommandManager {
       const matchedCfg = COMMAND_PACKAGE.find(([re]) => re.test(cmd));
       if (matchedCfg) {
         const [, pkg, prod] = matchedCfg;
+        let install: string;
+        switch (RootIndex.manifest.packageManager) {
+          case 'npm': install = `npm i ${prod ? '' : '--save-dev '}@travetto/${pkg}`; break;
+          case 'yarn': install = `yarn add ${prod ? '' : '--dev '}@travetto/${pkg}`; break;
+        }
         console.error!(cliTpl`
 ${{ title: 'Missing Package' }}\n${'-'.repeat(20)}\nTo use ${{ input: cmd }} please run:\n
-${{ identifier: `npm i ${prod ? '' : '--save-dev '}@travetto/${pkg}` }}
+${{ identifier: install }}
 `);
         await ShutdownManager.exit(1);
       }

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,22 +217,31 @@ 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 = cmd.option(`${pre}--no-${cfg.name}`, `Disables: ${cfg.desc}`);
+        } else {
+          cmd = 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));
 
+    // @ts-expect-error, Do nothing
+    cmd.missingArgument = (): void => { };
+
     return this.#cmd = cmd;
   }
 

package/src/execute.ts

@@ -1,8 +1,7 @@
 import { program as commander } from 'commander';
 
-import { RootIndex, PackageUtil, path } from '@travetto/manifest';
+import { PackageUtil } from '@travetto/manifest';
 import { GlobalTerminal } from '@travetto/terminal';
-import { runMain } from '@travetto/base/support/init.main';
 
 import { CliCommandManager } from './command-manager';
 import { HelpUtil } from './help';
@@ -15,9 +14,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 +29,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)) {
@@ -48,23 +45,22 @@ export class ExecutionManager {
    * Execute the command line
    * @param args
    */
-  static async run(args: string[]): Promise<void> {
-    const width = GlobalTerminal.width;
+  static async run(argv: string[]): Promise<void> {
+    await GlobalTerminal.init();
+
     commander
       .version(PackageUtil.getFrameworkVersion())
-      .configureOutput({ getOutHelpWidth: () => width, getErrHelpWidth: () => width });
+      .configureOutput({
+        getOutHelpWidth: () => GlobalTerminal.width,
+        getErrHelpWidth: () => GlobalTerminal.width
+      });
 
-    const cmd = args[2];
+    const { init } = await import('@travetto/base/support/init.js');
+    await init();
 
-    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));
-    } else if (cmd && !cmd.startsWith('-')) {
-      await this.runCommand(args);
+    const [, , cmd, ...args] = argv;
+    if (cmd && !cmd.startsWith('-')) {
+      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)]));
   }
@@ -78,6 +78,10 @@ export class CliModuleUtil {
       hash = await CliScmUtil.findLastRelease();
     }
 
+    if (!hash) {
+      return RootIndex.getLocalModules();
+    }
+
     const out = new Map<string, IndexedModule>();
     for (const mod of await CliScmUtil.findChangedModulesSince(hash)) {
       out.set(mod.name, mod);
@@ -102,14 +106,16 @@ 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));
+  static async synchronizeModuleVersions(): Promise<Record<string, string>> {
+    const versions = {};
+    await PackageUtil.syncVersions((await this.findModules('all')).map(x => x.sourcePath), versions);
+    return versions;
   }
 
   /**

package/src/scm.ts

@@ -32,13 +32,12 @@ export class CliScmUtil {
    * Find the last code release
    * @returns
    */
-  static async findLastRelease(): Promise<string> {
+  static async findLastRelease(): Promise<string | undefined> {
     const root = await RootIndex.manifest;
     const { result } = ExecUtil.spawn('git', ['log', '--pretty=oneline'], { cwd: root.workspacePath });
     return (await result).stdout
       .split(/\n/)
-      .find(x => /Publish /.test(x))!
-      .split(/\s+/)[0]!;
+      .find(x => /Publish /.test(x))?.split(/\s+/)?.[0];
   }
 
   /**

package/support/cli.exec.ts

@@ -30,20 +30,24 @@ export class RepoExecCommand extends CliCommand<Options> {
   }
 
   getArgs(): string {
-    return '[command] [...args]';
+    return '<command> [...args]';
   }
 
   envInit(): GlobalEnvConfig {
     return { debug: false };
   }
 
-  async action(): Promise<void> {
+  async action(cmd: string, args: string[]): Promise<void> {
+    if (!cmd) {
+      return this.showHelp('Command is a required field');
+    }
+
     await CliModuleUtil.execOnModules(
       this.cmd.changed ? 'changed' : 'all',
       // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
-      (mod, opts) => ExecUtil.spawn(this.args[0], this.args.slice(1), opts),
+      (mod, opts) => ExecUtil.spawn(cmd, args, 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.main.ts

@@ -0,0 +1,38 @@
+import fs from 'fs/promises';
+
+import { ShutdownManager } from '@travetto/base';
+import { CliCommand } from '@travetto/cli';
+import { path, RootIndex } from '@travetto/manifest';
+
+/**
+ * `npx trv main`
+ *
+ * Allows for running of main entry points
+ */
+export class MainCommand extends CliCommand {
+
+  name = 'main';
+
+  getArgs(): string {
+    return '<fileOrImport> [args...]';
+  }
+
+  async action(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);
+    }
+  }
+}

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
-}