repopolicy

type Block struct {
	File      string
	StartLine int
	StartCol  int
	EndLine   int
	EndCol    int
	Stmts     int
	Count     int
}

type CoverageInput struct {
	// Profile is the merged unit and executable coverage.
	Profile *CoverageProfile
	// Read returns the repository's source files.
	Read SourceReader
	// Module is the module path that prefixes the profile's file names.
	Module string
	// GOOS is the operating system the profile was measured on.
	GOOS string
	// Entries are the registry entries to apply; entries of other tools are ignored.
	Entries []*Entry
	// Threshold is the minimum reachable coverage in percent.
	Threshold float64
}

type CoverageProfile struct {
	Mode   string
	Blocks []Block
}

type CoverageResult struct {
	// Packages lists the adjusted coverage of each package, ordered by name.
	Packages []PackageCoverage
	// Problems lists registry entries that no longer describe the profile and other gate failures.
	Problems []string
	// NotEvaluated lists entries skipped because they apply to another operating system.
	NotEvaluated []string
	// Raw is the coverage of every statement, before any exclusion.
	Raw PackageCoverage
	// Adjusted is the coverage of the reachable statements: the statements left after exclusions.
	Adjusted PackageCoverage
	// Excluded is the number of statements removed by registry entries.
	Excluded int
}

type DirectiveViolation struct {
	File    string
	Kind    string
	Comment string
	Line    int
}

type Entry struct {
	// Setting is the dotted .golangci.yml path of the list a setting-item entry extends.
	Setting string `yaml:"setting,omitempty"`
	// Operator is the mutation operator of a mutation entry, e.g. CONDITIONALS_BOUNDARY.
	Operator string `yaml:"operator,omitempty"`
	// Anchor is the exact trimmed source line at which an excluded block or mutant starts.
	Anchor string `yaml:"anchor,omitempty"`
	// Function names the function a coverage entry applies to: Name or Receiver.Name.
	Function string `yaml:"function,omitempty"`
	// GOOS restricts an entry to one operating system; empty applies everywhere.
	GOOS string `yaml:"goos,omitempty"`
	// Source is an optional regular expression matching the diagnosed source line.
	Source string `yaml:"source,omitempty"`
	// Message is a regular expression matching the diagnostic text of a diagnostic exclusion.
	Message string `yaml:"message,omitempty"`
	// Path is one repository file, as a slash-separated path.
	Path string `yaml:"path,omitempty"`
	// Linter names the linter an entry applies to.
	Linter string `yaml:"linter,omitempty"`
	// Effect is how a golangci-lint entry reaches .golangci.yml.
	Effect string `yaml:"effect,omitempty"`
	// RetainedProperty states what stays protected despite the exception.
	RetainedProperty string `yaml:"retained_property"`
	// Kind is the justification kind.
	Kind string `yaml:"kind"`
	// Tool is one of the Tool constants.
	Tool string `yaml:"tool"`
	// ID is the stable identifier.
	ID string `yaml:"id"`
	// Rationale is the YAML comment attached above the entry; it is not a YAML field.
	Rationale string `yaml:"-"`
	// Values are the exact items a setting-item entry adds.
	Values []string `yaml:"values,omitempty"`
	// ConflictsWith lists enabled linters that cannot be satisfied together with the excepted rule.
	ConflictsWith []string `yaml:"conflicts_with,omitempty"`
	// SupersededBy lists enabled linters that already enforce the excepted rule.
	SupersededBy []string `yaml:"superseded_by,omitempty"`
	// Column is the exact physical byte column of a mutation's operator token.
	Column *int `yaml:"column,omitempty"`
	// Statuses lists the judged mutation outcomes the entry accepts: lived or timed-out.
	Statuses []string `yaml:"statuses,omitempty"`
}

type ForeignSource struct {
	TestInputs     ForeignTestInputs `json:"test_inputs,omitzero"`
	Root           string            `json:"root"`
	Module         string            `json:"module"`
	Version        string            `json:"version"`
	Repository     string            `json:"repository"`
	Revision       string            `json:"revision"`
	SourceArtifact string            `json:"source_artifact"`
	SourceSHA256   string            `json:"source_sha256"`
	ModuleSum      string            `json:"module_sum"`
	GoModSum       string            `json:"go_mod_sum"`
	Patch          string            `json:"patch"`
	PatchSHA256    string            `json:"patch_sha256"`
	License        string            `json:"license"`
	Completeness   string            `json:"completeness"`
}

type ForeignTestInputs struct {
	URL    string `json:"url"`
	SHA256 string `json:"sha256"`
}

type Issue struct {
	Linter string
	File   string
	Text   string
	Source string
	Line   int
}

type LinkedModule struct {
	Path    string
	Version string
	Dir     string
}

type LinterInfo struct {
	Name       string `json:"name"`
	Deprecated bool   `json:"deprecated"`
}

type Mutant struct {
	File               string
	Type               string
	Status             string
	DiscoveryStatus    string
	ExecutionReference string
	Line               int
	Column             int
}

type MutationReport struct {
	TerminationReason string
	Mutants           []Mutant
	Complete          bool
}

type MutationResult struct {
	// Counts maps each status to its number of mutants, including excluded and other-platform ones.
	Counts map[string]int
	// Problems lists the failures: survivors, timeouts, uncovered mutants, stale entries.
	Problems []string
	// Evaluated is the number of mutants judged: those in files compiled for the host platform.
	Evaluated int
	// OtherPlatform is the number of mutants in files not compiled for the host platform, which
	// only that platform's native run judges.
	OtherPlatform int
	// Accepted is the number of unfavourable mutants removed by registry entries.
	Accepted int
}

type PackageCoverage struct {
	Package string
	Total   int
	Covered int
}

type Registry struct {
	// Exceptions lists every exception to a quality gate.
	Exceptions []*Entry `yaml:"exceptions"`
	// CoverageThresholdPercent is the minimum reachable statement coverage.
	CoverageThresholdPercent float64 `yaml:"coverage_threshold_percent"`
	// Version is the registry format version.
	Version int `yaml:"version"`
}

type SourceBuildIdentity struct {
	Version string `json:"version"`
	Commit  string `json:"commit"`
	Date    string `json:"date"`
}

type SourceReader func(file string) ([]byte, error)