Function yargsCli

packages/cli/src/lib/yargs-cli.ts:47–145

(
  argv: string[],
  cfg: {
    usageMessage?: string;
    scriptName?: string;
    commands?: CommandModule[];
    options?: { [key: string]: Options };
    groups?: { [key: string]: string[] };
    examples?: [string, string][];
    middlewares?: {
      middlewareFunction: MiddlewareFunction;
      applyBeforeValidation?: boolean;
    }[];
    noExitProcess?: boolean;
  },
)

 * yargsCli(hideBin(process.argv)).argv;
 */
export function yargsCli<T = unknown>(
  argv: string[],
  cfg: {
    usageMessage?: string;
    scriptName?: string;
    commands?: CommandModule[];
    options?: { [key: string]: Options };
    groups?: { [key: string]: string[] };
    examples?: [string, string][];
    middlewares?: {
      middlewareFunction: MiddlewareFunction;
      applyBeforeValidation?: boolean;
    }[];
    noExitProcess?: boolean;
  },
): Argv<T> {
  const { usageMessage, scriptName, noExitProcess } = cfg;
  const commands = cfg.commands ?? [];
  const middlewares = cfg.middlewares ?? [];
  const options = cfg.options ?? {};
  const groups = cfg.groups ?? {};
  const examples = cfg.examples ?? [];
  const cli = yargs(argv);

  // setup yargs
  cli
    .updateLocale(yargsDecorator)
    // take minimum of TERMINAL_WIDTH or full width of the terminal
    .wrap(Math.max(TERMINAL_WIDTH, cli.terminalWidth()))
    .help('help', descriptionStyle('Show help'))
    .alias('h', 'help')
    .showHelpOnFail(false)
    .version('version', ansis.dim('Show version'), getVersion())
    .check(args => {
      const persist = args['persist'] as PersistConfig | undefined;
      return persist == null || validatePersistFormat(persist);
    })
    .parserConfiguration({
      'strip-dashed': true,
    } satisfies Partial<ParserConfigurationOptions>)
    .options(formatNestedValues(options, 'describe'));

  // use last argument for non-array options
  coerceArraysByOptionType(cli, options);

  // usage message
  if (usageMessage) {
    cli.usage(titleStyle(usageMessage));
  }

  // script name
  if (scriptName) {
    cli.scriptName(scriptName);
  }

  // add examples
  examples.forEach(([exampleName, description]) =>
    cli.example(exampleName, descriptionStyle(description)),