nullkey
bdc589e1c0
Cross-cutting cleanup that lands alongside the new feature surface: - `--limit / -L` and `--all-pages` on every list command. Default --limit 30 (gh-parity); --all-pages drains every server page client-side, capped by --limit. Closes the audit finding that the old "1000 max per call" implicit cap was undiscoverable. - `auth token` emits a TTY-only stderr advisory when stdout is a terminal (the credential just got displayed in scrollback) plus an api-key-mode rotation hint. - Comment + doc discipline pass: drop external project name references from in-code comments (we reference them in design notes, not inline). - Bump `go` directive to 1.26.0 and CI matrix to 1.26.x to align with the main module's go.mod. - Rename `cli/internal/agent` → `cli/internal/aiclient` to disambiguate from the new `cli/cmd/agent` resource subtree. The package handles AI coding-agent env detection + per-command --help annotations; the new name reflects that more precisely.
109 lines
3.8 KiB
Go
109 lines
3.8 KiB
Go
package cmdutil
|
|
|
|
import (
|
|
"errors"
|
|
"sort"
|
|
"strings"
|
|
|
|
"github.com/spf13/cobra"
|
|
"github.com/spf13/pflag"
|
|
)
|
|
|
|
// JSONOptions captures the resolved --json + --jq state after CheckJSONFlags.
|
|
// A non-nil value means the user requested JSON output; Fields restricts
|
|
// data.items[*] when len(Fields) > 0; JQ is a jq expression applied to the
|
|
// final envelope JSON.
|
|
type JSONOptions struct {
|
|
Fields []string
|
|
JQ string
|
|
}
|
|
|
|
// Enabled reports whether the caller asked for JSON output. Convenience
|
|
// shorthand for `opts != nil`.
|
|
func (o *JSONOptions) Enabled() bool { return o != nil }
|
|
|
|
// jsonNoOptSentinel marks a bare `--json` (no comma-separated values
|
|
// after it). pflag's NoOptDefVal mechanism stores this sentinel into the
|
|
// slice; CheckJSONFlags then maps it to "no field filter" (full envelope).
|
|
//
|
|
// Rationale: WeKnora's envelope is itself the machine-readable contract
|
|
// (carries typed error.code / _meta / risk), so a bare `--json` always
|
|
// producing the full envelope keeps the standard `weknora kb list --json |
|
|
// jq` pattern working. Field discovery moves to per-command `--help`
|
|
// "JSON fields available" sections rendered by AddJSONFlags.
|
|
const jsonNoOptSentinel = "\x00json-no-value"
|
|
|
|
// AddJSONFlags registers --json and --jq on cmd.
|
|
//
|
|
// - `--json` → full envelope (no field filter)
|
|
// - `--json id,name` → envelope with data.items[*] / data restricted
|
|
// to listed fields
|
|
// - `--jq <expr>` → applies a jq expression after marshaling;
|
|
// requires --json to be set explicitly
|
|
//
|
|
// `fields` is the set of available fields the user may pass; rendered in
|
|
// the command's help. Pass nil to skip the help annotation (uncommon).
|
|
func AddJSONFlags(cmd *cobra.Command, fields []string) {
|
|
f := cmd.Flags()
|
|
// Backticks reserved for pflag's UnquoteUsage to extract the varname;
|
|
// avoid them in the description so the help doesn't render the flag
|
|
// name twice.
|
|
f.StringSlice("json", nil, "Output JSON envelope (bare for full; --json=id,name for `fields`)")
|
|
f.Lookup("json").NoOptDefVal = jsonNoOptSentinel
|
|
f.StringP("jq", "q", "", "Filter JSON output using a jq `expression` (requires --json)")
|
|
|
|
if len(fields) > 0 {
|
|
sorted := append([]string(nil), fields...)
|
|
sort.Strings(sorted)
|
|
// Append to Long without overwriting per-command prose.
|
|
hdr := "\n\nJSON fields available via `--json id,name,...`:\n " +
|
|
strings.Join(sorted, "\n ")
|
|
if cmd.Long != "" {
|
|
cmd.Long += hdr
|
|
} else {
|
|
cmd.Long = strings.TrimSpace(cmd.Short) + hdr
|
|
}
|
|
}
|
|
}
|
|
|
|
// CheckJSONFlags resolves the --json + --jq state from cmd. Returns:
|
|
// - (nil, nil) neither flag set (human output mode)
|
|
// - (*JSONOptions, nil) --json set (possibly with --jq)
|
|
// - (nil, error) --jq without --json (plain error, exit 1)
|
|
//
|
|
// Bare `--json` yields Fields == nil (full envelope). Explicit field list
|
|
// yields Fields == []string{"id", "name", ...} (filter applied).
|
|
func CheckJSONFlags(cmd *cobra.Command) (*JSONOptions, error) {
|
|
f := cmd.Flags()
|
|
jsonFlag := f.Lookup("json")
|
|
jqFlag := f.Lookup("jq")
|
|
if jsonFlag == nil {
|
|
return nil, nil
|
|
}
|
|
if jsonFlag.Changed {
|
|
sv, ok := jsonFlag.Value.(pflag.SliceValue)
|
|
if !ok {
|
|
return nil, errors.New("internal: --json flag is not a StringSlice")
|
|
}
|
|
raw := sv.GetSlice()
|
|
opts := &JSONOptions{}
|
|
// Strip the bare-flag sentinel if present.
|
|
for _, v := range raw {
|
|
if v == jsonNoOptSentinel {
|
|
continue
|
|
}
|
|
opts.Fields = append(opts.Fields, v)
|
|
}
|
|
if jqFlag != nil {
|
|
opts.JQ = jqFlag.Value.String()
|
|
}
|
|
return opts, nil
|
|
}
|
|
if jqFlag != nil && jqFlag.Changed {
|
|
// Plain error, exit 1 (not FlagError → exit 2): the flag itself
|
|
// parsed fine, the combination is what's wrong.
|
|
return nil, errors.New("cannot use `--jq` without specifying `--json`")
|
|
}
|
|
return nil, nil
|
|
}
|