report

type CSVReporter struct{}

type Explanation struct {
	// What the issue entails — a plain-language description of the finding.
	What string `json:"what"`
	// Impact — why it matters / the potential consequence if left unaddressed.
	Impact string `json:"impact"`
	// Fix — the recommended remediation.
	Fix string `json:"fix"`
}

type HTMLReporter struct{}

type JSONReporter struct{}

type Report struct {
	Seed         string          `json:"seed"`
	StartedAt    string          `json:"started_at"`
	FinishedAt   string          `json:"finished_at"`
	PagesCrawled int             `json:"pages_crawled"`
	Summary      Summary         `json:"summary"`
	Issues       []analyze.Issue `json:"issues"`
	// Notes carries human-readable advisories about the run itself (e.g. analyzers skipped
	// because of a conflicting option), not page findings. Omitted when empty.
	Notes []string `json:"notes,omitempty"`
	// Coverage reports whether the crawl reached every in-scope URL it found. When it didn't,
	// findings that depend on fetching a page (broken links especially) may be incomplete, and
	// the HTML report shows a banner saying so. A pointer so re-rendering an older JSON report
	// that predates this field doesn't falsely claim partial coverage.
	Coverage *crawler.Coverage `json:"coverage,omitempty"`
	// SiteMap is the crawled site as a tree, annotated with the issues found on each page. It
	// powers the "Site map" tab of the HTML report and the optional sitemap.xml side output.
	// It is serialized so a JSON report is a complete artifact that `gocrawl render` can turn
	// back into HTML (including the Site map tab) without recrawling.
	SiteMap *sitemapgen.Map `json:"site_map,omitempty"`
}

type Reporter interface {
	Write(w io.Writer, r *Report) error
}

type Summary struct {
	BySeverity map[string]int `json:"by_severity"`
	ByAnalyzer map[string]int `json:"by_analyzer"`
	ByStatus   map[string]int `json:"pages_by_status"`
}