Documentation
¶
Index ¶
- func AtLine(doc *parser.Document, line int)
- func ChangedSince(doc *parser.Document, changed map[int]bool, ref string)
- func ExpandSection(doc *parser.Document, name string)
- func FilteredTree(doc *parser.Document, filter string)
- func MultiTree(docs []*parser.Document, dirName string)
- func RefsTree(docs []*parser.Document, dirName string)
- func SearchResults(docs []*parser.Document, query string)
- func Tree(doc *parser.Document)
- func TypeFilter(doc *parser.Document, kindName string)
- func TypeFilterFiltered(doc *parser.Document, kindName, lang, variant string)
- type SearchResult
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AtLine ¶ added in v0.3.0
AtLine answers "what's at line N?" It finds the tightest containing node in the typed AST and prints its kind, location, containing section breadcrumb, and a short preview. Useful when an agent has a line number from elsewhere (a grep hit, a diff, an error) and needs to know what construct lives there.
func ChangedSince ¶ added in v0.3.0
ChangedSince renders the sections and notables that intersect any line in `changed`. It's the CLI answer to "what changed in these docs since ref X?" — each hit shows its breadcrumb and the specific constructs that sit on changed lines.
func ExpandSection ¶
ExpandSection shows full content of a section
func FilteredTree ¶
FilteredTree shows only sections matching the filter
func MultiTree ¶
MultiTree renders multiple documents as a combined directory view with aggregated inventory summary at the top and a per-file one-liner that surfaces each file's most signal-dense notables.
func SearchResults ¶ added in v0.2.0
SearchResults searches all docs for sections matching the query and renders results
func TypeFilter ¶ added in v0.3.0
TypeFilter drills down into a single node kind across the whole document. Equivalent to TypeFilterFiltered with no sub-filter.
func TypeFilterFiltered ¶ added in v0.3.0
TypeFilterFiltered narrows the --type view further by an optional --lang (for code blocks) or --kind (for callout variants). Unmatched sub-filters are silently ignored when the kind doesn't support them.
Types ¶
type SearchResult ¶ added in v0.2.0
type SearchResult struct {
Filename string
Path string // e.g. "endpoints > Ban Member"
Section *parser.Section
}
SearchResult holds a matched section with its file context
func FindSearchResults ¶ added in v0.3.1
func FindSearchResults(docs []*parser.Document, query string) []SearchResult
FindSearchResults returns sections matching query using the same title, content, and typed-AST matching as the human renderer.
Source Files