diffview

package
v0.1.18 Latest Latest
Warning

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

Go to latest
Published: May 15, 2026 License: MIT Imports: 23 Imported by: 0

Documentation

Overview

Package diffview renders unified diffs from `gh pr diff` in a TUI.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func DetectNewSymbols added in v0.1.18

func DetectNewSymbols(path string, lines []Line) []string

DetectNewSymbols extracts identifiers introduced in this file's added lines. Only looks at LineAdd entries. Returns deduplicated names in declaration order.

func IsCIRelated added in v0.1.17

func IsCIRelated(path string) bool

IsCIRelated reports whether a path is one of the file kinds whose changes affect CI behavior (workflows, test/build configs, coverage).

Types

type CIRisk added in v0.1.17

type CIRisk int

CIRisk classifies how a file affects CI confidence. Used to pin risky files to the top of the sidebar and to gate 100% progress.

const (
	CIRiskNone      CIRisk = iota
	CIRiskConfig           // CI/test/coverage config touched but no obvious weakening
	CIRiskWeakening        // explicit weakening signal in the diff
)

type CISignal added in v0.1.17

type CISignal struct {
	Risk    CIRisk
	Reasons []string // human-readable summary, e.g. "test marked .skip" or "continue-on-error added"
}

CISignal is a per-file detection result.

func DetectCIRisk added in v0.1.17

func DetectCIRisk(path string, lines []Line) CISignal

DetectCIRisk inspects a file's path and diff body for CI-related changes and returns a CISignal. Returns CIRiskNone for files that don't match any CI-relevant path pattern.

Content-level weakening signals are only inspected on workflow files (where they're unambiguous). For other config files we conservatively report CIRiskConfig — the reviewer's judgment is the gate.

type DupeFinding added in v0.1.18

type DupeFinding struct {
	Symbol     string   // newly-added identifier
	Candidates []string // up to 5 "path:line" matches outside this file
}

DupeFinding is one newly-added symbol and the repo locations where a similar identifier already exists.

type DupeSignal added in v0.1.18

type DupeSignal struct {
	// Symbols added by this file's diff that have prior-art candidates.
	Findings []DupeFinding
}

DupeSignal records possible-duplicate findings for one file: each newly-added top-level symbol and where else in the repo a similar name appears outside this PR.

func DetectDupes added in v0.1.18

func DetectDupes(path string, lines []Line, repoRoot string, excludedPaths map[string]bool) DupeSignal

DetectDupes runs a repo-wide grep for each newly-added symbol from the file's diff, excluding paths inside the PR itself. Returns nil if no candidates are found or the grep fails.

repoRoot is the working directory for `git grep`. excludedPaths are file paths in the PR that should be filtered out of grep results (so a symbol declaration doesn't match itself).

type File

type File struct {
	Path  string
	Adds  int
	Dels  int
	Lines []Line
}

File is one file's worth of changes from a unified diff.

func Parse

func Parse(diff string) []File

Parse splits a unified diff (as produced by `gh pr diff --patch` or `git diff`) into per-file blocks. Adds/Dels are counted only for content lines (not file/hunk headers). The parser is intentionally lenient: any content that doesn't match an expected prefix is treated as context.

type Highlighter

type Highlighter struct {
	// contains filtered or unexported fields
}

Highlighter colorizes diff content lines using chroma based on file extension. Lexers and the formatter are looked up once per extension and reused. When NO_COLOR is set or the lexer is unknown, Highlight returns the input unchanged.

func NewHighlighter

func NewHighlighter() *Highlighter

func (*Highlighter) Highlight

func (h *Highlighter) Highlight(path, src string) string

Highlight returns the colorized form of src for the lexer matching path's extension. Falls back to src on any error or when disabled.

func (*Highlighter) HighlightWithBg added in v0.1.14

func (h *Highlighter) HighlightWithBg(path, src string, bg lipgloss.Color) string

HighlightWithBg tokenises src with the lexer for path and renders each token with both its syntax foreground AND the given diff background. This gives the hunk/diffs.com look where chroma's colors stay vivid on top of a soft +/- tint, without relying on fragile mid-stream ANSI rewriting.

Returns src wrapped in a single bg style if no lexer matches or highlighting is disabled. The caller is responsible for any extra padding needed to reach a target pane width.

type Line

type Line struct {
	Kind LineKind
	Text string
}

Line is one rendered line of the diff (file header, hunk header, or content). Kind drives coloring; Text is the raw text without trailing newline.

type LineKind

type LineKind int
const (
	LineContext   LineKind = iota // " foo"
	LineAdd                       // "+foo"
	LineDel                       // "-foo"
	LineFile                      // "diff --git ..." / "--- a/" / "+++ b/"
	LineHunk                      // "@@ -1,3 +1,4 @@"
	LineNoNewLine                 // "\ No newline at end of file"
)

type Model

type Model struct {
	Title string // e.g. "#687 wall drawing UX"
	Files []File

	// BlobByPath maps file path -> blob SHA for the PR's current head, used
	// to detect "changed since you checked" against persisted review state.
	BlobByPath map[string]string

	// CISignals records the per-file CI risk classification computed once
	// at load time. Populated by ensureDetectors.
	CISignals map[string]CISignal

	// DupeSignals records possible-duplicate symbol findings per file.
	// Computed once after the Files slice is set when a repo root is
	// available. Empty when no repo root is configured (test contexts).
	DupeSignals map[string]DupeSignal

	// RepoRoot is the local filesystem path of the repo, used by the
	// duplicate-detector's git grep. Optional; when unset, dupe detection
	// is skipped.
	RepoRoot string

	// ReviewState is the loaded per-file checklist for this PR. Optional;
	// when nil, review-tracking UI is hidden entirely. The owner+repo+number
	// fields are kept here so Save can write back to the right key.
	ReviewState *reviewstate.PRState
	ReviewStore *reviewstate.Store
	RepoOwner   string
	RepoName    string
	// contains filtered or unexported fields
}

Model is the bubbletea model for the PR diff viewer.

func New

func New(title string, files []File) Model

func (Model) Init

func (m Model) Init() tea.Cmd

func (*Model) RunRepoDetectors added in v0.1.18

func (m *Model) RunRepoDetectors()

runRepoDetectors runs detectors that need filesystem access (i.e. git grep for dupe detection). Called by the caller (cmd/view.go) after it discovers the repo root, since the diffview package doesn't shell out by itself in the New constructor.

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string

Jump to

Keyboard shortcuts

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