stats

Documentation

Index

• type Finding
• type Report
  • func Build(found todos.ToDos, now time.Time) Report

Types

type Finding

type Finding struct {
	Text          string    `json:"text"`
	Phrase        string    `json:"phrase"`
	FilePath      string    `json:"file_path"`
	Line          int       `json:"line"`
	Author        string    `json:"author"`
	AuthorEmail   string    `json:"author_email"`
	AuthorTime    time.Time `json:"author_time"`
	IntroducedSHA string    `json:"introduced_sha"`
	AgeBucket     string    `json:"age_bucket"`
}

Finding is a compact stats view of a current finding.

type Report

type Report struct {
	Total       int            `json:"total"`
	ByPhrase    map[string]int `json:"by_phrase"`
	ByAgeBucket map[string]int `json:"by_age_bucket"`
	ByDirectory map[string]int `json:"by_directory"`
	Oldest      []Finding      `json:"oldest"`
}

Report summarizes current findings with Git-derived history.

func Build

func Build(found todos.ToDos, now time.Time) Report

Build groups current findings into a deterministic stats report.