fix(#3019): query --help reaches handler instead of short-circuiting (#3026)

* fix(#3019): query --help reaches handler instead of short-circuiting to top-level usage

The query argv parser in sdk/src/cli.ts harvested -h/--help as a global
flag and main() short-circuited dispatch when args.help was true. Net
effect: every `gsd-sdk query <anything> --help` printed top-level USAGE
instead of contextual subcommand help. There was no path for users to
discover what arguments a query subcommand accepts — they had to trigger
"required" errors by trial and error.

Two-layer fix:

1. sdk/src/cli.ts (parseCliArgsQueryPermissive)
   - Push -h / --help onto queryArgv instead of consuming them silently,
     so the registered handler / gsd-tools.cjs fallback gets to interpret
     the flag and render contextual help.
   - Only honor the global help flag when there is NO real subcommand to
     dispatch to (i.e. queryArgv contains only help flags). Preserves
     `gsd-sdk query --help` → top-level USAGE while letting
     `gsd-sdk query phase add --help` reach the handler.

2. get-shit-done/bin/gsd-tools.cjs
   - Render top-level usage on --help / -h / -? / --usage instead of
     erroring with "Unknown flag". The discovery hint in the usage text
     points users at the working method (run without args → error names
     required arguments) and references #3019 for tracking subcommand-
     level help printers.
   - --version remains rejected (no discovery use-case).

#1818 anti-hallucination invariant preserved: the destructive command
NEVER executes when --help is present. The new shape returns success:true
+ usage on stdout instead of the old success:false + error on stderr —
both satisfy "destructive command did not run", and the new shape also
restores discoverability.

Tests:
- sdk/src/cli.test.ts: 4 new vitest cases covering #3019 — query argv
  parser keeps --help with subcommand, parses -h short flag, preserves
  bare `query --help` top-level behavior, preserves --help position when
  intermixed with other query flags.
- tests/bug-3019-help-passthrough.test.cjs: 5 node:test cases on the
  fallback — bare gsd-tools (no args) errors with usage; --help renders
  usage on stdout exit 0; -h same; subcommand --help renders usage; usage
  hint mentions discovery method (without prose substring matching —
  parses into typed sections).
- tests/bug-1818-unknown-flags.test.cjs: rewritten to assert the new
  invariant ("destructive command did not run" + "usage was rendered")
  instead of the old shape ("--help is rejected with non-zero exit").
  Each destructive test seeds a sentinel artifact (phase dir, slug
  output) and asserts it survives.

Verification:
- 47/47 vitest pass on sdk/src/cli.test.ts
- 5/5 pass on tests/bug-3019-help-passthrough.test.cjs
- 8/8 pass on tests/bug-1818-unknown-flags.test.cjs (rewritten)
- 6763/6763 pass on full node:test suite
- lint-no-source-grep clean (0 violations)

Closes #3019

* fix(#3019): SDK fallback forwards plain-text help, broader usage list (CR)

CodeRabbit on PR #3026 (4 findings — 1 Major outside-diff, 2 inline,
1 nitpick):

1. **Major outside-diff** — sdk/src/cli.ts:442-454. The fallback path
   that delegates to gsd-tools.cjs called parseCliQueryJsonOutput
   (JSON.parse) on stdout. Now that gsd-tools renders plain-text usage
   on --help, JSON.parse threw "Unexpected token 'U'". Wrapped the
   parse in try/catch — on parse failure, forward the plain stdout
   verbatim so subcommand help reaches the user. Regression test:
   tests/bug-3019-help-passthrough.test.cjs spawns the built SDK and
   asserts `gsd-sdk query phase --help` exits 0, stdout contains the
   gsd-tools usage, and stderr does NOT contain a JSON-parse error.

2. .changeset/help-passthrough.md:3 — `pr: TBD` → `pr: 3026`.

3. gsd-tools.cjs:346 (TOP_LEVEL_USAGE):
   - Removed self-referencing `#3019` link (immediately stale after
     this PR merges).
   - Expanded Commands list from 17 → all 47 dispatcher cases:
     agent-skills, audit-open, audit-uat, check-commit, commit, …
     phase, phases, roadmap, milestone, validate, progress, intel,
     graphify, learnings, etc. — the bulk of the surface that was
     previously unreachable via --help discovery.

4. Nitpick: `isUsageOutput` was duplicated in bug-1818 and
   bug-3019-help-passthrough tests. Moved to tests/helpers.cjs with
   structural-comment, removed both duplicates.

Verification: 47/47 vitest pass, 14/14 regression tests pass,
6764/6764 full suite, lint clean.

* test(#3019): use t.skip() instead of bare return when SDK not built (CR)

CodeRabbit follow-up on PR #3026:

The integration test guarded against missing sdk/dist/cli.js with a
bare `return;` — node:test counts that as a passing test (0 assertions
exercised, 0 failures). On a CI checkout that hasn't run the SDK build,
the #3026 regression test silently green-lit and no signal ever
surfaced that the integration check was skipped.

Switched to `t.skip(...)` via the test context parameter so the
omission shows up in the test report. The unit-level fix
(sdk/src/cli.ts) is still covered by vitest, so the skip only affects
the end-to-end spawn-built-SDK check.

Verification: 6/6 pass when SDK is built; 5 pass + 1 skip when not.
This commit is contained in:
Tom Boucher
2026-05-02 11:45:33 -04:00
committed by GitHub
parent 8e25eb6546
commit e3b64b39f8
7 changed files with 316 additions and 41 deletions

View File

@@ -85,8 +85,17 @@ function parseCliArgsQueryPermissive(argv: string[]): ParsedCliArgs {
i += 2;
continue;
}
// #3019: do NOT consume -h / --help here unconditionally. Pushing the
// flag onto queryArgv lets the registered handler (or the gsd-tools.cjs
// fallback) render contextual subcommand help. We still set the global
// `help` flag when the flag appears, but only short-circuit dispatch in
// main() when there is no real subcommand to dispatch to (i.e. the only
// tokens in queryArgv are the help flags themselves). That preserves
// `gsd-sdk query --help` → top-level USAGE while letting
// `gsd-sdk query phase add --help` reach the handler.
if (a === '-h' || a === '--help') {
help = true;
queryArgv.push(a);
i += 1;
continue;
}
@@ -99,6 +108,14 @@ function parseCliArgsQueryPermissive(argv: string[]): ParsedCliArgs {
i += 1;
}
// If the user typed a real subcommand (anything other than help flags
// alone in queryArgv), do NOT short-circuit to top-level USAGE on help.
// The handler/fallback will render contextual help.
const nonHelpTokens = queryArgv.filter((t) => t !== '-h' && t !== '--help');
if (help && nonHelpTokens.length > 0) {
help = false;
}
return {
command: 'query',
prompt: undefined,
@@ -430,7 +447,22 @@ export async function main(argv: string[] = process.argv.slice(2)): Promise<void
args.ws,
);
if (stderr.trim()) console.error(stderr.trimEnd());
let output: unknown = await parseCliQueryJsonOutput(stdout, args.projectDir);
// #3026 CR (Major outside-diff): the gsd-tools.cjs fallback now
// emits plain-text usage on --help / -h with exit 0, instead of
// a JSON object. Wrap the JSON parse in a try/catch and forward
// non-JSON stdout verbatim so subcommand help reaches the user.
// (Previously this path JSON.parsed the help text and threw
// "Unexpected token 'U'" — exitCode=1 — a regression introduced
// alongside the --help passthrough fix.)
let output: unknown;
try {
output = await parseCliQueryJsonOutput(stdout, args.projectDir);
} catch {
if (stdout.trim()) {
process.stdout.write(stdout.endsWith('\n') ? stdout : stdout + '\n');
}
return;
}
if (pickField) {
output = extractField(output, pickField);
}