report

Documentation

Index

• func BlockForVal(val, max int) string
• func CommitSummary(projects []ProjectCommits, options OutputOptions) (string, error)
• func Commits(projects []ProjectCommits, options OutputOptions) (string, error)
• func Files(projects []ProjectCommits, options OutputOptions) (string, error)
• func ProjectSummary(projects []ProjectCommits, options OutputOptions) (string, error)
• func Status(n note.CommitNote, options OutputOptions, projPath ...string) (string, error)
• func Timeline(projects []ProjectCommits, options OutputOptions) (string, error)
• func TimelineCommits(projects []ProjectCommits, options OutputOptions) (string, error)
• type OutputOptions
• type ProjectCommits

Functions

func BlockForVal

func BlockForVal(val, max int) string

BlockForVal determines the correct block to return for a value

func CommitSummary

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

CommitSummary returns the commit summary report

func Commits

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

Commits returns the commits report

func Files

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

Files returns the files report

func ProjectSummary

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

ProjectSummary returns the project summary report

func Status

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

Status returns the status report

func Timeline

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

Timeline returns the time spent by hour

func TimelineCommits

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

TimelineCommits returns the number commits by hour

Types

type OutputOptions

type OutputOptions struct {
	TotalOnly    bool
	LongDuration bool
	FullMessage  bool
	TerminalOff  bool
	AppOff       bool
	Color        bool
	Limit        int
	Subdir       string
	AutoLog      string
}

OutputOptions contains cli options for reporting

type ProjectCommits

type ProjectCommits struct {
	Path    string
	Commits []string
}

ProjectCommits contains a project's directory path and commit ids