@travetto/app/support/bin/help.ts

Application registration/management and run support.

import { cliTpl } from '@travetto/cli';
import { stripAnsiCodes } from '@travetto/terminal';

import type { ApplicationConfig } from '../../src/types';

export class HelpUtil {

  /**
   * Convert single ApplicationConfig into a stylized entry
   */
  static getAppUsage(app: ApplicationConfig): string {
    let usage = app.globalName;

    if (app.params) {
      usage = cliTpl`${{ identifier: usage }} ${app.params.map(p => {
        let type = p.type.toLowerCase();
        if (p.enum) {
          type = p.enum.values.map(x => `${x}`).join('|');
        }
        return !p.required ?
          (p.default !== undefined ?
            // eslint-disable-next-line @typescript-eslint/consistent-type-assertions
            cliTpl`[${{ param: p.name }}:${{ type }}=${{ input: p.default as string }}]` :
            cliTpl`[${{ param: p.name }}:${{ type }}]`
          ) : cliTpl`${{ param: p.name }}:${{ type }}`;
      }).join(' ')}`;
    }

    return usage;
  }

  /**
   * Generate list of all help entries
   */
  static generateAppHelpList(configs: ApplicationConfig[] | undefined): string {
    const choices: string[][] = [];
    if (!configs || !configs.length) {
      return cliTpl`\nNo applications defined, use ${{ type: '@Application' }} to registry entry points`;
    }
    for (const conf of configs) {
      const lines = [];

      const usage = this.getAppUsage(conf);

      lines.push(cliTpl`${{ param: conf.globalName }} ${{ title: conf.description }}`);
      lines.push(cliTpl`${{ subtitle: 'usage' }}:  ${usage}`);
      lines.push(cliTpl`${{ subtitle: 'target' }}: ${{ path: conf.targetId }}`);
      choices.push(lines.map((x, i) => `   ${i === 0 ? '●' : ' '} ${x}`));
    }

    const allLines = choices.flat();
    const len = allLines.reduce((acc, v) => Math.max(acc, stripAnsiCodes(v).length), 0);
    const div = cliTpl`${{ subsubtitle: '     '.padEnd(len, '—') }}`;
    return choices.map(x => x.join('\n')).join(`\n\n${div}\n\n`);
  }
}