builder

Documentation

Index

• type ProgressFunc
• type Result
  • func Build(projectDir string) (*Result, error)
  • func BuildWithProgress(projectDir string, progress ProgressFunc) (*Result, error)

Types

type ProgressFunc

type ProgressFunc func(step string, current, total int)

ProgressFunc is called with (step description, current, total). current=0,total=0 means indeterminate.

type Result

type Result struct {
	SessionCount int
	CommitCount  int
	LinkedCount  int
	EntryCount   int
	ParseCached  bool
	LinkCached   bool
}

Result holds the outcome of a build.

func Build

func Build(projectDir string) (*Result, error)

Build runs parse + link for the given project directory. Uses cache to skip work when nothing changed.

func BuildWithProgress

func BuildWithProgress(projectDir string, progress ProgressFunc) (*Result, error)

BuildWithProgress runs parse + link with optional progress reporting.