chore(cli): remove unused v0.0 scaffolding
Foundation PR-1 reserved several internal packages and helpers as
scaffolding for follow-up PRs that ended up taking different routes.
Audit confirms zero production references; this commit removes them so
the cli/ tree reflects what's actually shipped.
Removed (148 LOC):
cli/internal/safepaths/ — `Validate` / `WithinRoot` /
three sentinel errors. Reserved
for `weknora doc upload`'s path
scrubbing; that command landed
in PR-10 using its own
`validateUploadPath` (os.Stat +
regular-file check) — sufficient
for the actual threat model
(local CLI invocations).
cli/internal/cmdutil/json_flags.go — `AddJSONFlags` helper +
unused --jq / --template flag
registration. Reserved for PR-3
"lipgloss tables / jq evaluator"
which never materialized; every
command directly registers
BoolVar(&JSONOut, "json", ...)
since v0.0 ship time.
cmdutil.NewTableExporter — empty alias for jsonExporter,
reserved for the same PR-3
renderer. Removed; jsonExporter
stays under NewJSONExporter.
cmdutil.Options marker interface — empty interface{} reserved as a
convention; no command embeds
or asserts against it.
Stale comments fixed:
- cmd/root.go: package comment updated kb (list+get) → kb
(list+view+create+delete) and noted the `get` cobra alias.
- cmd/root.go: dropped --no-version-check forward-reference (no such flag).
- cmd/root.go: removed "(PR-7)" attribution from NewRootCmd doc comment.
- cmd/kb/kb.go: same package-comment update.
- cmd/chat/chat.go: replaced "PR-7" mention in --help example with a
generic placeholder so cobra-rendered help is review-clean.
- cmd/search/search.go: removed "Lipgloss tables arrive in PR-3"
forward-reference; the inline indent helper is the shipped form.
- internal/agent/annotations.go: ShouldUseAgentMode → DetectAIAgent
(removed in PR-12).
AGENTS.md "Known limitations" section added:
Documents that chat / search / doc upload currently surface server-side
precondition misses (LLM / vector store / storage engine not configured)
as `network.error` with `context deadline exceeded`. A planned future
release will introduce a `precondition.*` typed error namespace
(server returns HTTP 412 before opening the SSE / streaming response).
This documents the limitation honestly for reviewers and integrators
rather than claiming a behavior we don't yet have.
Tests: 27 cli packages pass (safepaths_test was the 28th — gone with the
package). go vet clean.
This commit is contained in:
@@ -6,9 +6,10 @@ import (
|
||||
"github.com/Tencent/WeKnora/cli/internal/format"
|
||||
)
|
||||
|
||||
// Exporter renders command output. Foundation PR ships a single
|
||||
// jsonExporter that writes the envelope; PR-3 lands lipgloss tables, jq,
|
||||
// and templates as additional implementations.
|
||||
// Exporter renders an envelope to a writer. Currently the only
|
||||
// implementation is the JSON exporter; the interface stays in case a future
|
||||
// renderer (templated text, table) needs to plug in without changing call
|
||||
// sites that already write through Exporter.Write.
|
||||
type Exporter interface {
|
||||
Write(w io.Writer, env format.Envelope) error
|
||||
}
|
||||
@@ -22,9 +23,3 @@ type jsonExporter struct{}
|
||||
func (jsonExporter) Write(w io.Writer, env format.Envelope) error {
|
||||
return format.WriteEnvelope(w, env)
|
||||
}
|
||||
|
||||
// NewTableExporter is a foundation-PR alias for the JSON exporter; PR-3
|
||||
// replaces it with a lipgloss-based renderer that respects iostreams.IO
|
||||
// ColorEnabled. Until then table output looks identical to JSON output so
|
||||
// commands work end-to-end either way.
|
||||
func NewTableExporter(_ []string) Exporter { return &jsonExporter{} }
|
||||
|
||||
@@ -20,12 +20,6 @@ func TestJSONExporter_WritesEnvelope(t *testing.T) {
|
||||
assert.Equal(t, true, got["ok"])
|
||||
}
|
||||
|
||||
func TestTableExporter_PR1AliasesJSON(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
require.NoError(t, NewTableExporter([]string{"id"}).Write(&buf, format.Success("x", nil)))
|
||||
assert.Contains(t, buf.String(), `"ok":true`)
|
||||
}
|
||||
|
||||
func TestFlagError_IsSentinel(t *testing.T) {
|
||||
err := NewFlagError(assert.AnError)
|
||||
_, ok := err.(*FlagError)
|
||||
|
||||
@@ -1,28 +0,0 @@
|
||||
package cmdutil
|
||||
|
||||
import (
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// AddJSONFlags registers the standard output triplet on cmd:
|
||||
//
|
||||
// --json [fields] JSON envelope output, optional field-projection list
|
||||
// --jq <expr> embedded jq filter (PR-3 wires the real evaluator)
|
||||
// --template <tmpl> Go text/template (PR-3)
|
||||
//
|
||||
// The three flags are mutually exclusive at evaluation time; PR-3 enforces it.
|
||||
// `fields` is the list of valid field names that --json [fields] may project
|
||||
// against; commands pass their resource's field set (kb / doc / chunk / ...).
|
||||
//
|
||||
// *exporter is initialized to a JSON exporter; PR-3 swaps in jq/template
|
||||
// variants based on which flag the user supplied.
|
||||
func AddJSONFlags(cmd *cobra.Command, exporter *Exporter, fields []string) {
|
||||
_ = fields // PR-3 uses this for --json field-list completion + validation
|
||||
var jsonOut bool
|
||||
var jqExpr string
|
||||
var tmpl string
|
||||
cmd.Flags().BoolVar(&jsonOut, "json", false, "Output JSON envelope")
|
||||
cmd.Flags().StringVar(&jqExpr, "jq", "", "Filter output via embedded jq expression")
|
||||
cmd.Flags().StringVar(&tmpl, "template", "", "Format output via Go text/template")
|
||||
*exporter = NewJSONExporter()
|
||||
}
|
||||
@@ -1,18 +0,0 @@
|
||||
package cmdutil
|
||||
|
||||
import (
|
||||
"testing"
|
||||
|
||||
"github.com/spf13/cobra"
|
||||
"github.com/stretchr/testify/assert"
|
||||
)
|
||||
|
||||
func TestAddJSONFlags_RegistersFlags(t *testing.T) {
|
||||
c := &cobra.Command{Use: "x"}
|
||||
var exp Exporter
|
||||
AddJSONFlags(c, &exp, []string{"id", "name"})
|
||||
assert.NotNil(t, c.Flags().Lookup("json"))
|
||||
assert.NotNil(t, c.Flags().Lookup("jq"))
|
||||
assert.NotNil(t, c.Flags().Lookup("template"))
|
||||
assert.NotNil(t, exp, "exporter must be initialized")
|
||||
}
|
||||
@@ -6,11 +6,6 @@ import (
|
||||
"github.com/spf13/cobra"
|
||||
)
|
||||
|
||||
// Options is the marker interface every command's <Verb>Options struct should
|
||||
// satisfy. Concrete Options structs (KbListOptions, DocUploadOptions, ...)
|
||||
// are declared in their own command file; see CONTRIBUTING.md for the template.
|
||||
type Options interface{}
|
||||
|
||||
// MustRequireFlag panics on programmer error (typo in flag name). cobra's
|
||||
// MarkFlagRequired only returns an error when the named flag does not exist
|
||||
// on the command, which means the caller has a typo at registration time —
|
||||
|
||||
Reference in New Issue
Block a user