mirror of
https://github.com/Tencent/WeKnora.git
synced 2026-11-01 20:52:50 +08:00
Code-reuse polish (post-implementation review pass): - Extract text.OneLine(maxWidth, s) helper combining preview-row normalization (newline/CR/tab → space) with text.Truncate's UTF-8-safe truncation. Replaces agent/view.go truncate1Line (ASCII '...' + byte-slice CJK-unsafe) and chunk/list.go singleLine. - Lift cmdutil.OpenInput(path) for the '-' = stdin / else os.Open pattern shared across agent create/edit and the api command. Replaces agent/create.go's private openInput. - Strip inline doc-spec parentheticals from source comments — those belong in commit messages and project docs, not in source where they rot. Pre-PR audit fixes: - doc upload: reject `--metadata` paired with `--from-url` as input.invalid_argument up-front (the URL-ingest request type has no metadata field server-side, so the pair would otherwise silently drop). Long help and CHANGELOG updated to call out the asymmetry. - doc upload (file path): map sdk.ErrDuplicateFile sentinel to resource.already_exists. The sentinel arrives with no "HTTP error <n>:" prefix because the SDK short-circuits on file-hash before reading the HTTP status, so the previous WrapHTTP fall-through misclassified it as network.error with a misleading "check base URL reachability" hint. The --from-url branch already handled ErrDuplicateURL this way; this closes the asymmetry. Caught by e2e re-upload of an already-ingested file; regression test added. - README exit-10 enumeration adds `agent delete` and `chunk delete` (these were missing alongside the v0.5 destructive verbs they were meant to gate). Docs sync: - cli/README.md: command tree now includes the chunk subtree; adds agent / chunk lines to the 5-minute quickstart; adds a "Contributing / Reporting issues" section pointing at the repo's SECURITY.md and AGENTS.md; drops third-party CLI parallels from the surface description. - cli/AGENTS.md: "Command surface design SOP" gains the flag-vs-escape-hatch step. "CRUD command flag canon" renamed to the hard-required-flags pattern with the contrast (TTY-prompts-fill) defined inline rather than via opaque shorthand. - cli/CHANGELOG.md: search docs case-sensitivity shift promoted to its own #### Breaking changes subsection. MCP doc_list filter count corrected from 5 to 6. Drops the bogus go.mod yaml.v3 entry (yaml.v3 was already a dependency on main; v0.5 added zero go.mod lines). Replaces internal-Go identifiers (fuzzyTime, NoOptDefVal) with user-language and drops the § section-symbol jargon.
83 lines
2.1 KiB
Go
83 lines
2.1 KiB
Go
package format
|
|
|
|
import (
|
|
"bytes"
|
|
"encoding/json"
|
|
"io"
|
|
)
|
|
|
|
// WriteJSON serializes v as one-line JSON to w. Bare-data contract: list
|
|
// commands emit their array directly, single-resource commands emit their
|
|
// object directly. The shape is whatever the producing command marshals.
|
|
func WriteJSON(w io.Writer, v any) error {
|
|
enc := json.NewEncoder(w)
|
|
enc.SetEscapeHTML(false)
|
|
return enc.Encode(v)
|
|
}
|
|
|
|
// WriteJSONFiltered serializes v to w with optional field restriction and
|
|
// optional jq evaluation.
|
|
//
|
|
// - len(fields) == 0 → no field filter
|
|
// - jqExpr == "" → no jq filter
|
|
//
|
|
// Field filter rules:
|
|
//
|
|
// - v marshals to a top-level array → each [*] object is restricted to
|
|
// the named keys
|
|
// - v marshals to a top-level object → the object is restricted to the
|
|
// named keys
|
|
// - v marshals to a scalar → unchanged
|
|
//
|
|
// Unknown field names are silently dropped so users can pass an aspirational
|
|
// field set across heterogenous list outputs.
|
|
func WriteJSONFiltered(w io.Writer, v any, fields []string, jqExpr string) error {
|
|
if len(fields) == 0 && jqExpr == "" {
|
|
return WriteJSON(w, v)
|
|
}
|
|
raw, err := marshalJSON(v)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if len(fields) > 0 {
|
|
raw, err = applyBareFieldFilter(raw, fields)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
if jqExpr != "" {
|
|
return writeJQ(w, raw, jqExpr)
|
|
}
|
|
_, err = w.Write(raw)
|
|
return err
|
|
}
|
|
|
|
// marshalJSON encodes v to a newline-terminated byte slice using the same
|
|
// encoder settings as WriteJSON (HTML escaping disabled).
|
|
func marshalJSON(v any) ([]byte, error) {
|
|
var buf bytes.Buffer
|
|
enc := json.NewEncoder(&buf)
|
|
enc.SetEscapeHTML(false)
|
|
if err := enc.Encode(v); err != nil {
|
|
return nil, err
|
|
}
|
|
return buf.Bytes(), nil
|
|
}
|
|
|
|
// applyBareFieldFilter dispatches on the JSON shape of raw and restricts
|
|
// elements / object keys to the named fields.
|
|
func applyBareFieldFilter(raw []byte, fields []string) ([]byte, error) {
|
|
trimmed := bytes.TrimSpace(raw)
|
|
if len(trimmed) == 0 {
|
|
return raw, nil
|
|
}
|
|
switch trimmed[0] {
|
|
case '[':
|
|
return filterArrayItems(raw, fields)
|
|
case '{':
|
|
return filterObjectKeys(raw, fields)
|
|
default:
|
|
return raw, nil
|
|
}
|
|
}
|