@travetto/compiler 8.0.0-alpha.7 → 8.0.0-alpha.8

package/README.md

@@ -25,7 +25,7 @@ Beyond the [Typescript](https://typescriptlang.org) compiler functionality, the
 The compiler cli, [trvc](https://github.com/travetto/travetto/tree/main/module/compiler/bin/trvc.js) is the entry point for compilation-related operations. It has the ability to check for active builds, and ongoing watch operations to ensure only one process is building at a time.  Within the framework, regardless of mono-repo or not, the compilation always targets the entire project.  With the efficient caching behavior, this leads to generally a minimal overhead but allows for centralization of all operations. 
 
 The compiler cli supports the following operations:
-   *  `start|watch` - Run the compiler in watch mode
+   *  `start` - Run the compiler in watch mode
    *  `stop` - Stop the compiler if running
    *  `restart` - Restart the compiler in watch mode
    *  `build` - Ensure the project is built and upto date

package/bin/trvc.js

@@ -3,4 +3,4 @@
 import '@travetto/runtime/support/patch.js';
 import './hook.js';
 const { invoke } = await import('@travetto/compiler/support/invoke.ts');
-await invoke();
+await invoke(...process.argv.slice(2));

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@travetto/compiler",
-  "version": "8.0.0-alpha.7",
+  "version": "8.0.0-alpha.8",
   "type": "module",
   "description": "The compiler infrastructure for the Travetto framework",
   "keywords": [
@@ -35,7 +35,7 @@
     "@travetto/transformer": "^8.0.0-alpha.4"
   },
   "peerDependencies": {
-    "@travetto/cli": "^8.0.0-alpha.9"
+    "@travetto/cli": "^8.0.0-alpha.11"
   },
   "peerDependenciesMeta": {
     "@travetto/cli": {

package/support/invoke.ts

@@ -7,40 +7,62 @@ import { CompilerClient } from '../src/server/client.ts';
 import { CommonUtil } from '../src/common.ts';
 import { EventUtil } from '../src/event.ts';
 
-const HELP = `
-trvc [command]
+const hasColor = (process.stdout.isTTY && /^(0)*$/.test(process.env.NO_COLOR ?? '')) || /1\d*/.test(process.env.FORCE_COLOR ?? '');
+const color = (code: number) => (value: string): string => hasColor ? `\x1b[${code}m${value}\x1b[0m` : `${value}`;
+const STYLE = { error: color(91), title: color(36), main: color(92), command: color(35), arg: color(37), description: color(33), };
 
-Available Commands:
- * start|watch                  - Run the compiler in watch mode
- * stop                         - Stop the compiler if running
- * restart                      - Restart the compiler in watch mode
- * build                        - Ensure the project is built and upto date
- * clean                        - Clean out the output and compiler caches
- * info                         - Retrieve the compiler information, if running
- * event <log|progress|state>   - Watch events in realtime as newline delimited JSON
- * exec <file> [...args]        - Allow for compiling and executing an entrypoint file
- * manifest [output]            - Generate the project manifest
- * manifest:production [output] - Generate the production project manifest
-`;
+const COMMANDS = {
+  start: { description: 'Run the compiler in watch mode' },
+  stop: { description: 'Stop the compiler if running' },
+  restart: { description: 'Restart the compiler in watch mode' },
+  build: { description: 'Ensure the project is built and upto date' },
+  clean: { description: 'Clean out the output and compiler caches' },
+  info: { description: 'Retrieve the compiler information, if running' },
+  event: { args: ['<log|progress|state>'], description: 'Watch events in realtime as newline delimited JSON' },
+  exec: { args: ['<file>', '[...args]'], description: 'Allow for compiling and executing an entrypoint file' },
+  manifest: { args: ['[output]'], description: 'Generate the project manifest' },
+  'manifest:production': { args: ['[output]'], description: 'Generate the production project manifest' }
+} as const;
+
+function showHelp(errorMessage?: string): void {
+  const PREPARED = Object.entries(COMMANDS)
+    .map(([name, config]) => ({ args: [], ...config, name }))
+    .map(config => ({ ...config, commandLength: [config.name, ...config.args].join(' ').length }));
+
+  const commandWidth = Math.max(...PREPARED.map(config => config.commandLength));
+
+  console.log([
+    ...(errorMessage ? ['', STYLE.error(errorMessage)] : []),
+    '', `${STYLE.main('trvc')} ${STYLE.command('[command]')}`,
+    '', STYLE.title('Available Commands'),
+    ...PREPARED.map(({ name, args, description, commandLength }) => [
+      '*', STYLE.command(name), ...args.map(arg => STYLE.arg(arg)),
+      ' '.repeat(commandWidth - commandLength), '-', STYLE.description(description)
+
+    ].join(' ')),
+    ''
+  ].join('\n'));
+}
+
+const validateInputs = (value: string[]): value is [keyof typeof COMMANDS, ...string[]] => !!value.length && value[0] in COMMANDS;
 
 /**
  * Invoke the compiler
  */
-export async function invoke(operation?: string, args: string[] = []): Promise<unknown> {
-  if (operation === undefined) {
-    [operation, ...args] = process.argv.slice(2);
+export async function invoke(...input: string[]): Promise<unknown> {
+  if (!validateInputs(input)) {
+    return showHelp(input[0] ? `Unknown trvc command: ${input[0]}` : undefined);;
   }
+
+  const [command, ...args] = input;
   const ctx = getManifestContext();
   const client = new CompilerClient(ctx, Log.scoped('client'));
 
   Log.initLevel('error');
   Log.root = ctx.workspace.path;
 
-  switch (operation) {
-    case undefined:
-    case 'help': console.log(HELP); break;
-    case 'start':
-    case 'watch': return CompilerManager.compile(ctx, client, { watch: true });
+  switch (command) {
+    case 'start': return CompilerManager.compile(ctx, client, { watch: true });
     case 'build': return CompilerManager.compile(ctx, client, { watch: false });
     case 'restart': return CompilerManager.compile(ctx, client, { watch: true, forceRestart: true });
     case 'info': {
@@ -59,7 +81,7 @@ export async function invoke(operation?: string, args: string[] = []): Promise<u
     case 'manifest:production':
     case 'manifest': {
       let manifest = await ManifestUtil.buildManifest(ctx);
-      if (operation === 'manifest:production') {
+      if (command === 'manifest:production') {
         manifest = ManifestUtil.createProductionManifest(manifest);
       }
       if (args[0]) {
@@ -92,6 +114,5 @@ export async function invoke(operation?: string, args: string[] = []): Promise<u
       // Return function to run import on a module
       return import(importTarget);
     }
-    default: console.error(`\nUnknown trvc operation: ${operation}\n${HELP}`);
   }
 }