Help us shape the future of Go! Take the 2026 Go Developer Survey

report

package
v0.2.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 23, 2026 License: Apache-2.0 Imports: 8 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Markdown

func Markdown(r Report, full bool) string

Markdown keeps the report short (about 150 lines) unless full is true.

Types

type Claim

type Claim struct {
	Quote    string `json:"quote"`
	File     string `json:"file"`
	Verified bool   `json:"verified"`
}

type Flag

type Flag struct {
	ID       string `json:"id"`
	Severity string `json:"severity"`
	Rule     string `json:"rule"`
	Location string `json:"location"`
	Message  string `json:"message"`
	Reason   string `json:"suppress_reason,omitempty"`
}

type Input

type Input struct {
	Change      model.Change
	Hunks       []model.Hunk
	Files       []gitx.FilePatch
	Provenance  map[string][]model.HunkProvenance
	ActorKind   map[string]string
	Sessions    []*store.SessionData
	Flags       []model.Flag
	Units       []model.ReviewUnit
	Rationales  map[string]model.Rationale
	Location    func(model.Flag) string
	XisVersion  string
	NoteRef     string
	GeneratedAt time.Time
}

type Intent

type Intent struct {
	Text   string `json:"text"`
	Status string `json:"status"`
}

type Report

type Report struct {
	ChangeID     string         `json:"change_id"`
	Base         string         `json:"base"`
	Target       string         `json:"target"`
	Sessions     []Session      `json:"sessions"`
	FilesChanged int            `json:"files_changed"`
	LinesAdded   int            `json:"lines_added"`
	LinesRemoved int            `json:"lines_removed"`
	Contributors map[string]int `json:"contributors"`
	Intent       []Intent       `json:"intent"`
	IntentNote   string         `json:"intent_note,omitempty"`
	Flags        []Flag         `json:"flags"`
	Suppressed   []Flag         `json:"suppressed"`
	Units        []Unit         `json:"review_units"`
	TestRuns     []TestRun      `json:"test_runs"`
	LastTestRun  string         `json:"last_test_run"`
	Claims       []Claim        `json:"agent_claims"`
	XisVersion   string         `json:"xis_version"`
	NoteRef      string         `json:"note_ref"`
	GeneratedAt  time.Time      `json:"generated_at"`
}

func Build

func Build(in Input) Report

type Session

type Session struct {
	ID       string   `json:"id"`
	Agent    string   `json:"agent"`
	Version  string   `json:"agent_version"`
	Models   []string `json:"models"`
	Fidelity string   `json:"fidelity"`
	Steps    int      `json:"steps"`
	Duration string   `json:"duration"`
	Status   string   `json:"status"`
}

type TestRun

type TestRun struct {
	Command string `json:"command"`
	Outcome string `json:"outcome"`
	Step    int    `json:"step"`
}

type Unit

type Unit struct {
	Title       string   `json:"title"`
	Status      string   `json:"status"`
	Source      string   `json:"source"`
	Explanation []string `json:"explanation"`
	Files       []string `json:"files"`
	Hunks       int      `json:"hunks"`
}

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL