open-code-review/cmd/opencodereview/delegate_cmd.go
kite 80a5794667
Some checks are pending
CI / test (push) Waiting to run
CI / cross-compile (amd64, darwin) (push) Waiting to run
CI / cross-compile (amd64, windows) (push) Waiting to run
CI / cross-compile (arm64, darwin) (push) Waiting to run
CI / cross-compile (arm64, linux) (push) Waiting to run
CI / cross-compile (arm64, windows) (push) Waiting to run
Deploy Pages / build (push) Waiting to run
Deploy Pages / deploy (push) Blocked by required conditions
refactor(cli): migrate to Cobra framework for shell completion support (#625)
* refactor(cli): migrate to Cobra framework for shell completion support

Replace the hand-rolled ocrFlagSet + switch dispatch with spf13/cobra,
enabling native bash/zsh/fish/powershell completion via `ocr completion`.

Key changes:
- Add root.go (rootCmd definition, version flag with -V shorthand)
- Add completion.go (ocr completion [bash|zsh|fish|powershell])
- Add shared_flags.go (reusable flag registration helpers + validation)
- Rewrite all *_cmd.go to use cobra.Command with RunE
- Delete flags.go (ocrFlagSet, expandShortFlags, parseXxxFlags)
- Add compat_test.go (test compatibility wrappers for existing tests)
- Promote github.com/spf13/cobra from indirect to direct dependency

Behavioral improvements over the previous implementation:
- Shell completion for all commands, flags, and enum values
- "Did you mean?" suggestions for misspelled commands
- cobra.NoArgs on review/scan prevents silent positional arg ignoring
- Cleaner error messages on unknown flags (no full flag dump)
- Consistent help output format across all subcommands

Closes #576

* fix(cli): add Args: cobra.NoArgs to viewerCmd

Prevents `ocr viewer localhost:3000` from silently ignoring the
positional argument and starting on the default address.
Consistent with reviewCmd and scanCmd.

* feat(cli): add "Did you mean?" suggestions for misspelled flags

Cobra only suggests corrections for unknown subcommands, not flags.
Add a levenshtein-distance based suggestion that fires when cobra
returns an "unknown flag" error, matching the same UX pattern.

Examples:
  --hel     → Did you mean this? --help
  --audienc → Did you mean this? --audience
  --comit   → Did you mean this? --commit

* fix(deps): promote spf13/pflag to direct dependency

After the Cobra migration, pflag is directly imported but was still
marked as indirect in go.mod, causing CI's go-mod-tidy check to fail.

* refactor(cli): use idiomatic cobra patterns for args validation and flag errors

Replace hand-rolled argument validation in configSetCmd/configUnsetCmd
with cobra.ExactArgs, and move flag typo suggestions from post-hoc error
string parsing into SetFlagErrorFunc where cobra provides the command
context directly.
2026-07-31 16:56:07 +08:00

213 lines
6.1 KiB
Go

package main
import (
"context"
"fmt"
"github.com/alibaba/open-code-review/internal/agent"
"github.com/alibaba/open-code-review/internal/config/rules"
"github.com/alibaba/open-code-review/internal/delegate"
"github.com/alibaba/open-code-review/internal/diff"
"github.com/spf13/cobra"
)
type delegateOptions struct {
repoDir string
from string
to string
commit string
excludes string
rulePath string
background string
backgroundFile string
maxGitProcs int
}
var delegatePreviewOpts delegateOptions
var delegateRuleOpts delegateOptions
var delegateCmd = &cobra.Command{
Use: "delegate",
Aliases: []string{"d"},
Short: "Output review spec for host-agent delegation (no LLM required)",
Long: `OpenCodeReview - Delegation Mode
Output review spec for host-agent delegation (no LLM required).`,
Example: ` # Preview which files will be reviewed
ocr delegate preview --from main --to feature
# Preview workspace changes
ocr delegate preview
# Get rules for multiple files (grouped by content)
ocr delegate rule internal/agent/agent.go internal/llm/client.go`,
}
var delegatePreviewCmd = &cobra.Command{
Use: "preview [flags]",
Short: "Preview reviewable files with mode/ref metadata",
Long: "Outputs reviewable file list with mode/ref metadata for the host agent to construct git commands.",
RunE: func(cmd *cobra.Command, args []string) error {
if err := validateDelegateOptions(&delegatePreviewOpts); err != nil {
return err
}
return executeDelegatePreview(delegatePreviewOpts)
},
}
var delegateRuleCmd = &cobra.Command{
Use: "rule [flags] <path...>",
Short: "Output resolved review rules grouped by content",
Long: "Outputs resolved review rules grouped by content. Accepts multiple paths.",
Args: cobra.MinimumNArgs(1),
RunE: func(cmd *cobra.Command, args []string) error {
if err := validateDelegateOptions(&delegateRuleOpts); err != nil {
return err
}
return executeDelegateRule(delegateRuleOpts, args)
},
}
func init() {
registerDelegateFlags(delegatePreviewCmd, &delegatePreviewOpts)
registerDelegateFlags(delegateRuleCmd, &delegateRuleOpts)
delegateCmd.AddCommand(delegatePreviewCmd)
delegateCmd.AddCommand(delegateRuleCmd)
}
// delegateContext holds the shared state for delegate sub-commands.
type delegateContext struct {
cc *commonContext
opts delegateOptions
}
func loadDelegateContext(opts delegateOptions) (*delegateContext, error) {
cc, err := loadCommonContext(opts.repoDir, opts.rulePath, 0, opts.maxGitProcs, true)
if err != nil {
return nil, err
}
applyCLIExcludes(cc, splitPaths(opts.excludes))
// Security: reject ref-option injection.
reviewOpts := reviewOptions{from: opts.from, to: opts.to, commit: opts.commit}
if err := validateReviewRefs(cc.RepoDir, reviewOpts); err != nil {
return nil, err
}
// Resolve background from --background-file if set.
if opts.backgroundFile != "" {
bgPath := resolveBackgroundFilePath(cc.RepoDir, opts.backgroundFile)
fileBackground, err := loadBackgroundFile(bgPath)
if err != nil {
return nil, err
}
opts.background = mergeBackground(opts.background, fileBackground)
}
// Auto-fill background from commit message when reviewing a single commit.
if opts.commit != "" && opts.background == "" {
if msg, err := getCommitMessage(cc.RepoDir, opts.commit); err == nil && msg != "" {
opts.background = msg
}
}
return &delegateContext{cc: cc, opts: opts}, nil
}
// preview runs the agent's file-selection logic and returns the preview result.
func (dc *delegateContext) preview(ctx context.Context) (*agent.DiffPreview, error) {
ag := agent.New(agent.Args{
RepoDir: dc.cc.RepoDir,
From: dc.opts.from,
To: dc.opts.to,
Commit: dc.opts.commit,
FileFilter: dc.cc.FileFilter,
GitRunner: dc.cc.GitRunner,
})
return ag.Preview(ctx)
}
// mergeBase computes the merge-base for range mode. Returns "" for other modes.
func (dc *delegateContext) mergeBase(ctx context.Context) string {
if dc.opts.from == "" || dc.opts.to == "" {
return ""
}
provider := diff.NewProvider(dc.cc.RepoDir, dc.opts.from, dc.opts.to, dc.cc.GitRunner)
return provider.MergeBase(ctx)
}
// reviewMode returns the string mode identifier.
func (dc *delegateContext) reviewMode() string {
switch {
case dc.opts.commit != "":
return "commit"
case dc.opts.from != "" && dc.opts.to != "":
return "range"
default:
return "workspace"
}
}
// resolver returns the rules Resolver, asserting DetailResolver if available.
func (dc *delegateContext) resolver() rules.Resolver {
return dc.cc.Resolver
}
func executeDelegatePreview(opts delegateOptions) error {
dc, err := loadDelegateContext(opts)
if err != nil {
return err
}
ctx := context.Background()
preview, err := dc.preview(ctx)
if err != nil {
return fmt.Errorf("preview failed: %w", err)
}
fmt.Printf("# Files (%d reviewable / %d total)\n\n", preview.ReviewableCount, preview.TotalFiles)
fmt.Printf("- mode: %s\n", dc.reviewMode())
if dc.opts.from != "" {
fmt.Printf("- from: %s\n", dc.opts.from)
}
if dc.opts.to != "" {
fmt.Printf("- to: %s\n", dc.opts.to)
}
if dc.opts.commit != "" {
fmt.Printf("- commit: %s\n", dc.opts.commit)
}
if mergeBase := dc.mergeBase(ctx); mergeBase != "" {
fmt.Printf("- merge_base: %s\n", mergeBase)
}
if dc.opts.background != "" {
fmt.Printf("- background: %s\n", dc.opts.background)
}
fmt.Printf("- total_insertions: %d\n", preview.TotalInsertions)
fmt.Printf("- total_deletions: %d\n\n", preview.TotalDeletions)
for _, entry := range preview.Entries {
marker := " "
if !entry.WillReview {
marker = "~~"
}
fmt.Printf("%s- `%s` [%s] +%d/-%d", marker, entry.Path, entry.Status, entry.Insertions, entry.Deletions)
if !entry.WillReview {
fmt.Printf(" (excluded: %s)", entry.ExcludeReason)
fmt.Print("~~")
}
fmt.Println()
}
return nil
}
func executeDelegateRule(opts delegateOptions, paths []string) error {
dc, err := loadDelegateContext(opts)
if err != nil {
return err
}
groups := delegate.GroupRules(dc.resolver(), paths)
fmt.Print(delegate.RuleGroupsMarkdown(groups))
return nil
}