cmd

Documentation

Index

• Variables
• func BuildSliceTreeNode[T any](list *[]pterm.LeveledListItem, field reflect.Value, level int, label string, ...)
• func BuildTreeMapNode(list *[]pterm.LeveledListItem, field reflect.Value, level int, markdown bool)
• func DigIntoObject[T any](list *[]pterm.LeveledListItem, field reflect.Value, level int, label string, ...)
• func Execute(version, commit, date string)
• func ExtractGithubDetailsFromURL(url *url.URL) (string, string, string, error)
• func FlattenHistoricalReport(report *model.HistoricalReport) *model.FlatHistoricalReport
• func FlattenReport(report *model.Report) *model.FlatReport
• func GetConsoleCommand() *cobra.Command
• func GetHTMLReportCommand() *cobra.Command
• func GetReportCommand() *cobra.Command
• func GetSummaryCommand() *cobra.Command
• func PrintBanner()
• func PrintHowToUse(command string)
• func RunGitHistoryHTMLReport(gitPath, filePath string, latest, useCDN bool, ...) ([]byte, []*model.Report, []error)
• func RunGithubHistoryHTMLReport(username, repo, filePath string, latest, useCDN, embeddedMode bool, ...) ([]byte, []*model.Report, []error)
• func RunLeftRightHTMLReport(left, right string, useCDN bool, progressChan chan *model.ProgressUpdate, ...) ([]byte, []error)
• func RunLeftRightHTMLReportViaString(left, right string, useCDN, embedded bool, ...) ([]byte, []error)

Variables

var (
	Version string
	Commit  string
	Date    string
)

Functions

func BuildSliceTreeNode

func BuildSliceTreeNode[T any](list *[]pterm.LeveledListItem, field reflect.Value, level int, label string, markdown bool)

func BuildTreeMapNode

func BuildTreeMapNode(list *[]pterm.LeveledListItem, field reflect.Value, level int, markdown bool)

func DigIntoObject

func DigIntoObject[T any](list *[]pterm.LeveledListItem, field reflect.Value, level int, label string, markdown bool)

func Execute

func Execute(version, commit, date string)

func ExtractGithubDetailsFromURL

func ExtractGithubDetailsFromURL(url *url.URL) (string, string, string, error)

func FlattenHistoricalReport

func FlattenHistoricalReport(report *model.HistoricalReport) *model.FlatHistoricalReport

func FlattenReport

func FlattenReport(report *model.Report) *model.FlatReport

func GetConsoleCommand

func GetConsoleCommand() *cobra.Command

func GetHTMLReportCommand

func GetHTMLReportCommand() *cobra.Command

func GetReportCommand

func GetReportCommand() *cobra.Command

func GetSummaryCommand

func GetSummaryCommand() *cobra.Command

func PrintBanner

func PrintBanner()

func PrintHowToUse

func PrintHowToUse(command string)

func RunGitHistoryHTMLReport

func RunGitHistoryHTMLReport(gitPath, filePath string, latest, useCDN bool,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError, base string, remote bool, globalRevisions bool, limit int, limitTime int) ([]byte, []*model.Report, []error)

func RunGithubHistoryHTMLReport

func RunGithubHistoryHTMLReport(username, repo, filePath string, latest, useCDN, embeddedMode bool,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError, limit int, limitTime int, base string, remote bool) ([]byte, []*model.Report, []error)

func RunLeftRightHTMLReport

func RunLeftRightHTMLReport(left, right string, useCDN bool,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError, base string, remote bool) ([]byte, []error)

func RunLeftRightHTMLReportViaString

func RunLeftRightHTMLReportViaString(left, right string, useCDN, embedded bool,
	progressChan chan *model.ProgressUpdate, errorChan chan model.ProgressError, base string, remote bool) ([]byte, []error)