repomap

package module
v0.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 10, 2026 License: MIT Imports: 46 Imported by: 0

README

repomap

A repository becomes a map.

$ repomap .
## Repository Map (41 files, 119 symbols)

### Dependencies
repomap/cmd/repomap → repomap/internal/cli
repomap/internal/cli → repomap

cmd/repomap/main.go [entry]
  func main()

repomap.go [imported by 1]
  type Config{MaxTokens int, MaxTokensNoCtx int, ...}
    // holds options for a Map build
  type Map
    // is the top-level orchestrator. Thread-safe.
  func New(root string, cfg Config) *Map
    // creates a Map for root with the given config
  func (m *Map) Build(ctx context.Context) error
    // scans, parses, ranks, and budgets the repository
  func (m *Map) String() string
  func (m *Map) StringCompact() string
  func (m *Map) StringVerbose() string
  func (m *Map) StringDetail() string
  func (m *Map) StringLines() string
  func (m *Map) StringXML() string

That is the point.

The Problem

LLMs work best when they can see a whole codebase at once. Most codebases are too large. find, tree, and ls -R hand the model noise. A full cat **/*.go blows the context window in one shot.

You want the skeleton. Every package. Every exported symbol. Nothing else.

The Shape

repomap runs a five-stage pipeline on your project root:

scan → parse → rank → budget → format

Scan walks git ls-files and detects languages. Parse extracts symbols — go/ast for Go, tree-sitter for seven other languages, regex where neither reaches. Rank scores files: entry points float, leaves sink. Budget trims to fit a token ceiling you pass in. Format prints compact Markdown, verbose text, source lines, or structured XML.

The output fits in a prompt. The prompt fits in the model. The model reads the repository.

Install

go install github.com/dotcommander/repomap/cmd/repomap@latest

Or clone and build:

git clone https://github.com/dotcommander/repomap
cd repomap
go build -o repomap ./cmd/repomap

Use

repomap                             # current directory, 2048 tokens, enriched default
repomap ./src                       # target a subtree
repomap -t 4096                     # wider budget
repomap -f compact                  # lean orientation: file paths + symbol names only
repomap -f verbose                  # every symbol, no summarization
repomap -f detail                   # signatures and struct fields (same as default, no budget cap)
repomap -f lines                    # actual source lines, not summaries
repomap -f xml                      # structured output for programmatic consumers
repomap --json                      # JSON envelope {schema_version:1, lines:[...]}
repomap --json --json-legacy        # bare []string JSON (pre-v0.7.0 compat)
Output formats
Format What it shows Budget enforced
(default) Paths, exported symbol names, typed signatures, godoc first sentence, typed struct fields Yes
compact Paths + exported symbol names only — lean orientation mode Yes
verbose All symbols, names only, no summarization No
detail All symbols, signatures, and struct fields No
lines Actual source lines No
xml Structured XML for programmatic consumers No

Budget guarantee: repomap never truncates a file mid-symbol. Files either render fully at their assigned detail level or drop to a lower level or are omitted — token budget is honored exactly. The footer reports how many files were omitted.

Quickstart

repomap init                        # scaffold .repomap.yaml + post-commit hook
repomap init --no-hook              # config only
repomap init --force                # overwrite existing

repomap init writes .repomap.yaml at the project root and installs a git post-commit hook that refreshes the cache in the background after every commit, so repomap stays instant. Idempotent — re-running without --force skips existing files.

Languages

Go, PHP, Python, Rust, TypeScript, JavaScript, Java, C, C++, Ruby, HTML, CSS. Go parses through go/ast directly; PHP parses through tree-sitter with full 8.x coverage (signatures, visibility, constructor property promotion, PHPDoc). The rest go through tree-sitter when the grammar is present, ctags when it is not, regex when neither exists. Quality degrades gracefully; the map is never empty because a parser was missing.

Configuration

Create .repomap.yaml at the project root to control what gets scanned and how it's ranked:

method_blocklist:
  - "Test*"           # glob: drop anything starting with "Test"
  - "*Mock"           # glob: drop anything ending in "Mock"
  - "/^pb_/"          # regex: drop generated protobuf methods

include_paths:
  - "cmd/*"
  - "internal/*"
  - "pkg/*"

exclude_paths:
  - "internal/generated/*"
  - "vendor/*"

file_overrides:
  "cmd/*/main.go": "full"
  "internal/generated/**": "omit"
Field Purpose
method_blocklist Glob or regex patterns — drops matching symbol names at parse time
include_paths When non-empty, only files matching these globs are scanned
exclude_paths Files matching these globs are always excluded (takes precedence over include_paths)
file_overrides Forces specific files to "full" or "omit" detail regardless of rank

method_blocklist patterns wrapped in /.../ are Go regex; others are path.Match globs. Absent file = no filtering.

Library

import "github.com/dotcommander/repomap"

m := repomap.New(".", repomap.Config{MaxTokens: 2048})
if err := m.Build(context.Background()); err != nil {
    return err
}
fmt.Print(m.String())

Every format has a method: String, StringCompact, StringVerbose, StringDetail, StringLines, StringXML. Results cache per format; call them as often as you like.

String() is the enriched default: full typed signatures, godoc first sentences, and typed struct fields for exported symbols, within the token budget. StringCompact() is the lean orientation mode — symbol names only, no signatures or docs.

m.Stale() reports whether source files have changed since the last build. Rebuild when it returns true.

Design

One package. No internal taxonomy of subpackages. Files named after what they do — scanner.go, ranker.go, budget.go, render.go. If a thing has a name, the file has that name. If a thing has a pipeline stage, the file has that stage.

Docs live in docs/. Read them in the order they're numbered.

Acknowledgments

The repository map concept was pioneered by aider.chat — an AI pair programming tool that introduced the idea of distilling a codebase into a compact symbol map that fits in an LLM context window.

License

MIT

Documentation

Index

Constants

View Source
const (
	WeightTestPair  = 1.0
	WeightSymbolDep = 0.8
	WeightCoChange  = 0.5
	WeightSibling   = 0.3
)

Edge weights used by commit_grouping.buildEdges. Grouped here so the full edge-weight vocabulary is visible in one place and the clustering contract (DefaultConfidenceCutoff) has something to derive from.

Cluster-forming edges (weight >= DefaultConfidenceCutoff):

  • WeightTestPair — a test and its implementation file
  • WeightSymbolDep — one file imports another (exact-syntax match; Go module path, PHP FQCN `use`, Python dotted package, Rust `use` path, TS relative `import`)

Refine-only edges (below the cutoff; tie-break within a cluster but never form one on their own):

  • WeightCoChange — historical co-commit frequency
  • WeightSibling — same directory + same inferred type
View Source
const (
	PrepStatusReady         = "ready"
	PrepStatusNeedsJudgment = "needs_judgment"
	PrepStatusAbort         = "abort"
)

Prep status values emitted in PrepPayload.Status.

View Source
const (
	VerdictSafe   = "safe"
	VerdictUnsafe = "unsafe"
)

Review verdict values emitted in ReviewDecision.Verdict.

View Source
const (
	ActionFix    = "fix"
	ActionSafe   = "safe"
	ActionReview = "review"
)

DefaultAction values emitted in Finding.DefaultAction.

View Source
const DefaultConfidenceCutoff = WeightSymbolDep - 0.05

DefaultConfidenceCutoff is the minimum per-edge weight required to form a cluster. Set slightly below WeightSymbolDep so that symbol-dep is the lowest cluster-forming edge type; co-change (0.5) and sibling (0.3) are below the cutoff by design — they refine an already-clustered group but never pull files together on their own.

Invariant enforced by Test_EdgeWeights_ClusteringContract: every cluster-forming weight (test-pair, symbol-dep) must exceed this cutoff; every refine-only weight (co-change, sibling) must be below it.

Variables

View Source
var ErrNotCodeProject = errors.New("no source files found")

ErrNotCodeProject is returned by Build when the target directory contains no recognisable source files. Callers should treat this as a normal condition, not an error — the project is simply not a code project.

Functions

func ApplyCallerBonus added in v0.11.1

func ApplyCallerBonus(ranked []RankedFile, callerCounts map[string]int)

ApplyCallerBonus boosts files proportional to their caller count. Only meaningful in --calls mode where caller data is available.

Score delta: min(uniqueCallerFiles*2, 30) — capped at +30 so caller-heavy files boost rank without dominating files with high import counts.

func ApplyConsumedBonus added in v0.11.1

func ApplyConsumedBonus(ranked []RankedFile, consumedPaths map[string]bool)

ApplyConsumedBonus adjusts scores for files the caller has already read.

Consumed files are downranked (score halved) since the caller already has their content. Files that import consumed files are upranked (+15 per consumed dependency, capped at +45) because they are likely next files the caller will need to understand.

Follows the same pattern as ApplyCallerBonus: mutates scores in-place, re-sorts by score descending / path ascending for ties, returns nothing. No-op when consumedPaths is empty.

func ApplyReviewDecisions added in v0.11.0

func ApplyReviewDecisions(ctx context.Context, repoRoot string, decisions []ReviewDecision, findings []Finding) error

ApplyReviewDecisions applies LLM-adjudicated verdicts to REVIEW findings. For verdict="unsafe": applies the decision's Replacement at the finding's file+line. For verdict="safe": no-op (finding is cleared without edit). Decisions referencing unknown findings are silently skipped.

func CallerCountsFromSymbolCallers added in v0.11.1

func CallerCountsFromSymbolCallers(callers SymbolCallers) map[string]int

CallerCountsFromSymbolCallers derives a per-file unique-caller-file count from the SymbolCallers map produced by ExpandCallers.

The key in SymbolCallers is "targetFile\x00symbol"; each value is a slice of Locations (one per call site). We count distinct caller files per target file across all its symbols.

func CallsCacheKey added in v0.7.0

func CallsCacheKey(root string, ranked []RankedFile, cfg CallsConfig) string

CallsCacheKey computes the FNV hash key for a --calls cache entry. Components: absolute repo root + sorted (path, mtime) pairs + flag combo string.

func CheckGopls added in v0.7.0

func CheckGopls() error

CheckGopls verifies that gopls is on PATH.

func CheckLspq added in v0.7.0

func CheckLspq() error

CheckLspq verifies that the lspq binary is on PATH, returning a descriptive error if it is not. Used only when --calls-use-binary is set.

func ContainsLowConf added in v0.11.0

func ContainsLowConf(lowConf []PrepLowConf, groupID string) bool

ContainsLowConf reports whether lowConf already contains an entry for groupID. Prevents double-adding a group that was already flagged by the confidence pass.

func CtagsAvailable

func CtagsAvailable() bool

CtagsAvailable reports whether ctags with JSON output support is on PATH.

func DetectImplementations

func DetectImplementations(files []*FileSymbols)

DetectImplementations scans parsed files and populates Symbol.Implements on struct types whose exported method sets satisfy an interface declared in the same project.

Matching is by exported method name only — a struct implements an interface if its methods are a superset of the interface's method names. This is a proxy for Go's structural typing; it is tight enough for LLM signal but not a full type checker (signature compatibility is not verified, and embedded interfaces are treated as opaque method names).

func DetectJustfileRelease added in v0.11.0

func DetectJustfileRelease(repoRoot string) bool

DetectJustfileRelease returns true when a Justfile with a `release` recipe exists.

func DetectSessionRepos added in v0.11.0

func DetectSessionRepos(repoRoot string) []string

DetectSessionRepos returns repos likely touched in this session. Checks known companion repos; always includes repoRoot itself.

func EncodeExecuteResult added in v0.10.0

func EncodeExecuteResult(r *ExecuteResult, pretty bool) ([]byte, error)

EncodeExecuteResult serializes an ExecuteResult for stdout.

func EncodeJSON

func EncodeJSON(a *CommitAnalysis, pretty bool) ([]byte, error)

EncodeJSON serializes a CommitAnalysis for stdout. Compact by default; set pretty=true for human inspection.

func ExecExitCode added in v0.10.0

func ExecExitCode(err error) int

ExecExitCode extracts the exit code from an execError, defaulting to 1.

func ExpandCallers added in v0.7.0

func ExpandCallers(
	ctx context.Context,
	root string,
	ranked []RankedFile,
	cfg CallsConfig,
	q RefsQuerier,
	progress func(done, total int),
) (SymbolCallers, CallsStats)

ExpandCallers queries a RefsQuerier for each exported symbol in files that meet the threshold, returning a SymbolCallers map and run statistics.

progress is called with (done, total) as each symbol completes; pass nil to disable.

func FormatLines

func FormatLines(files []RankedFile, maxTokens int, root string) string

FormatLines formats ranked files showing actual source code lines. root is the project root for resolving file paths.

func FormatMap

func FormatMap(files []RankedFile, maxTokens int, verbose, detail bool, cfg *BlocklistConfig) string

FormatMap formats ranked files into a token-budgeted text representation. maxTokens controls the output size (estimated as len(text)/4). cfg may be nil — nil means no file-level detail overrides. Returns empty string if no files have symbols. When verbose is true, shows all symbols without summarization. When detail is true, shows signatures for funcs/methods and fields for structs.

func FormatMapCompact added in v0.7.0

func FormatMapCompact(files []RankedFile, maxTokens int, cfg *BlocklistConfig) string

FormatMapCompact formats ranked files into the lean orientation mode: path + exported symbol names only, NO signatures, NO godoc, NO struct fields. Budget is applied using compactCost so more files fit vs. the enriched default. cfg may be nil — nil means no file-level detail overrides. Returns empty string if no files have symbols.

func FormatMapWithCallers added in v0.7.0

func FormatMapWithCallers(files []RankedFile, maxTokens int, verbose, detail bool, callers SymbolCallers, limit int, cfg *BlocklistConfig) string

FormatMapWithCallers formats the ranked files like FormatMap but injects caller information from the callers map into the output. cfg may be nil — nil means no file-level detail overrides.

func FormatXML

func FormatXML(files []RankedFile, maxTokens int, cfg *BlocklistConfig) string

FormatXML formats ranked files as a structured XML document. maxTokens controls the output size (estimated as len(text)/4). cfg may be nil — nil means no file-level detail overrides. Returns empty string if no files have symbols.

func IsKitchenSink added in v0.11.0

func IsKitchenSink(g *CommitGroup) bool

IsKitchenSink returns true when a CommitGroup looks like an accidental fusion that should be forced to LLM judgment. Triggers:

  1. Group has more than 10 files.
  2. Group spans more than one distinct top-level plugin segment (e.g. plugins/dc/... and plugins/pi/... in the same group).
  3. Group contains a plugin.json path — signals a new plugin being added.

func LanguageFor

func LanguageFor(ext string) string

LanguageFor returns the language ID for a file extension, or "" if unsupported.

func LoadDiffSlice added in v0.11.0

func LoadDiffSlice(diffsPath string, g CommitGroup, maxChars int) string

LoadDiffSlice extracts the diff slice for a group's files, capped at maxChars.

func ModeHint added in v0.11.0

func ModeHint(p PrepPreflight) string

ModeHint derives FULL/LOCAL from preflight signals.

FULL  = remote present AND gh auth logged in → push + tag
LOCAL = anything else                        → no push, no tag

Permissive on auth string format: any "logged in" substring is truthy unless the line also says "not logged in" (gh's own negative phrasing).

func ParseFindQuery added in v0.6.0

func ParseFindQuery(q string) (name, kind, file string)

ParseFindQuery splits a positional query of the form

[kind:][file:<path>:]<name>

into (name, kind, file). Qualifier prefixes may appear in either order; the final token is always the name. Empty input returns all empties.

func PersistInventory

func PersistInventory(inv *Inventory, cacheDir string) error

PersistInventory writes the inventory to disk using atomic write (temp + rename).

func PersistPrepState added in v0.11.0

func PersistPrepState(state *PrepState) (string, error)

PersistPrepState writes state to tmpdir and returns the prep_token.

func Polish added in v0.11.0

func Polish(g CommitGroup) (subject string, confidence float64)

Polish generates a heuristic commit subject for a CommitGroup. Returns (subject, confidence) where confidence >= 0.6 is safe to use without LLM review. Below 0.6, callers should mark the group for LLM polish.

Algorithm: classify files by extension family and directory prefix, then combine with a diff-stat action verb to produce a templated subject. Specificity rules:

  • test files → type=test, confidence 0.7
  • single file, known family → confidence depends on scope clarity
  • mixed / unknown → chore fallback at 0.3

func PolishGroup added in v0.11.0

func PolishGroup(g *CommitGroup, threshold float64) bool

PolishGroup is a convenience wrapper that applies Polish and updates g.SuggestedMsg when the result meets the confidence threshold. Returns whether the message was updated.

func QueryInventory

func QueryInventory(cacheDir string, filter string) (string, error)

func RenderPlan added in v0.11.0

func RenderPlan(groups []CommitGroup) string

RenderPlan emits commit-execute.sh's native format:

COMMIT
MSG: feat(scope): subject
FILES: path1
FILES: path2
COMMIT
...
END

Release gate (--tag + go.mod bump) is left to the agent to apply before invoking commit-execute.sh; the tool reports it via dep_bumps, not the plan.

func SaveCallsCache added in v0.7.0

func SaveCallsCache(cacheDir, hash string, callers SymbolCallers) error

SaveCallsCache writes a SymbolCallers map to disk atomically.

func StashArtifacts added in v0.11.0

func StashArtifacts(repoRoot string, artifacts []string)

StashArtifacts adds artifact paths to .gitignore and unstages them. Best-effort: I/O failures are swallowed (artifacts are advisory).

func TreeSitterAvailable

func TreeSitterAvailable() bool

TreeSitterAvailable reports whether tree-sitter parsing is available.

func ValidateConventionalMsg added in v0.10.0

func ValidateConventionalMsg(msg string) error

ValidateConventionalMsg returns an error if the first line of msg does not match conventionalSubjectRe. Only the first line is validated; a multi-line body is allowed.

func ValidateTag added in v0.10.0

func ValidateTag(tag string) error

ValidateTag returns an error if tag does not match the semver format.

Types

type AnalyzeOptions

type AnalyzeOptions struct {
	Root             string  // repo root (usually ".")
	Tag              bool    // --tag: activate release gate (go.mod bump before commit)
	ConfidenceCutoff float64 // default 0.75
	Tmpdir           string  // override temp directory (tests)
}

AnalyzeOptions configures a commit-analyze run.

type BlocklistConfig added in v0.6.0

type BlocklistConfig struct {
	// MethodBlocklist lists symbol-name patterns to drop at parse time.
	// Each entry is either:
	//   - a regex wrapped in forward slashes, e.g. "/^pb_/"
	//   - a glob matched with path.Match, e.g. "Test*" or "*Mock"
	MethodBlocklist []string `yaml:"method_blocklist"`

	// ExcludePaths lists path glob patterns (relative to project root) to drop
	// at scan time. Any file whose relative path matches is excluded.
	// Example: ["internal/gen/*", "vendor/*"]
	ExcludePaths []string `yaml:"exclude_paths"`

	// IncludePaths lists path glob patterns (relative to project root) to keep
	// at scan time. When non-empty, only matching files are included.
	// Example: ["cmd/*", "internal/cli/*"]
	IncludePaths []string `yaml:"include_paths"`

	// FileOverrides maps relative-path globs to forced detail levels.
	// Accepted values: "full" (DetailLevel 2) and "omit" (DetailLevel -1).
	// Example:
	//   file_overrides:
	//     "cmd/main.go": full
	//     "internal/gen/**": omit
	FileOverrides map[string]string `yaml:"file_overrides"`
	// contains filtered or unexported fields
}

BlocklistConfig holds loaded-from-disk repomap settings that filter parsed symbols and file paths. Safe for concurrent reads after Load returns.

func LoadBlocklistConfig added in v0.6.0

func LoadBlocklistConfig(root string) (*BlocklistConfig, error)

LoadBlocklistConfig reads <root>/.repomap.yaml. Returns zero-value config when the file is absent. Returns a wrapped error only when the file exists but is malformed or has invalid patterns.

func (*BlocklistConfig) MatchFileOverride added in v0.11.1

func (c *BlocklistConfig) MatchFileOverride(rel string) (level int, ok bool)

MatchFileOverride reports whether a relative file path matches any file_overrides rule. Returns the forced DetailLevel (2 or -1) and true on match; 0 and false otherwise. A nil receiver returns (0, false) — no overrides. Globs use path.Match semantics; patterns containing "**" match any path with the corresponding prefix (everything before the first "**").

func (*BlocklistConfig) ShouldExcludePath added in v0.11.1

func (c *BlocklistConfig) ShouldExcludePath(rel string) bool

ShouldExcludePath reports whether rel matches any ExcludePaths pattern. rel must be a slash-separated path relative to the project root. A nil receiver returns false (nothing excluded).

func (*BlocklistConfig) ShouldIncludePath added in v0.11.1

func (c *BlocklistConfig) ShouldIncludePath(rel string) bool

ShouldIncludePath reports whether rel passes the IncludePaths filter. When IncludePaths is empty, all paths are included (returns true). When non-empty, returns true only if rel matches at least one pattern. A nil receiver returns true (nothing excluded).

func (*BlocklistConfig) ShouldSkipSymbol added in v0.6.0

func (c *BlocklistConfig) ShouldSkipSymbol(name string) bool

ShouldSkipSymbol reports whether a symbol name matches any blocklist pattern. A nil receiver or empty blocklist returns false.

type CallsConfig added in v0.7.0

type CallsConfig struct {
	// Threshold: only expand symbols in files with ImportedBy >= Threshold.
	Threshold int
	// Limit: max callers shown per symbol.
	Limit int
	// IncludeTests: when false, filter out callers whose file path contains _test.go.
	IncludeTests bool
}

CallsConfig controls --calls mode behaviour.

func DefaultCallsConfig added in v0.7.0

func DefaultCallsConfig() CallsConfig

DefaultCallsConfig returns the default --calls settings.

type CallsStats added in v0.7.0

type CallsStats struct {
	OK      int
	Timeout int
	Error   int
}

CallsStats holds counters from a call-expansion run.

type Candidate added in v0.11.0

type Candidate struct {
	File        string `json:"file"`
	Line        int    `json:"line"`
	Kind        string `json:"kind"`                  // go_lint | go_vet | go_complexity | ts_lint | py_lint
	Hint        string `json:"hint"`                  // human-readable finding
	Replacement string `json:"replacement,omitempty"` // "" means no auto-fix available
}

Candidate is one code-quality finding from the simplify detector. Replacement is empty when the detector does not provide an auto-fix (the current shell script never does — it only reports).

func ApplyCandidates added in v0.11.0

func ApplyCandidates(ctx context.Context, repoRoot string, candidates []Candidate) (applied, skipped []Candidate, err error)

ApplyCandidates attempts to apply each candidate's Replacement at file:line. Candidates with an empty Replacement are always marked skipped (the current simplify-detect.sh never provides one — findings are informational only).

For candidates that do carry a Replacement, the function reads the file, verifies the line still matches the expected content, and rewrites it atomically via temp+rename. Mismatches are skipped (not errors) to be idempotent across re-runs.

func RunSimplifyDetect added in v0.11.0

func RunSimplifyDetect(ctx context.Context, repoRoot string) ([]Candidate, error)

RunSimplifyDetect execs simplify-detect.sh and parses its section output into a []Candidate. Returns nil candidates (not an error) when the script is absent, exits non-zero, or finds nothing.

type CommitAnalysis

type CommitAnalysis struct {
	Version        int            `json:"version"`
	Tmpdir         string         `json:"tmpdir"`
	EarlyExit      bool           `json:"early_exit"`
	EarlyReason    string         `json:"early_reason,omitempty"`
	Complexity     string         `json:"complexity"` // simple | medium | complex
	Counts         CommitCounts   `json:"counts"`
	HistoryStyle   string         `json:"history_style"`             // conventional | mixed | freeform
	LatestTag      string         `json:"latest_tag,omitempty"`      // most recent semver tag; empty if none
	RecentSubjects []string       `json:"recent_subjects,omitempty"` // top-5 commit subjects from HEAD (style sample)
	Remote         RemoteInfo     `json:"remote"`                    // origin URL + visibility class; drives finding default_action
	Secrets        SecretsSummary `json:"secrets"`
	Artifacts      []string       `json:"artifacts"`    // paths recommended for .gitignore
	ConfigFiles    []string       `json:"config_files"` // .md/.yaml/.toml/.json/.env*/.cfg/.ini/.conf in changeset
	DepBumps       []DepBump      `json:"dep_bumps"`
	Groups         []CommitGroup  `json:"groups"`
	BreakingCount  int            `json:"breaking_count,omitempty"` // count of groups with Breaking=true
	PlanHash       string         `json:"plan_hash"`
	Refs           CommitRefs     `json:"refs"`
	Diagnostics    []string       `json:"diagnostics,omitempty"` // non-fatal warnings
}

CommitAnalysis is the JSON document `repomap commit analyze` writes to stdout. Designed to stay under ~5KB for typical changesets — large blobs (full diffs, untracked content, plan text, full findings) are written to disk and referenced by Refs paths so the agent can read them on demand.

func AnalyzeCommit

func AnalyzeCommit(ctx context.Context, opts AnalyzeOptions) (*CommitAnalysis, error)

AnalyzeCommit is the public entrypoint called by the CLI. Collects git state, parses all dirty files, runs grouping + messages + secrets, writes side files, returns the CommitAnalysis ready for JSON emit.

type CommitCounts

type CommitCounts struct {
	Total     int `json:"total"`
	Staged    int `json:"staged"`
	Unstaged  int `json:"unstaged"`
	Untracked int `json:"untracked"`
}

CommitCounts gives a per-status file tally.

type CommitGroup

type CommitGroup struct {
	ID           string            `json:"id"`
	Type         string            `json:"type"`           // feat | fix | docs | chore | test | refactor | deps
	Scope        string            `json:"scope"`          // empty for top-level changes
	Verb         string            `json:"verb,omitempty"` // "add" | "remove" | "update" — dominant git operation
	SuggestedMsg string            `json:"suggested_msg"`
	Files        []string          `json:"files"`
	Rationale    string            `json:"rationale"`              // why these files cluster (backward-compat string)
	Confidence   float64           `json:"confidence"`             // 0.0–1.0
	Breaking     bool              `json:"breaking,omitempty"`     // true if any constituent file has a breaking-change delta
	DiffOffsets  map[string][2]int `json:"diff_offsets,omitempty"` // file -> [byte_start, byte_end] in refs.diffs
	Evidence     []EdgeEvidence    `json:"evidence,omitempty"`     // per-edge clustering evidence
}

CommitGroup is one proposed commit. The agent ratifies (confidence >= 0.75) or inspects refs.diffs at DiffOffsets to refine grouping/messaging.

func ConsolidateGroups added in v0.11.0

func ConsolidateGroups(groups []CommitGroup) []CommitGroup

ConsolidateGroups enforces the cap-3/fold-riders/merge-smallest rules from commit-agent.md §93-106. It is a pure function: input groups are not mutated.

Algorithm (deterministic — sort before every decision):

  1. Sort groups by file count desc, then ID alpha (stability).
  2. If ≤3 groups, return as-is.
  3. "Rider" = group with 1-2 files. Fold each rider into the largest group that shares its top-level directory. Riders with no match are left alone.
  4. If still >3 groups, merge the two smallest (by file count, then ID) into the smaller one's entry, keeping the larger group's SuggestedMsg.
  5. Repeat step 4 until ≤3.

type CommitRecord added in v0.10.0

type CommitRecord struct {
	SHA     string `json:"sha"`
	Message string `json:"message"`
}

CommitRecord is one landed commit.

type CommitRefs

type CommitRefs struct {
	Plan      string `json:"plan"`      // commit-execute.sh format, ready to pipe
	Diffs     string `json:"diffs"`     // full unified diff
	Untracked string `json:"untracked"` // full content of untracked config/md files
	History   string `json:"history"`   // full git log sample
	Findings  string `json:"findings"`  // FLAG/REVIEW/CLEAR JSON array
}

CommitRefs points at on-disk side files for content too large to inline.

type Config

type Config struct {
	MaxTokens      int      // token budget for output (default: 1024)
	MaxTokensNoCtx int      // budget when no files in conversation (default: 2048)
	Intent         string   // optional BM25 query for task-aware ranking
	ConsumedPaths  []string // optional: paths the caller has already read — these are downranked
}

Config holds repomap configuration.

func DefaultConfig

func DefaultConfig() Config

DefaultConfig returns the default configuration.

type DepBump

type DepBump struct {
	File    string   `json:"file"`              // go.mod, package.json, plugin.json, etc.
	Manager string   `json:"manager,omitempty"` // go | npm | cargo | dc-plugin
	Changes []string `json:"changes"`           // human-readable: "name v1 -> v2"
}

DepBump captures a recognized dependency version change in package manifests.

type EdgeEvidence added in v0.9.0

type EdgeEvidence struct {
	A      string  `json:"a"`      // first file path
	B      string  `json:"b"`      // second file path
	Weight float64 `json:"weight"` // edge weight (1.0 test-pair, 0.8/0.6 symbol-dep, 0.5 co-change, 0.3 sibling)
	Reason string  `json:"reason"` // "test-pair" | "symbol-dep" | "co-change" | "sibling"
}

EdgeEvidence records one weighted edge that contributed to a group's clustering, so agents can inspect or override the grouping logic without pattern-matching on the Rationale string.

type ExecuteOptions added in v0.10.0

type ExecuteOptions struct {
	Root             string // repo root (default ".")
	PlanFile         string // path to CommitAnalysis JSON (required)
	Push             bool   // git push origin <branch> --follow-tags
	Tag              string // annotated tag to create at HEAD (semver)
	NoRelease        bool   // skip gh release create
	ReleaseNotesFrom string // --notes-start-tag for gh release create
	DryRun           bool   // print actions, mutate nothing
	JSON             bool   // machine-readable result on stdout
	SkipFix          bool   // bypass consolidation pass
}

ExecuteOptions configures a commit-execute run.

type ExecuteResult added in v0.10.0

type ExecuteResult struct {
	Branch     string          `json:"branch"`
	Commits    []CommitRecord  `json:"commits"`
	Tag        *string         `json:"tag"`
	Pushed     bool            `json:"pushed"`
	ReleaseURL *string         `json:"release_url"`
	Postflight PostflightCheck `json:"postflight"`
}

ExecuteResult is the JSON-serializable result of a successful execute run.

func ExecuteCommit added in v0.10.0

func ExecuteCommit(ctx context.Context, opts ExecuteOptions) (*ExecuteResult, error)

ExecuteCommit loads the plan, validates it, consolidates groups, then executes git add/commit per group, then push/tag/release.

func ExecuteFromGroups added in v0.11.0

func ExecuteFromGroups(ctx context.Context, repoRoot string, groups []CommitGroup, opts ExecuteOptions) (*ExecuteResult, error)

ExecuteFromGroups runs the commit pipeline directly from a validated slice of CommitGroups, bypassing the plan-file load path. Intended for commit finish, which already has groups in memory. opts.PlanFile and opts.SkipFix are ignored.

type FileInfo

type FileInfo struct {
	Path     string // relative to project root
	Language string // language ID
}

FileInfo holds a discovered file with its language.

func ScanFiles

func ScanFiles(ctx context.Context, root string, cfg *BlocklistConfig) ([]FileInfo, error)

ScanFiles discovers source files in the given directory. Falls back to directory walk if not inside a git repo or if git ls-files fails. cfg may be nil — nil means no path filtering.

type FileMetrics

type FileMetrics struct {
	Path    string `json:"path"`
	Lines   int    `json:"lines"`
	Imports int    `json:"imports"`
	LastMod string `json:"last_modified"`
}

type FileSymbols

type FileSymbols struct {
	Path        string // relative path from project root
	Language    string // language ID
	Package     string // Go package name (empty for non-Go)
	ImportPath  string // Go import path from module (empty for non-Go)
	Symbols     []Symbol
	Imports     []string // import paths (Go) or module names (other)
	ParseMethod string   // "ast", "treesitter", "ctags", or "regex" — signals symbol fidelity
}

FileSymbols holds all symbols extracted from a single source file.

func ParseGenericFile

func ParseGenericFile(path, root, language string) (*FileSymbols, error)

ParseGenericFile extracts symbols from a non-Go source file using regex patterns. path is absolute, root is the project root for relative path calculation.

func ParseGoFile

func ParseGoFile(path, root string) (*FileSymbols, error)

ParseGoFile extracts exported symbols from a Go source file. path is absolute, root is the project root for relative path calculation.

func ParseWithCtags

func ParseWithCtags(ctx context.Context, root string, files []FileInfo) ([]*FileSymbols, error)

ParseWithCtags runs ctags once over all files and returns FileSymbols for each non-Go file in the list. Files must be absolute paths; root is used only for computing relative paths in output.

type Finding

type Finding struct {
	Class         string `json:"class"` // FLAG | REVIEW | CLEAR
	Kind          string `json:"kind"`  // secret | pii | dev_history | path | email | etc.
	File          string `json:"file"`
	Line          int    `json:"line,omitempty"`
	Snippet       string `json:"snippet,omitempty"`
	Detail        string `json:"detail,omitempty"`
	DefaultAction string `json:"default_action"` // fix | safe | review
}

Finding is one secret/PII/dev-history hit emitted by commit_secrets.go. DefaultAction is the deterministic adjudication the agent should follow unless it has a reason to override — it collapses the per-finding LLM loop that previously re-examined every REVIEW hit.

func ApplyFixFindings added in v0.11.0

func ApplyFixFindings(ctx context.Context, repoRoot string, findings []Finding) (applied, skipped []Finding, err error)

ApplyFixFindings applies the substitution table to all findings whose DefaultAction is "fix". Each line is rewritten in place using an atomic temp+rename write. Idempotent: if the placeholder is already present at that line, the finding is marked skipped.

Returns the applied and skipped findings, or an error on I/O failure.

func LoadFindings added in v0.11.0

func LoadFindings(path string) ([]Finding, error)

LoadFindings reads a findings JSON file. Returns nil, nil when absent.

type IntentScorer added in v0.11.1

type IntentScorer struct {
	// contains filtered or unexported fields
}

IntentScorer holds the corpus index and scores files against a query.

func NewIntentScorer added in v0.11.1

func NewIntentScorer(ranked []RankedFile) *IntentScorer

NewIntentScorer builds the per-file keyword index from ranked files.

func (*IntentScorer) Score added in v0.11.1

func (s *IntentScorer) Score(ranked []RankedFile, query string) []RankedFile

Score re-ranks files in place by multiplying base scores with BM25 relevance. Returns the same slice (mutated) sorted by final_score descending.

type Inventory

type Inventory struct {
	Files     []FileMetrics `json:"files"`
	Scanned   string        `json:"scanned"`
	RootPath  string        `json:"root_path"`
	Truncated bool          `json:"truncated,omitzero"` // true when file cap was reached
}

func LoadInventory

func LoadInventory(cacheDir string) *Inventory

LoadInventory reads a previously persisted inventory from disk. Returns nil if the file is missing or corrupt.

func ScanInventory

func ScanInventory(ctx context.Context, root string) (*Inventory, error)

type Location added in v0.7.0

type Location struct {
	File   string `json:"file"`
	Line   int    `json:"line"`
	Column int    `json:"column"`
}

Location is a source position returned by a refs query.

type Map

type Map struct {
	// contains filtered or unexported fields
}

Map holds the built repository map state.

func New

func New(root string, cfg Config) *Map

New creates a new Map for the given project root.

func (*Map) Build

func (m *Map) Build(ctx context.Context) error

Build performs a full scan → parse → rank pipeline. When cacheDir is set, first tries an incremental rebuild via git diff against the cached HEAD SHA. Falls through to full rebuild on any eligibility failure — correctness over speed. Safe for concurrent use.

func (*Map) BuiltAt

func (m *Map) BuiltAt() time.Time

BuiltAt returns the time of the last successful build, or zero time if never built.

func (*Map) Config added in v0.7.0

func (m *Map) Config() Config

Config returns the configuration this Map was created with.

func (*Map) Dirty

func (m *Map) Dirty()

Dirty marks the map as needing a rebuild by zeroing builtAt, bypassing the stale debounce. Use after code-changing tool calls.

func (*Map) FindSymbol added in v0.6.0

func (m *Map) FindSymbol(name, kind, file string) []SymbolMatch

FindSymbol searches the ranked symbol set for matches.

name:  required (empty → empty result). Matched in priority order:
       exact (100) > case-insensitive exact (75) > prefix (50) > contains (25).
kind:  optional filter; "" matches any. Matched case-insensitively against Symbol.Kind.
file:  optional substring filter against RankedFile.Path; "" matches any.

Results are sorted by Score desc, then the owning RankedFile.Score desc (tiebreaker), then File asc (stable tiebreaker). Safe for concurrent use.

func (*Map) LoadCache

func (m *Map) LoadCache(cacheDir string) bool

LoadCache loads a previously saved map from disk. Returns false if the cache is missing, corrupt, or for a different version.

func (*Map) LoadCacheIncremental added in v0.6.0

func (m *Map) LoadCacheIncremental(ctx context.Context, cacheDir string) (bool, []string)

LoadCacheIncremental attempts a fast-path rebuild. Returns (true, changedRel) when the cache is valid for incremental use and the caller should merge `changedRel` (relative paths of added+modified files; deletions handled via side channel). Returns (false, nil) for any of:

  • cache missing / corrupt / wrong version / wrong root
  • cache was written for a non-git root (GitRoot=false)
  • `git rev-parse HEAD` fails or returns empty
  • diff between LastSHA and HEAD fails (e.g., SHA pruned by rebase)
  • change set exceeds incrementalThreshold of total files

On (true, changedRel) the Map has been hydrated with the cached state and its mtimes map is populated. Deleted paths have already been removed from m.ranked. The caller is expected to re-parse changedRel, splice the results back in, re-rank, re-budget, and SaveCache.

func (*Map) Ranked added in v0.5.0

func (m *Map) Ranked() []RankedFile

Ranked returns the ranked file list built by Build. Returns nil if Build has not been called.

func (*Map) SaveCache

func (m *Map) SaveCache(cacheDir string) error

SaveCache writes the current map state to disk.

func (*Map) SetCacheDir

func (m *Map) SetCacheDir(dir string)

SetCacheDir enables disk caching. Build() will save to this directory.

func (*Map) Stale

func (m *Map) Stale() bool

Stale reports whether any tracked file has been modified since the last build. Uses file mtimes for fast checking. Also stale if Build has never been called. Debounced: returns false if last build was <30s ago.

func (*Map) String

func (m *Map) String() string

String returns the current formatted map output. Returns empty string if Build has not been called or produced no symbols.

func (*Map) StringCompact added in v0.7.0

func (m *Map) StringCompact() string

StringCompact returns the lean orientation output: path + exported symbol names only. No signatures, no godoc, no struct fields. Budget is applied using compactCost so more files fit vs. the enriched default (m.String()). Returns empty string if Build has not been called or produced no symbols.

func (*Map) StringDetail

func (m *Map) StringDetail() string

StringDetail returns the full detailed map output with signatures and struct fields.

func (*Map) StringLines

func (m *Map) StringLines() string

StringLines returns the source-line format showing actual code definitions.

func (*Map) StringVerbose

func (m *Map) StringVerbose() string

StringVerbose returns the full verbose map output (all symbols, no summarization).

func (*Map) StringXML

func (m *Map) StringXML() string

StringXML returns the structured XML format.

type PostflightCheck added in v0.10.0

type PostflightCheck struct {
	Clean     bool `json:"clean"`
	Convent   bool `json:"conventional"`
	TagLocal  bool `json:"tag_local"`
	TagRemote bool `json:"tag_remote"`
	Release   bool `json:"release"`
}

PostflightCheck records the result of each postflight verification. Checks that are not applicable (e.g. TagRemote when --push was not set) are set to true so callers can use postflightOK() without special-casing.

type PrepLowConf added in v0.11.0

type PrepLowConf struct {
	GroupID   string   `json:"group_id"`
	Files     []string `json:"files"`
	DiffSlice string   `json:"diff_slice"`
}

PrepLowConf is one group requiring LLM subject polish (capped at 3; diff_slice ≤500 chars).

type PrepPayload added in v0.11.0

type PrepPayload struct {
	Preflight       PrepPreflight    `json:"preflight"`
	ModeHint        string           `json:"mode_hint"` // "FULL" | "LOCAL"
	PrepToken       string           `json:"prep_token"`
	Status          string           `json:"status"` // "ready" | "needs_judgment" | "abort"
	AbortReason     string           `json:"abort_reason,omitempty"`
	Plan            []PrepPlanGroup  `json:"plan"`
	Review          []PrepReviewItem `json:"review"`
	LowConfSubjects []PrepLowConf    `json:"low_conf_subjects"`
	ReleaseRecipe   bool             `json:"release_recipe"`
	SessionRepos    []string         `json:"session_repos"`
	ReleaseGate     *PrepReleaseGate `json:"release_gate,omitempty"`
}

PrepPayload is the JSON document emitted by `repomap commit prep --json`.

type PrepPlanGroup added in v0.11.0

type PrepPlanGroup struct {
	Type       string   `json:"type"`
	Scope      string   `json:"scope"`
	Subject    string   `json:"subject"`
	Files      []string `json:"files"`
	Confidence float64  `json:"confidence"`
}

PrepPlanGroup is one consolidated commit in the plan.

func GroupsToPlan added in v0.11.0

func GroupsToPlan(groups []CommitGroup) []PrepPlanGroup

GroupsToPlan converts CommitGroups to PrepPlanGroups for the payload.

type PrepPreflight added in v0.11.0

type PrepPreflight struct {
	Branch    string `json:"branch"`
	Working   string `json:"working"`
	Remote    string `json:"remote"`
	Unpushed  string `json:"unpushed"`
	LatestTag string `json:"latest_tag"`
	GHAuth    string `json:"gh_auth"`
}

PrepPreflight mirrors the cpt.md context block fields.

type PrepReleaseGate added in v0.11.0

type PrepReleaseGate struct {
	Applied []any `json:"applied"`
	BuildOK bool  `json:"build_ok"`
}

PrepReleaseGate holds the result of running the release gate.

func RunReleaseGate added in v0.11.0

func RunReleaseGate(repoRoot string) *PrepReleaseGate

RunReleaseGate shells out to release-gate.sh and returns a summary. build_ok=true when the script exits 0 or is absent.

type PrepReviewItem added in v0.11.0

type PrepReviewItem struct {
	ID            string `json:"id"`
	File          string `json:"file"`
	Line          int    `json:"line"`
	Snippet       string `json:"snippet"`
	Detail        string `json:"detail"`
	DefaultAction string `json:"default_action"`
	ByteOffset    int    `json:"byte_offset"`
	ByteLength    int    `json:"byte_length"`
}

PrepReviewItem is one finding that needs LLM judgment (capped at 5; snippet ≤200 chars).

func BuildReviewItems added in v0.11.0

func BuildReviewItems(findings []Finding, maxItems int) []PrepReviewItem

BuildReviewItems extracts REVIEW findings into PrepReviewItems, capped at maxItems.

type PrepState added in v0.11.0

type PrepState struct {
	Analysis      *CommitAnalysis  `json:"analysis"`
	Plan          []CommitGroup    `json:"plan"`
	SessionRepos  []string         `json:"session_repos"`
	ReleaseRecipe bool             `json:"release_recipe"`
	ReleaseGate   *PrepReleaseGate `json:"release_gate,omitempty"`
	RepoRoot      string           `json:"repo_root"`
}

PrepState is persisted to tmpdir and loaded by `commit finish`.

func LoadPrepState added in v0.11.0

func LoadPrepState(token string) (*PrepState, error)

LoadPrepState reads a persisted PrepState from tmpdir by token.

type RankedFile

type RankedFile struct {
	*FileSymbols
	Score       int      // higher = more important
	Tag         string   // e.g. "entry", ""
	DetailLevel int      // set by BudgetFiles: -1=omit, 0=header, 1=summary, 2=symbols, 3=symbols+fields
	ImportedBy  int      // number of files that import this file's package
	DependsOn   int      // number of internal imports (fan-out coupling proxy)
	Untested    bool     // true if package lacks test coverage
	Boundaries  []string `json:"boundaries,omitempty"` // semantic boundary labels, e.g. ["HTTP", "Postgres"]
}

RankedFile is a FileSymbols with an importance score.

func BudgetFiles

func BudgetFiles(ranked []RankedFile, maxTokens int, cfg *BlocklistConfig) []RankedFile

func BudgetFilesCompact added in v0.7.0

func BudgetFilesCompact(ranked []RankedFile, maxTokens int, cfg *BlocklistConfig) []RankedFile

BudgetFilesCompact assigns DetailLevel to each RankedFile using compactCost estimates, matching the lean orientation renderer (path + exported symbol names only). cfg may be nil — nil means no file-level overrides (backward compatible). When maxTokens is 0, all files get DetailLevel 2 (unlimited mode).

This is separate from BudgetFiles (which uses enrichedCost) so compact-mode callers get accurate budgeting without rewriting the enriched budget loop.

func RankFiles

func RankFiles(files []*FileSymbols) []RankedFile

RankFiles scores and sorts files by importance. Returns files sorted by score descending, then by path ascending for ties.

type RefsQuerier added in v0.7.0

type RefsQuerier interface {
	Refs(ctx context.Context, file string, line int, symbol string) ([]Location, error)
}

RefsQuerier abstracts the refs backend so tests can inject a fake and callers can choose between in-process gopls and exec-based lspq.

func DefaultQuerier added in v0.7.0

func DefaultQuerier() RefsQuerier

DefaultQuerier returns the lspq exec-based querier (legacy fallback).

func NewInProcessQuerier added in v0.7.0

func NewInProcessQuerier(mgr *lsp.Manager) RefsQuerier

NewInProcessQuerier returns a RefsQuerier that uses an already-running LSP Manager. The caller owns the Manager lifecycle (Shutdown).

type RemoteInfo

type RemoteInfo struct {
	OriginURL  string `json:"origin_url,omitempty"`
	Visibility string `json:"visibility"` // public | private | none | unknown
}

RemoteInfo records the origin remote and its visibility class. Used to pick the strictness of default_action on REVIEW findings: a personal repo with no remote gets lenient defaults; github.com/* public repos get strict defaults.

type RepoStatus added in v0.11.0

type RepoStatus struct {
	Repo  string   `json:"repo"`
	Dirty []string `json:"dirty"` // lines from git status --porcelain; empty = clean
}

RepoStatus records the porcelain status of a single repo.

func CrossRepoVerify added in v0.11.0

func CrossRepoVerify(ctx context.Context, sessionRepos []string) (results []RepoStatus, allClean bool)

CrossRepoVerify checks git porcelain status across multiple repos.

type ReviewDecision added in v0.11.0

type ReviewDecision struct {
	ID          string `json:"id"`          // matches Finding identity (file+line)
	Verdict     string `json:"verdict"`     // "safe" | "unsafe"
	Replacement string `json:"replacement"` // applied when verdict="unsafe"
}

ReviewDecision is one LLM verdict for a REVIEW finding.

type SecretsSummary

type SecretsSummary struct {
	Clean            bool `json:"clean"`             // no FLAG findings (deterministic)
	GitleaksFindings int  `json:"gitleaks_findings"` // total flagged by gitleaks
	ReviewCount      int  `json:"review_count"`      // findings originally classed REVIEW (pre-adjudication)
	FlagCount        int  `json:"flag_count"`        // deterministic findings (auto-fixable)
	FixCount         int  `json:"fix_count"`         // findings with default_action=fix (auto-handled)
	SafeCount        int  `json:"safe_count"`        // findings with default_action=safe (auto-cleared)
	AmbiguousCount   int  `json:"ambiguous_count"`   // findings with default_action=review (need LLM judgment)
}

SecretsSummary is a compact gate for Phase 1 in the agent: if Clean is true and AmbiguousCount is zero, the agent can skip LLM review entirely — default_action handles every finding deterministically.

type Symbol

type Symbol struct {
	Name        string   // e.g. "Agent", "New", "Run"
	Kind        string   // "function", "method", "struct", "interface", "constant", "variable", "type", "class", "enum"
	Signature   string   // e.g. "(ctx, provider, opts) *Agent" — params + return, no func keyword
	Receiver    string   // e.g. "*Agent" — methods only, empty for functions
	Exported    bool     // true if the symbol is exported (uppercase first letter)
	Dead        bool     // true when exported but no file in the scanned tree imports this file
	Line        int      // 1-based source line number (0 = unknown)
	EndLine     int      // 1-based end line number (0 = unknown, same as Line when unavailable)
	ParamCount  int      // parameter count (funcs/methods); method count (interfaces); 0 otherwise
	ResultCount int      // return value count (funcs/methods only); 0 otherwise
	Implements  []string // interface names this type implements (structs only; Go-module-local)
	Doc         string   `json:"doc,omitempty"` // first-sentence of the Go doc comment (empty if none)
}

Symbol represents a single extracted symbol from a source file.

func (Symbol) HasFields

func (s Symbol) HasFields() bool

HasFields reports whether the symbol is a struct or interface with populated field/method info in its Signature.

func (Symbol) LineSpan

func (s Symbol) LineSpan() int

LineSpan returns the number of lines the symbol spans, or 0 if unknown.

type SymbolCallers added in v0.7.0

type SymbolCallers map[string][]Location

SymbolCallers maps "file:symbol" -> caller locations.

func LoadCallsCache added in v0.7.0

func LoadCallsCache(cacheDir, hash string) SymbolCallers

LoadCallsCache loads a cached SymbolCallers map from disk. Returns nil if the cache is missing, corrupt, or version-mismatched.

type SymbolMatch added in v0.6.0

type SymbolMatch struct {
	File        string  // path relative to root
	Symbol      Symbol  // the matching symbol
	Score       float64 // relevance score: 100=exact, 75=exact-CI, 50=prefix, 25=contains
	DetailLevel int     // copied from the owning RankedFile (for budget-aware callers)
}

SymbolMatch is a single hit from FindSymbol. Results are sorted by Score descending; use the File+Symbol.Line pair for a stable identifier.

type VerifyResult added in v0.11.0

type VerifyResult struct {
	Mode              string `json:"mode"` // "local" | "full"
	OK                bool   `json:"ok"`
	LastCommitSubject string `json:"last_commit_subject,omitempty"` // local mode
	Tag               string `json:"tag,omitempty"`                 // full mode
	ReleaseURL        string `json:"release_url,omitempty"`         // full mode
	FailureDetail     string `json:"failure_detail,omitempty"`
}

VerifyResult records the outcome of a self-verify run.

func SelfVerify added in v0.11.0

func SelfVerify(ctx context.Context, repoRoot, mode string) (VerifyResult, error)

SelfVerify performs mode-aware verification of the current repo.

Directories

Path Synopsis
cmd
repomap command
internal
cli
lsp
Package lsp provides an LSP client for code intelligence.
Package lsp provides an LSP client for code intelligence.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL