starcode

package

v0.1.0-dev.20260312170020 Latest Latest Go to latest Published: Mar 12, 2026 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/NobleFactor/devlore-cli

Links

Open Source Insights

Documentation ¶

Overview ¶

Package starcode provides Starlark source file capture with glob pattern matching, .gitignore awareness, and optional .bzl file inclusion.

Index ¶

type Provider
- func (p *Provider) Capture(pattern string, gitignore, includeBzl bool) (*Sources, error)
type Sources

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Provider ¶

type Provider struct {
	op.ProviderBase
	Root string
}

Provider performs Starlark source capture.

+devlore:access=immediate

func (*Provider) Capture ¶

func (p *Provider) Capture(pattern string, gitignore, includeBzl bool) (*Sources, error)

Capture collects Starlark source files matching the given pattern. If gitignore is true, files excluded by .gitignore rules are skipped. If includeBzl is true, .bzl files are included alongside .star files.

+devlore:defaults gitignore=true,includeBzl=true

type Sources ¶

type Sources struct {
	Root  string   // absolute root directory
	Files []string // absolute paths, sorted
}

Sources holds a captured set of Starlark source files.

func (*Sources) Analyze ¶

func (s *Sources) Analyze(cfg staranalysis.AnalysisConfig) (*staranalysis.AnalysisReport, error)

Analyze performs a combined analysis of all captured files.

+devlore:struct_param cfg=staranalysis.AnalysisConfig

func (*Sources) Count ¶

func (s *Sources) Count() int

Count returns the number of captured files.

func (*Sources) Index ¶

func (s *Sources) Index(withDocstrings, withGlobals bool) (*starindex.Index, error)

Index parses all captured files and extracts functions, loads, and globals. If withDocstrings is true, function docstrings are extracted. If withGlobals is true, top-level assignments are captured.

+devlore:defaults withDocstrings=true,withGlobals=true

func (*Sources) Paths ¶

func (s *Sources) Paths() []string

Paths returns the file paths relative to Root.

func (*Sources) Stats ¶

func (s *Sources) Stats(withBytes, withLOC bool) (*starstats.Stats, error)

Stats computes line and byte statistics for all captured files. If withBytes is true, byte counts are included. If withLOC is true, line counts (LOC, SLOC, comments, blanks) are included.

+devlore:defaults withBytes=true,withLOC=true

Source Files ¶

View all Source files

provider.go

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