Skip to content

docs: document the flagsets.go/NewFlagSet wiring in the add-a-command recipes #79

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

Merged
andyrewlee merged 1 commit into from
Jun 15, 2026
Merged

docs: document the flagsets.go/NewFlagSet wiring in the add-a-command recipes #79

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
7 changes: 7 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,13 @@ e2e/ black-box tests driving the real binary as a subprocess
3. Add `cmd/frob.go` — a thin adapter that parses flags and calls
`mutate("frob", asJSON, func(env stack.Env, s *stack.State) (*stack.OpResult, error) { return stack.Frobnicate(env, s, arg) })`,
self-registering via `init()` → `register(&Command{...})`. Add a `--json` flag.
If `frob` parses any flag beyond `--json`, also add a `frobFlagSet()` constructor
to `cmd/flagsets.go` declaring those flags, set `NewFlagSet: frobFlagSet` in its
`register(&Command{...})`, and list `frob`'s flags in `TestCommandFlagsMatchExpected`
(`cmd/execute_test.go`). `Run` parses the flags either way; this wiring keeps
`st help --json` (and the declared-flags contract in `docs/AGENT.md`) reporting
exactly what `Run` accepts — skip it and `make ci` fails with "update flagsets.go
or this table".
4. If it has interesting CLI output, add a golden test (`cmd/golden_test.go`,
regenerate with `go test ./cmd -run Golden -update`).
5. `make ci`. Adding the command shifts the help golden — regenerate it deliberately.
Expand Down
6 changes: 5 additions & 1 deletion CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,11 @@ interface (JSON, exit codes).
the fake git (`mkBranch`). Microseconds, no real git.
3. **Adapter** — `cmd/frob.go`, a thin wrapper that self-registers and calls
`mutate("frob", asJSON, func(env stack.Env, s *stack.State) (*stack.OpResult, error) { return stack.Frobnicate(env, s, arg) })`.
Add a `--json` flag (see `docs/AGENT.md` — every command speaks JSON).
Add a `--json` flag (see `docs/AGENT.md` — every command speaks JSON). For any
flag beyond `--json`, also add a `frobFlagSet()` to `cmd/flagsets.go`, set
`NewFlagSet: frobFlagSet` in `register()`, and list `frob`'s flags in
`TestCommandFlagsMatchExpected` — this keeps `help --json` reporting exactly
what `Run` accepts (or `make ci` fails with "update flagsets.go or this table").
4. **Golden output** (optional) — `cmd/golden_test.go`; regenerate with
`go test ./cmd -run Golden -update`.
5. `make ci`. Adding a command shifts the `--help` golden — regenerate it
Expand Down
Loading