gitctx

Documentation

Index

• type CommitterInfo
• type GitContext
  • func Collect(scanPath string) *GitContext

Types

type CommitterInfo

type CommitterInfo struct {
	Name  string `json:"name"`
	Email string `json:"email"`
	Count int    `json:"count"`
}

CommitterInfo describes a committer with their commit count.

type GitContext

type GitContext struct {
	RemoteURLs       []string        `json:"remoteUrls"`
	CurrentBranch    string          `json:"currentBranch"`
	CurrentCommit    string          `json:"currentCommit"`
	RecentCommitters []CommitterInfo `json:"recentCommitters"`
	RepoRootPath     string          `json:"repoRootPath"`
	IsDirty          bool            `json:"isDirty"`
}

GitContext holds repository metadata collected via go-git.

func Collect

func Collect(scanPath string) *GitContext

Collect gathers git context from the repository containing scanPath. Returns nil if scanPath is not inside a git repository.