report

package

v1.3.5 Latest Latest Go to latest Published: Jul 5, 2018 License: MIT Imports: 15 Imported by: 2

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 BlockForVal(val, max int) string

BlockForVal determines the correct block to return for a value

func CommitSummary(projects []ProjectCommits, options OutputOptions) (string, error)

CommitSummary returns the commit summary report

func Commits(projects []ProjectCommits, options OutputOptions) (string, error)

Commits returns the commits report

func Files(projects []ProjectCommits, options OutputOptions) (string, error)

Files returns the files report

func ProjectSummary(projects []ProjectCommits, options OutputOptions) (string, error)

ProjectSummary returns the project summary report

func Status(n note.CommitNote, options OutputOptions, projPath ...string) (string, error)

Status returns the status report

func Timeline(projects []ProjectCommits, options OutputOptions) (string, error)

Timeline returns the time spent by hour

func TimelineCommits(projects []ProjectCommits, options OutputOptions) (string, error)

TimelineCommits returns the number commits by hour

type OutputOptions struct {
	TotalOnly    bool
	LongDuration bool
	FullMessage  bool
	TerminalOff  bool
	Color        bool
	Limit        int
}

OutputOptions contains cli options for reporting

type ProjectCommits struct {
	Path    string
	Commits []string
}

ProjectCommits contains a project's directory path and commit ids