findings

package
v0.46.0 Latest Latest
Warning

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

Go to latest
Published: Oct 28, 2026 License: MIT Imports: 6 Imported by: 0

Documentation

Overview

Package findings reads a review's findings file, the shape steps/review.md fixes: a header of `key: value` lines, a `## Categories` list with a count per category, and a block per finding under `## Prior round` and `## Findings`, each a `### <id> <title>` heading with `key: value` lines, the `verdict:` and `reason:` that resolve appends among them.

Index

Constants

This section is empty.

Variables

View Source
var ErrNoHeader = errors.New("findings: no header")

ErrNoHeader is a file without the header's task and round.

Functions

func Reopens added in v0.40.0

func Reopens(status string) bool

Reopens reports whether a prior finding's status awaits a verdict.

Types

type File

type File struct {
	Task       string
	Round      string
	Reviewed   string // the sha, plus ` dirty` when the tree differed
	Reviewer   string // `local`, a remote identity, or both: `local, claude[bot]`
	Verdict    string // clean or findings
	Categories map[string]int
	Findings   []Finding
}

File is one findings file.

func Parse

func Parse(text string) (*File, error)

Parse reads a findings file's text.

func (*File) Halves added in v0.43.0

func (f *File) Halves() (bool, bool)

Halves is which reviewers the header names: `local`, a remote identity, or both, comma-separated.

func (*File) Remote added in v0.43.0

func (f *File) Remote(fd Finding) bool

Remote reports whether the remote half raised a finding: its own `source:` line, else the header, a file naming both halves reading an untagged block as local.

type Finding

type Finding struct {
	ID       string
	Title    string
	Category string
	Prior    bool
	Status   string // prior round only: fixed, still open, ...
	Source   string // local or remote, in a file both halves wrote; empty: the header's reviewer
	Verdict  string // as written, attachments included: `skip +reply`
	Reason   string
}

Finding is one block. Prior-round blocks carry their round-one id and the status the second review gave them.

Jump to

Keyboard shortcuts

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