mirror of
https://github.com/openclaw/openclaw.git
synced 2026-05-20 09:44:45 +00:00
fix(cli): explain parser errors
This commit is contained in:
95
src/cli/program/error-output.ts
Normal file
95
src/cli/program/error-output.ts
Normal file
@@ -0,0 +1,95 @@
|
||||
import { formatDocsLink } from "../../terminal/links.js";
|
||||
import { theme } from "../../terminal/theme.js";
|
||||
import { getCommandPathWithRootOptions } from "../argv.js";
|
||||
import { formatCliCommand } from "../command-format.js";
|
||||
|
||||
type FormatCliParseErrorOptions = {
|
||||
argv?: string[];
|
||||
};
|
||||
|
||||
function stripCommanderErrorPrefix(raw: string): string {
|
||||
return raw
|
||||
.trim()
|
||||
.replace(/^error:\s*/i, "")
|
||||
.trim();
|
||||
}
|
||||
|
||||
function quote(value: string): string {
|
||||
return `"${value}"`;
|
||||
}
|
||||
|
||||
function resolveHelpCommand(argv: string[] | undefined, options?: { root?: boolean }): string {
|
||||
if (options?.root || !argv) {
|
||||
return formatCliCommand("openclaw --help");
|
||||
}
|
||||
const commandPath = getCommandPathWithRootOptions(argv, 2);
|
||||
if (commandPath.length === 0) {
|
||||
return formatCliCommand("openclaw --help");
|
||||
}
|
||||
return formatCliCommand(`openclaw ${commandPath.join(" ")} --help`);
|
||||
}
|
||||
|
||||
function lines(...items: Array<string | undefined>): string {
|
||||
return `${items.filter((item): item is string => Boolean(item)).join("\n")}\n`;
|
||||
}
|
||||
|
||||
function formatHelpHint(argv: string[] | undefined, options?: { root?: boolean }): string {
|
||||
return `${theme.muted("Try:")} ${theme.command(resolveHelpCommand(argv, options))}`;
|
||||
}
|
||||
|
||||
function formatDocsHint(): string {
|
||||
return `${theme.muted("Docs:")} ${formatDocsLink("/cli", "docs.openclaw.ai/cli")}`;
|
||||
}
|
||||
|
||||
export function formatCliParseErrorOutput(
|
||||
raw: string,
|
||||
options: FormatCliParseErrorOptions = {},
|
||||
): string {
|
||||
const message = stripCommanderErrorPrefix(raw);
|
||||
const unknownCommand = message.match(/^unknown command ['"`](.+?)['"`]/i);
|
||||
if (unknownCommand) {
|
||||
const command = unknownCommand[1] ?? "";
|
||||
return lines(
|
||||
theme.error(`OpenClaw does not know the command ${quote(command)}.`),
|
||||
formatHelpHint(options.argv, { root: true }),
|
||||
`${theme.muted("Plugin command?")} ${theme.command(formatCliCommand("openclaw plugins list"))}`,
|
||||
formatDocsHint(),
|
||||
);
|
||||
}
|
||||
|
||||
const unknownOption = message.match(/^unknown option ['"`](.+?)['"`]/i);
|
||||
if (unknownOption) {
|
||||
const option = unknownOption[1] ?? "";
|
||||
return lines(
|
||||
theme.error(`OpenClaw does not recognize option ${quote(option)}.`),
|
||||
formatHelpHint(options.argv),
|
||||
);
|
||||
}
|
||||
|
||||
const missingArgument = message.match(/^missing required argument ['"`](.+?)['"`]/i);
|
||||
if (missingArgument) {
|
||||
const argument = missingArgument[1] ?? "";
|
||||
return lines(
|
||||
theme.error(`Missing required argument ${quote(argument)}.`),
|
||||
formatHelpHint(options.argv),
|
||||
);
|
||||
}
|
||||
|
||||
const missingOption = message.match(/^required option ['"`](.+?)['"`] not specified/i);
|
||||
if (missingOption) {
|
||||
const option = missingOption[1] ?? "";
|
||||
return lines(
|
||||
theme.error(`Missing required option ${quote(option)}.`),
|
||||
formatHelpHint(options.argv),
|
||||
);
|
||||
}
|
||||
|
||||
if (/^too many arguments\b/i.test(message)) {
|
||||
return lines(theme.error("Too many arguments for this command."), formatHelpHint(options.argv));
|
||||
}
|
||||
|
||||
return lines(
|
||||
theme.error(`OpenClaw could not parse this command: ${message}`),
|
||||
formatHelpHint(options.argv),
|
||||
);
|
||||
}
|
||||
Reference in New Issue
Block a user