analyzer

package

v0.0.0-...-ba8ab7f Latest Latest Go to latest Published: Feb 20, 2020 License: MIT Imports: 8 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

View Source

const (
	// ReportFormatterJSON selects the JSON formatter.
	ReportFormatterJSON string = "json"
)

This section is empty.

func GenerateJSONReport(reportDirectory string, stats GitStats) error

GenerateJSONReport generates a report in JSON format for the Git stats.

type AnalysisOptions struct {
	Branch          string
	Path            string
	ReportFormatter string
}

AnalysisOptions controls how the analysis is performed on the repository.

type GitStats struct {
	Branch       string
	CommitCount  int
	OldestCommit time.Time
	LatestCommit time.Time
}

GitStats is a collection of stats about the Git repository itself.

func AnalyzeRepository(options AnalysisOptions) (GitStats, error)

AnalyzeRepository analyzes the repository at the given path and collects stats.

type ReportFormatter = func(reportDirectory string, stats GitStats) error

ReportFormatter is a function responsible for generating a report based on Git stats.

func NewReportFormatter(formatterType string) (ReportFormatter, error)

NewReportFormatter selects the appropriate formatter.