lib

package

v0.0.0-...-aceff83 Latest Latest Go to latest Published: Sep 8, 2017 License: MIT Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func FindRepoRoot() (string, error)

func MakeTempCopyOfRepo(repoPath string, tempPath string) (*git.Repository, error)

Clone the repo into a temp folder

func OpenRepoInMemory(path string) (*git.Repository, error)

Clone the repo in memory

func WalkUpRepoHistory(repo *git.Repository, observer HistoryObserver) error

type GitMetric interface {
	MetricCalculator
	GraphRenderer
	IsReadOnly() bool
}

type GraphRenderer interface {
	RenderGraph(samples []Sample, output io.Writer) error
}

type HistoryObserver func(*object.Commit, *git.Worktree) error

type MetricCalculator interface {
	CalculateMetrics(repo *git.Worktree) (map[string]int, error)
}

type Options struct {
	CommitLimit int
	TimeLimit   time.Time
}

func (o Options) WalkUpRepoHistory(repo *git.Repository, observer HistoryObserver) error

type Sample struct {
	Commit       *object.Commit
	Measurements map[string]int
}

func CalculateMetrics(repo *git.Repository, m MetricCalculator) ([]Sample, error)