dashboard

Documentation

Overview

Package dashboard collects Git repository data for the HTML dashboard.

Package dashboard collects Git repository data for the HTML dashboard.

Package dashboard collects Git repository data for the HTML dashboard.

Package dashboard provides data collection and output for the HTML dashboard.

Index

• func Collect(opts CollectOptions) (model.DashboardData, error)
• func Summary(path string) string
• func WriteHTML(outDir string, data model.DashboardData) (string, error)
• func WriteJSON(outDir string, data model.DashboardData) (string, error)
• type CollectOptions

Functions

func Collect

func Collect(opts CollectOptions) (model.DashboardData, error)

Collect gathers all repository data into a single DashboardData struct.

func Summary

func Summary(path string) string

Summary returns a formatted summary line for a written file.

func WriteHTML

func WriteHTML(outDir string, data model.DashboardData) (string, error)

WriteHTML writes the self-contained HTML dashboard with embedded data.

func WriteJSON

func WriteJSON(outDir string, data model.DashboardData) (string, error)

WriteJSON writes dashboard data to a JSON file.

Types

type CollectOptions

type CollectOptions struct {
	RepoPath string
	Limit    int
	Since    string
	NoMerges bool
}

CollectOptions holds user-facing flags for data collection.