fix(cli): set non-zero exit code on argument errors (#60923)

Merged via squash.

Prepared head SHA: 0de0c43111
Co-authored-by: Linux2010 <35169750+Linux2010@users.noreply.github.com>
Co-authored-by: altaywtf <9790196+altaywtf@users.noreply.github.com>
Reviewed-by: @altaywtf
This commit is contained in:
Andy Tien
2026-04-05 08:17:51 +08:00
committed by GitHub
parent f299bb812b
commit dca21563c6
5 changed files with 134 additions and 3 deletions

View File

@@ -1,6 +1,6 @@
import process from "node:process";
import { Command } from "commander";
import { beforeEach, describe, expect, it, vi } from "vitest";
import { Command, CommanderError } from "commander";
import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
import { buildProgram } from "./build-program.js";
import type { ProgramContext } from "./context.js";
@@ -31,8 +31,26 @@ vi.mock("./program-context.js", () => ({
}));
describe("buildProgram", () => {
function mockProcessOutput() {
vi.spyOn(process.stdout, "write").mockImplementation(
((() => true) as unknown) as typeof process.stdout.write,
);
vi.spyOn(process.stderr, "write").mockImplementation(
((() => true) as unknown) as typeof process.stderr.write,
);
}
async function expectCommanderExit(promise: Promise<unknown>, exitCode: number) {
const error = await promise.catch((err) => err);
expect(error).toBeInstanceOf(CommanderError);
expect(error).toMatchObject({ exitCode });
return error as CommanderError;
}
beforeEach(() => {
vi.clearAllMocks();
mockProcessOutput();
createProgramContextMock.mockReturnValue({
programVersion: "9.9.9-test",
channelOptions: ["telegram"],
@@ -41,6 +59,11 @@ describe("buildProgram", () => {
} satisfies ProgramContext);
});
afterEach(() => {
process.exitCode = undefined;
vi.restoreAllMocks();
});
it("wires context/help/preaction/command registration with shared context", () => {
const argv = ["node", "openclaw", "status"];
const originalArgv = process.argv;
@@ -58,4 +81,60 @@ describe("buildProgram", () => {
process.argv = originalArgv;
}
});
it("sets exitCode to 1 on argument errors (fixes #60905)", async () => {
const program = buildProgram();
program.command("test").description("Test command");
const error = await expectCommanderExit(
program.parseAsync(["test", "unexpected-arg"], { from: "user" }),
1,
);
expect(error.code).toBe("commander.excessArguments");
expect(process.exitCode).toBe(1);
});
it("does not run the command action after an argument error", async () => {
const program = buildProgram();
const actionSpy = vi.fn();
program.command("test").action(actionSpy);
await expectCommanderExit(program.parseAsync(["test", "unexpected-arg"], { from: "user" }), 1);
expect(actionSpy).not.toHaveBeenCalled();
});
it("preserves exitCode 0 for help display", async () => {
const program = buildProgram();
program.command("test").description("Test command");
const error = await expectCommanderExit(program.parseAsync(["--help"], { from: "user" }), 0);
expect(error.code).toBe("commander.helpDisplayed");
expect(process.exitCode).toBe(0);
});
it("preserves exitCode 0 for version display", async () => {
const program = buildProgram();
program.version("1.0.0");
const error = await expectCommanderExit(program.parseAsync(["--version"], { from: "user" }), 0);
expect(error.code).toBe("commander.version");
expect(process.exitCode).toBe(0);
});
it("preserves non-zero exitCode for help error flows", async () => {
const program = buildProgram();
program.helpCommand("help [command]");
const error = await expectCommanderExit(
program.parseAsync(["help", "missing"], { from: "user" }),
1,
);
expect(error.code).toBe("commander.help");
expect(process.exitCode).toBe(1);
});
});