import { createImplementation } from "@webiny/di"; import { Command, CommandsRegistryService, GetCliRunnerService, LoggerService, UiService } from "../../abstractions/index.js"; import yargs from "yargs/yargs"; import { Argv } from "yargs"; export class DefaultGetCliRunnerService implements GetCliRunnerService.Interface { constructor( private readonly commandsRegistryService: CommandsRegistryService.Interface, private readonly uiService: UiService.Interface, private readonly loggerService: LoggerService.Interface ) {} private yargsRunner: Argv | null = null; async execute() { if (this.yargsRunner) { return this.yargsRunner; } const ui = this.uiService; const yargsRunner = yargs() .usage("Usage: $0 [options]") .help(false) .demandCommand(1) .recommendCommands() .scriptName("webiny") .fail((invalidParamsMessage, error) => { if (invalidParamsMessage) { if (invalidParamsMessage.includes("Not enough non-option arguments")) { ui.newLine(); ui.error("Command was not invoked as expected."); ui.info( `Some non-optional arguments are missing. See the usage examples printed below.` ); ui.newLine(); yargsRunner.showHelp(); process.exit(1); } if (invalidParamsMessage.includes("Missing required argument")) { const args = invalidParamsMessage .split(":")[1] .split(",") .map(v => v.trim()); ui.newLine(); ui.error("Command was not invoked as expected."); ui.info( `Missing required argument(s): ${args.join( ", " )}. See the usage examples printed below.` ); ui.newLine(); yargsRunner.showHelp(); process.exit(1); } ui.newLine(); ui.error(invalidParamsMessage); process.exit(1); } this.loggerService.error({ err: error }, "CLI command execution failed."); const realError = (error.cause as Error) || error; ui.error(realError.message); // Unfortunately, yargs doesn't provide passed args here, so we had to do it via process.argv. ui.newLine(); ui.debug("Stack trace:"); ui.text(realError.stack || ""); process.exit(1); }); const commands = this.commandsRegistryService.execute(); for (const command of commands) { const { name, description, params = [], options = [], handler } = await command.execute(); let yargsCommand = name; if (params.length > 0) { yargsCommand += " " + params .map(param => { const paramName = param.array ? `${param.name}..` : param.name; return param.required ? `<${paramName}>` : `[${paramName}]`; }) .join(" "); } yargsRunner.command( yargsCommand, description, yargs => { params.forEach((param: Command.ParamDefinition) => { const { name, required, validation, array, ...rest } = param; const yargsParam = yargs.positional(name, { ...rest, ...(array && { array: true }), demandOption: required }); if (validation) { yargsParam.check(validation); } }); options.forEach((option: Command.OptionDefinition) => { const { name, required, validation, ...rest } = option; const yargsOption = yargs.option(name, { ...rest, demandOption: required }); if (option.group) { yargsOption.group(option.name, option.group); } if (validation) { yargsOption.check(validation); } }); }, handler ); } yargsRunner.help(true); this.yargsRunner = yargsRunner; return this.yargsRunner; } } export const getCliRunnerService = createImplementation({ abstraction: GetCliRunnerService, implementation: DefaultGetCliRunnerService, dependencies: [CommandsRegistryService, UiService, LoggerService] });