report

type AuditResponse ¶

type AuditResponse struct {
	Project   string
	Rubric    string
	FileScope string
	Coverage  *Coverage
	// DeadPatterns are ordered by ref then declared pattern string.
	DeadPatterns []DeadPattern
	// CoverageMap is nil when the map was not requested and a pointer to an
	// initialized (possibly empty) slice when it was, so requested-empty
	// survives serialization as [] while omitted stays absent through dd.
	CoverageMap *[]MapGroup
}

AuditResponse is the audit_coverage result: the assessed coverage of the project rubric over its full tracked tree, the dead territory patterns, and the optional per-file coverage map.

func AuditResponseFrom(project, rubric string, a coverage.Assessment, includeMap bool) *AuditResponse

type Coverage ¶

type Coverage struct {
	Assessed       bool
	Reason         string `dd:",+omitempty"`
	FileCounts     *FileCounts
	LocalQualities []QualityRef
	UncoveredFiles []string
	Exclusions     []Exclusion
}

Coverage is the wire object carried by every new review status, completed result, collect response, and audit result.

Assessed is true for a rubric assessment, including empty input and no-local-tier cases. Reason is omitted when assessed and carries ad_hoc otherwise. FileCounts is present only when assessed. array members are always arrays, never null: empty for not-assessed output, and empty for assessed output with nothing to report. a nil *Coverage on historical status and result DTOs means coverage information is unavailable; it must never be filled in from the current canon.

func CloneCoverage(in *Coverage) *Coverage

func CoverageFrom(a coverage.Assessment) *Coverage

type DeadPattern ¶

type DeadPattern struct {
	Quality QualityRef
	Pattern string
}

DeadPattern is a territory pattern that matches no file in the audited tree, attributed to the quality that declares it.

type Exclusion ¶

type Exclusion struct {
	Pattern string
	Files   []string
}

Exclusion pairs a declared exclusion pattern with all input files it matches, including files also reached by local qualities.

type FileCounts ¶

type FileCounts struct {
	Total     int
	Excluded  int
	Covered   int
	Uncovered int
}

FileCounts classifies the input files disjointly: excluded first, then covered, then uncovered. present only on assessed output.

type MapFile ¶

type MapFile struct {
	File              string
	Qualities         []QualityRef
	ExclusionPatterns []string
}

MapFile is one file's coverage map entry: the local qualities and exclusion patterns that reach it.

type MapGroup ¶

type MapGroup struct {
	Directory string
	Files     []MapFile
}

MapGroup groups coverage map entries by immediate parent directory, with "." for repo-root files. file-level differences within a directory are preserved.

type QualityRef ¶

type QualityRef struct {
	ID  string
	Ref string
}

QualityRef identifies a quality by its head id and its canon-relative ref.