@travetto/cli 3.0.0-rc.9 → 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,12 +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.

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@travetto/cli",
-  "version": "3.0.0-rc.9",
-  "description": "CLI infrastructure for travetto framework",
+  "version": "3.0.0",
+  "description": "CLI infrastructure for Travetto framework",
   "keywords": [
     "cli",
     "travetto",
@@ -16,19 +16,17 @@
   "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.8",
-    "@travetto/terminal": "^3.0.0-rc.6",
-    "@travetto/worker": "^3.0.0-rc.8",
+    "@travetto/base": "^3.0.0",
+    "@travetto/terminal": "^3.0.0",
+    "@travetto/worker": "^3.0.0",
     "commander": "^10.0.0"
   },
   "travetto": {

package/src/command-manager.ts

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

@@ -221,13 +221,14 @@ export abstract class CliCommand<V extends OptionMap = OptionMap> {
     if (args) {
       cmd = cmd.arguments(args);
     }
+
     for (const cfg of await this.finalizeOptions()) {
       const pre = cfg.short ? `-${cfg.short}, ` : '';
       if (cfg.type === Boolean) {
         if (cfg.def) {
-          cmd.option(`${pre}--no-${cfg.name}`, `Disables: ${cfg.desc}`);
+          cmd = cmd.option(`${pre}--no-${cfg.name}`, `Disables: ${cfg.desc}`);
         } else {
-          cmd.option(`${pre}--${cfg.name}`, cfg.desc);
+          cmd = cmd.option(`${pre}--${cfg.name}`, cfg.desc);
         }
       } else {
         const key = `${pre}--${cfg.name} <${cfg.name}>`;
@@ -238,6 +239,9 @@ export abstract class CliCommand<V extends OptionMap = OptionMap> {
 
     cmd = cmd.action(this.runAction.bind(this));
 
+    // @ts-expect-error, Do nothing
+    cmd.missingArgument = (): void => { };
+
     return this.#cmd = cmd;
   }
 

package/src/execute.ts

@@ -1,9 +1,7 @@
-import fs from 'fs/promises';
 import { program as commander } from 'commander';
 
-import { PackageUtil, path, RootIndex } from '@travetto/manifest';
+import { PackageUtil } from '@travetto/manifest';
 import { GlobalTerminal } from '@travetto/terminal';
-import { ShutdownManager } from '@travetto/base';
 
 import { CliCommandManager } from './command-manager';
 import { HelpUtil } from './help';
@@ -43,46 +41,25 @@ 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(argv: string[]): Promise<void> {
-    const { init } = await import('@travetto/base/support/init.js');
-    await init();
+    await GlobalTerminal.init();
 
-    const width = GlobalTerminal.width;
     commander
       .version(PackageUtil.getFrameworkVersion())
-      .configureOutput({ getOutHelpWidth: () => width, getErrHelpWidth: () => width });
+      .configureOutput({
+        getOutHelpWidth: () => GlobalTerminal.width,
+        getErrHelpWidth: () => GlobalTerminal.width
+      });
+
+    const { init } = await import('@travetto/base/support/init.js');
+    await init();
 
     const [, , cmd, ...args] = argv;
-    if (cmd === 'main') {
-      const [file, ...rest] = args;
-      await this.runMain(file, rest);
-    } else if (cmd && !cmd.startsWith('-')) {
+    if (cmd && !cmd.startsWith('-')) {
       await this.runCommand(cmd, args);
     } else {
       // Load all commands

package/src/module.ts

@@ -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);
@@ -108,8 +112,10 @@ export class CliModuleUtil {
   /**
    * 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.sourcePath));
+  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

@@ -37,11 +37,15 @@ export class RepoExecCommand extends CliCommand<Options> {
     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?.sourceFolder ?? ''}`,
         showStdout: this.cmd.showStdout,

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);
+    }
+  }
+}