starindex

type Index ¶

type Index struct {
	Files  []IndexedFile
	Totals IndexTotals
}

Index holds the index results for all captured files.

type IndexTotals ¶

type IndexTotals struct {
	FileCount, Functions, Loads, Globals int
	LOC, SLOC, Comments, Blanks          int
}

IndexTotals aggregates index counts across all files.

type IndexedFile ¶

type IndexedFile struct {
	Path                        string
	Functions                   []IndexedFunction
	Loads                       []IndexedLoad
	Globals                     []IndexedGlobal
	LOC, SLOC, Comments, Blanks int
}

IndexedFile holds the index results for a single file.

type IndexedFunction ¶

type IndexedFunction struct {
	Name         string
	Line         int
	Params       int
	HasDocstring bool
	Docstring    string
}

IndexedFunction describes a function definition found in a Starlark file.

type IndexedGlobal ¶

type IndexedGlobal struct {
	Name string
	Line int
}

IndexedGlobal describes a top-level assignment found in a Starlark file.

type IndexedLoad ¶

type IndexedLoad struct {
	Module string
	Names  []string
	Line   int
}

IndexedLoad describes a load statement found in a Starlark file.

type Provider ¶

type Provider struct {
	op.ProviderBase
	Root string
}

Provider performs AST-based indexing of Starlark source files.

+devlore:access=immediate

func NewProvider(ctx op.Context) *Provider

func (p *Provider) IndexFiles(files []string, withDocstrings, withGlobals bool) (*Index, error)