Skip to content

feat(cli): show help when no args are provided #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
warnaa wants to merge 1 commit into
base: master
Choose a base branch
from
Open

feat(cli): show help when no args are provided #2

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions src/index.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ cli.help();
cli.version(packageJson.version);

try {
if (process.argv.slice(2).length === 0) {
cli.outputHelp();
process.exit(0);
}

cli.parse();
} catch (err) {
// CAC throws on unknown options / bad usage. Exit code 2 = USAGE per plan.
Expand Down
11 changes: 11 additions & 0 deletions tests/e2e/global-flags.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,17 @@ describe("e2e: global flags", () => {
expect(output).toContain("doctor");
});

it("no args exits 0 with command list", () => {
const result = runCli([]);
expect(result.exitCode).toBe(0);
const output = result.stdout + result.stderr;
expect(output).toContain("10x");
expect(output).toContain("auth");
expect(output).toContain("get");
expect(output).toContain("list");
expect(output).toContain("doctor");
});

it("unknown option on a command exits 2 with usage error", () => {
const result = runCli(["auth", "--nonexistent-flag"]);
expect(result.exitCode).toBe(2);
Expand Down