refactor(cli): drop --dry-run + introduce bare-JSON output path
Two intertwined mainstream-alignment moves bundled because they share
the migration target (every command's --json path):
1. Drop --dry-run entirely. Survey of comparable API-wrapper CLIs
(gh, aws, stripe, lark): none expose --dry-run. The mainstream that
does (kubectl/git/helm/ansible) operates on declarative manifests
or local state where the preview is materially different from the
executed action. WeKnora's CLI just echoed the same parameters
that would have gone on the wire — the preview added no real
signal over `--help` + reading the call site. Removes:
- root --dry-run persistent flag + cmdutil/dryrun.go
- DryRun fields + EmitDryRun calls in 12 write commands
- format.Envelope.DryRun field
- 8 corresponding *_test.go cases
- --dry-run mention from README.md and CHANGELOG.md
- "dry_run":false from 16 golden envelopes
2. Migrate every --json output to bare data:
- New format.WriteJSON / WriteJSONFiltered helpers
(cli/internal/format/bare.go) share filterArrayItems /
filterObjectKeys / writeJQ with the (still-live for now) envelope
filter helpers.
- Read commands (kb/doc/session list+view, search chunks/docs/
sessions/kb, auth list/status, agent list/view, context list,
doctor) emit bare arrays / objects on stdout.
- Write commands (kb create/edit/delete/pin/empty, doc upload/
upload_recursive/delete, session delete, auth login/logout/
refresh/token, link/unlink, context add/use/remove, agent
invoke, chat, api, version) emit bare result objects. Risk
classification dropped — the resource + exit code already
convey the action.
Per-command shape changes:
list / search → []T (was {ok, data:{items:[…]}})
view → T (was {ok, data:T, _meta:…})
create / edit → T
delete / pin / etc. → {id, …action result…}
doctor → {summary, checks}
api → {status, headers, body}
_meta dropped on the read path:
pagination (page/page_size/total/has_more) — agents iterate with
--all-pages or accept --limit (gh CLI parity);
kb_id / context echo — caller already knows what it asked for.
Acceptance contract goldens regenerated for the new bare shape.
Error envelope on stdout (PrintErrorEnvelope) stays live for now —
the envelope-infra deletion lands in the next commit.
This commit is contained in:
@@ -1,43 +0,0 @@
|
||||
package cmdutil
|
||||
|
||||
import (
|
||||
"fmt"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
|
||||
"github.com/Tencent/WeKnora/cli/internal/format"
|
||||
"github.com/Tencent/WeKnora/cli/internal/iostreams"
|
||||
)
|
||||
|
||||
// IsDryRun reports whether the global --dry-run flag was set on cmd or any
|
||||
// of its parents. Write commands check this and skip the SDK call, returning
|
||||
// an envelope with dry_run=true that describes the action that would have
|
||||
// run. Read commands ignore --dry-run (no side effect to preview).
|
||||
func IsDryRun(cmd *cobra.Command) bool {
|
||||
if cmd == nil {
|
||||
return false
|
||||
}
|
||||
v, _ := cmd.Flags().GetBool("dry-run")
|
||||
return v
|
||||
}
|
||||
|
||||
// EmitDryRun writes the canonical preview envelope for a write command. JSON
|
||||
// mode emits SuccessWithRisk + DryRun=true; human mode prints the
|
||||
// `[dry-run] would <risk.Action>` line to stdout, with " (high-risk)"
|
||||
// appended automatically when risk.Level == RiskHighRiskWrite. Centralized
|
||||
// so wire shape stays identical across kb create/delete, doc upload/delete,
|
||||
// api, and any future write command.
|
||||
func EmitDryRun(jsonOut bool, data any, meta *format.Meta, risk *format.Risk) error {
|
||||
out := iostreams.IO.Out
|
||||
if jsonOut {
|
||||
env := format.SuccessWithRisk(data, meta, risk)
|
||||
env.DryRun = true
|
||||
return format.WriteEnvelope(out, env)
|
||||
}
|
||||
line := risk.Action
|
||||
if risk.Level == format.RiskHighRiskWrite {
|
||||
line += " (high-risk)"
|
||||
}
|
||||
_, err := fmt.Fprintf(out, "[dry-run] would %s\n", line)
|
||||
return err
|
||||
}
|
||||
Reference in New Issue
Block a user