Documentation
¶
Index ¶
- func FileID(path string) string
- func FormatNeighbors(idx *Index, id string, depth, limit int) string
- func FormatSummary(idx *Index, maxSymbols int) string
- func FormatSymbolContext(idx *Index, id string, callers, callees bool) string
- func FormatSymbolList(symbols []*Symbol) string
- func ImportID(source string) string
- func NameID(name string) string
- type BuildOptions
- type Builder
- type Cache
- type Edge
- type File
- type Graph
- type Import
- type Index
- type LanguageAdapter
- type Reference
- type RelationKind
- type Symbol
- type SymbolKind
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func FormatSummary ¶
func FormatSymbolContext ¶
func FormatSymbolList ¶
Types ¶
type BuildOptions ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
func NewBuilder ¶
func NewBuilder() *Builder
type Cache ¶
type Cache struct {
// contains filtered or unexported fields
}
func DefaultCache ¶
func DefaultCache() *Cache
type Index ¶
func BuildCached ¶
func BuildCached(ctx context.Context, opts BuildOptions) (*Index, error)
func (*Index) SortedFiles ¶
func (*Index) SortedSymbols ¶
type LanguageAdapter ¶
type LanguageAdapter struct {
ID string
Extensions []string
Language *treesitter.Language
DefinitionQuery string
ImportQuery string
ReferenceQuery string
}
func AdapterForPath ¶
func AdapterForPath(path string, adapters []LanguageAdapter) (LanguageAdapter, bool)
func BuiltinLanguages ¶
func BuiltinLanguages() []LanguageAdapter
type Reference ¶
type Reference struct {
Name string
Kind RelationKind
File string
StartByte uint
EndByte uint
}
type RelationKind ¶
type RelationKind string
const ( RelDefines RelationKind = "defines" RelContains RelationKind = "contains" RelImports RelationKind = "imports" RelCalls RelationKind = "calls" RelReferences RelationKind = "references" RelCallsName RelationKind = "calls_name" RelReferenceName RelationKind = "references_name" )
type Symbol ¶
type SymbolKind ¶
type SymbolKind string
const ( SymbolFunction SymbolKind = "function" SymbolMethod SymbolKind = "method" SymbolClass SymbolKind = "class" SymbolStruct SymbolKind = "struct" SymbolInterface SymbolKind = "interface" SymbolType SymbolKind = "type" SymbolVariable SymbolKind = "variable" SymbolConstant SymbolKind = "constant" )
Source Files
¶
Click to show internal directories.
Click to hide internal directories.