chore(cli): polish + docs sync + pre-PR audit fixes

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.
This commit is contained in:
nullkey
2026-05-16 02:42:18 +08:00
committed by lyingbug
parent f89d54362d
commit c87e35b34b
35 changed files with 339 additions and 182 deletions
+12 -12
View File
@@ -13,7 +13,7 @@ import (
func TestLoadConfigFile_YAML(t *testing.T) {
yaml := strings.NewReader(`
agent_mode: smart-reasoning
model_id: gpt-4
model_id: model-x
temperature: 0.7
knowledge_bases:
- kb_abc
@@ -22,17 +22,17 @@ knowledge_bases:
cfg, err := LoadAgentConfig(yaml, "yaml")
require.NoError(t, err)
assert.Equal(t, "smart-reasoning", cfg.AgentMode)
assert.Equal(t, "gpt-4", cfg.ModelID)
assert.Equal(t, "model-x", cfg.ModelID)
assert.InDelta(t, 0.7, cfg.Temperature, 0.001)
assert.Equal(t, []string{"kb_abc", "kb_def"}, cfg.KnowledgeBases)
}
func TestLoadConfigFile_JSON(t *testing.T) {
js := strings.NewReader(`{"agent_mode":"quick-answer","model_id":"gpt-3.5"}`)
js := strings.NewReader(`{"agent_mode":"quick-answer","model_id":"model-y"}`)
cfg, err := LoadAgentConfig(js, "json")
require.NoError(t, err)
assert.Equal(t, "quick-answer", cfg.AgentMode)
assert.Equal(t, "gpt-3.5", cfg.ModelID)
assert.Equal(t, "model-y", cfg.ModelID)
}
func TestLoadConfigFile_UnknownKind(t *testing.T) {
@@ -52,17 +52,17 @@ func TestLoadConfigFile_BadJSON(t *testing.T) {
}
func TestMergeAgentConfig_FlagsOverrideFile(t *testing.T) {
base := &sdk.AgentConfig{ModelID: "gpt-3.5"}
overrides := AgentConfigFlags{ModelIDSet: true, ModelID: "gpt-4"}
base := &sdk.AgentConfig{ModelID: "model-y"}
overrides := AgentConfigFlags{ModelIDSet: true, ModelID: "model-x"}
merged := MergeAgentConfig(base, overrides)
assert.Equal(t, "gpt-4", merged.ModelID)
assert.Equal(t, "model-x", merged.ModelID)
}
func TestMergeAgentConfig_UnsetFlagsPreserveBase(t *testing.T) {
base := &sdk.AgentConfig{ModelID: "gpt-3.5", Temperature: 0.5}
base := &sdk.AgentConfig{ModelID: "model-y", Temperature: 0.5}
overrides := AgentConfigFlags{} // nothing set
merged := MergeAgentConfig(base, overrides)
assert.Equal(t, "gpt-3.5", merged.ModelID)
assert.Equal(t, "model-y", merged.ModelID)
assert.InDelta(t, 0.5, merged.Temperature, 0.001)
}
@@ -70,7 +70,7 @@ func TestMergeAgentConfig_EveryFieldOverlay(t *testing.T) {
base := &sdk.AgentConfig{
AgentMode: "quick-answer",
SystemPrompt: "old",
ModelID: "gpt-3.5",
ModelID: "model-y",
RerankModelID: "rerank-old",
Temperature: 0.1,
KBSelectionMode: "all",
@@ -79,7 +79,7 @@ func TestMergeAgentConfig_EveryFieldOverlay(t *testing.T) {
overrides := AgentConfigFlags{
AgentMode: "smart-reasoning", AgentModeSet: true,
SystemPrompt: "new", SystemPromptSet: true,
ModelID: "gpt-4", ModelIDSet: true,
ModelID: "model-x", ModelIDSet: true,
RerankModelID: "rerank-new", RerankModelIDSet: true,
Temperature: 0.9, TemperatureSet: true,
KBSelectionMode: "selected", KBSelectionModeSet: true,
@@ -88,7 +88,7 @@ func TestMergeAgentConfig_EveryFieldOverlay(t *testing.T) {
merged := MergeAgentConfig(base, overrides)
assert.Equal(t, "smart-reasoning", merged.AgentMode)
assert.Equal(t, "new", merged.SystemPrompt)
assert.Equal(t, "gpt-4", merged.ModelID)
assert.Equal(t, "model-x", merged.ModelID)
assert.Equal(t, "rerank-new", merged.RerankModelID)
assert.InDelta(t, 0.9, merged.Temperature, 0.001)
assert.Equal(t, "selected", merged.KBSelectionMode)
+20
View File
@@ -0,0 +1,20 @@
package cmdutil
import (
"io"
"os"
"github.com/Tencent/WeKnora/cli/internal/iostreams"
)
// OpenInput returns a reader for path. If path == "-", returns stdin
// (iostreams.IO.In). Otherwise opens the file. Caller is responsible
// for closing if needed — for typical "-input <file>"/"--input -" CLI
// patterns the file is fully read before the command exits and OS
// reclaims the FD, so closing is cosmetic.
func OpenInput(path string) (io.Reader, error) {
if path == "-" {
return iostreams.IO.In, nil
}
return os.Open(path)
}
+2 -3
View File
@@ -53,9 +53,8 @@ func TestAddJSONFlags_BareYieldsEnabledOptsWithNoFields(t *testing.T) {
func TestAddJSONFlags_FieldsFlagParsing(t *testing.T) {
// NoOptDefVal sentinel means the `=` form is required for value passing.
// Space form `--json id,name` parses as bare + positional, which is a
// documented divergence from gh CLI: weknora keeps bare `--json` as a
// shortcut for "full payload".
// Space form `--json id,name` parses as bare + positional; bare `--json`
// (no value) is reserved as a shortcut for the unfiltered payload.
cases := []struct {
args []string
want []string
+1 -1
View File
@@ -21,7 +21,7 @@ func WriteJSON(w io.Writer, v any) error {
// - len(fields) == 0 → no field filter
// - jqExpr == "" → no jq filter
//
// Field filter rules (mirrors gh CLI's `--json field,field` semantics):
// Field filter rules:
//
// - v marshals to a top-level array → each [*] object is restricted to
// the named keys
+2 -1
View File
@@ -105,7 +105,8 @@ func TestWriteJSONFiltered_JQOnly(t *testing.T) {
if err := format.WriteJSONFiltered(buf, items, nil, ".[].id"); err != nil {
t.Fatalf("err = %v", err)
}
// gh CLI parity: string results render without JSON quotes.
// String / scalar results render without JSON quotes so scalar
// projections (e.g. `--jq '.[].id'`) pipe cleanly into shell tools.
lines := strings.Split(strings.TrimRight(buf.String(), "\n"), "\n")
if len(lines) != 2 || lines[0] != "1" || lines[1] != "2" {
t.Errorf("jq output mismatch: %q", buf.String())
+1 -1
View File
@@ -451,7 +451,7 @@ func addAgentInvoke(server *mcpsdk.Server, svc agentInvokeService) {
Channel: "api",
}
// Auto-create session if not supplied. Sessions are agent-
// agnostic at creation (Q3 - verified against server source).
// agnostic at creation (verified against server source).
sessionID := in.SessionID
if sessionID == "" {
sess, err := svc.CreateSession(ctx, &sdk.CreateSessionRequest{Title: "weknora mcp agent_invoke"})
+2 -2
View File
@@ -23,8 +23,8 @@ import (
// Demuxes by ResponseType so the answer string is not polluted by thinking
// or reflection fragments - the model layer (internal/models/chat/
// remote_api.go) emits ResponseTypeThinking events whenever the upstream
// LLM produces reasoning_content (GPT-5 / Claude extended thinking), and
// without demux those would be silently concatenated into Result().
// LLM produces reasoning_content frames, and without demux those would
// be silently concatenated into Result().
type Accumulator struct {
answer strings.Builder
thinking strings.Builder
+13
View File
@@ -0,0 +1,13 @@
package text
import "strings"
// OneLine collapses newlines/carriage-returns/tabs in s to single spaces,
// then truncates to maxDisplayWidth columns (UTF-8 safe via Truncate).
// Use for human-readable preview rows where multiline content would
// break tabular layout.
func OneLine(maxDisplayWidth int, s string) string {
return Truncate(maxDisplayWidth, lineReplacer.Replace(s))
}
var lineReplacer = strings.NewReplacer("\n", " ", "\r", " ", "\t", " ")
+29
View File
@@ -0,0 +1,29 @@
package text_test
import (
"testing"
"github.com/Tencent/WeKnora/cli/internal/text"
)
func TestOneLine(t *testing.T) {
cases := []struct {
name string
max int
in, want string
}{
{"empty", 10, "", ""},
{"no-collapse", 10, "hello", "hello"},
{"collapse-newline", 20, "hello\nworld", "hello world"},
{"collapse-cr-tab", 20, "hello\r\tworld", "hello world"},
{"truncate", 8, "hello world long", "hello w…"},
{"truncate-after-collapse", 8, "hello\nworld\nlong", "hello w…"},
}
for _, c := range cases {
t.Run(c.name, func(t *testing.T) {
if got := text.OneLine(c.max, c.in); got != c.want {
t.Errorf("OneLine(%d, %q) = %q, want %q", c.max, c.in, got, c.want)
}
})
}
}