ui

Documentation

Index

• type ActionRunner
• type BaselineSaveRequest
• type CodemodApplyRequest
• type Detail
  • func NewDetail(out io.Writer, analyzer analysis.Analyser, repoPath string, language string) *Detail
  • func (d *Detail) Show(ctx context.Context, dependency string) error
• type Options
• type ParityAction
• type ParityCapabilities
• type ParityDiff
• type ParityFrame
  • func LegacyParityProjection(view summaryDisplayView, state summaryState, totalPages int, ...) ParityFrame
  • func StaveParityProjection(tree semantic.Tree, caps ParityCapabilities) (ParityFrame, error)
• type ParityReport
  • func CompareParity(want, got ParityFrame) ParityReport
  • func (r *ParityReport) EqualWithKnownGaps(known map[string]bool) bool
• type ParityRow
• type StavePreview
  • func (p *StavePreview) Snapshot(ctx context.Context, opts Options, outputPath string) error
  • func (p *StavePreview) Start(ctx context.Context, opts Options) error
• type Summary
  • func NewSummary(out io.Writer, in io.Reader, analyzer analysis.Analyser, ...) *Summary
  • func (s *Summary) Snapshot(ctx context.Context, opts Options, outputPath string) error
  • func (s *Summary) Start(ctx context.Context, opts Options) error
• type TUI
  • func NewStavePreview(legacy *Summary) TUI

Types

type ActionRunner

type ActionRunner interface {
	ApplyCodemod(context.Context, CodemodApplyRequest) (report.Report, error)
	SaveBaseline(context.Context, BaselineSaveRequest) (report.Report, string, error)
}

type BaselineSaveRequest

type BaselineSaveRequest struct {
	RepoPath          string
	TopN              int
	Language          string
	BaselineStorePath string
	BaselineKey       string
	BaselineLabel     string
	Features          featureflags.Set
}

type CodemodApplyRequest

type CodemodApplyRequest struct {
	RepoPath   string
	Dependency string
	TopN       int
	Language   string
	AllowDirty bool
	Features   featureflags.Set
}

type Detail

type Detail struct {
	Analyzer analysis.Analyser
	Out      io.Writer
	RepoPath string
	Language string
}

func NewDetail

func NewDetail(out io.Writer, analyzer analysis.Analyser, repoPath string, language string) *Detail

func (*Detail) Show

func (d *Detail) Show(ctx context.Context, dependency string) error

type Options

type Options struct {
	RepoPath          string
	Language          string
	TopN              int
	Filter            string
	Sort              string
	PageSize          int
	BaselinePath      string
	BaselineStorePath string
	BaselineKey       string
	Features          featureflags.Set
	UseStavePreview   bool
	Width             int
	ASCII             bool
	Color             *bool
}

type ParityAction

type ParityAction struct {
	Name      string
	Supported bool
	GapReason string
}

type ParityCapabilities

type ParityCapabilities struct {
	Width                     int
	ASCII, Color, Interactive bool
}

type ParityDiff

type ParityDiff struct{ Path, Want, Got string }

type ParityFrame

type ParityFrame struct {
	Rows                       []ParityRow
	Warnings                   []string
	Page, TotalPages, PageSize int
	Capabilities               ParityCapabilities
	Actions                    []ParityAction
}

func LegacyParityProjection

func LegacyParityProjection(view summaryDisplayView, state summaryState, totalPages int, caps ParityCapabilities) ParityFrame

LegacyParityProjection is derived from the actual display view and state.

func StaveParityProjection

func StaveParityProjection(tree semantic.Tree, caps ParityCapabilities) (ParityFrame, error)

StaveParityProjection reads the actual Stave snapshot, not the source model.

type ParityReport

type ParityReport struct{ Violations, CapabilityGaps []ParityDiff }

func CompareParity

func CompareParity(want, got ParityFrame) ParityReport

func (*ParityReport) EqualWithKnownGaps

func (r *ParityReport) EqualWithKnownGaps(known map[string]bool) bool

EqualWithKnownGaps is the explicit oracle for the preview's documented one-shot/action limitations. Unknown, missing, or duplicate capability gaps remain failures so improvements and regressions both require an explicit contract update.

type ParityRow

type ParityRow struct {
	Identity, Language, Name string
	Waste                    int64
	Used                     float64
}

type StavePreview

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

StavePreview is deliberately a delegating TUI: the default path remains byte-for-byte owned by Summary, while explicit opt-in routes both Start and Snapshot through Stave without changing Lopper's command grammar or action authority.

func (*StavePreview) Snapshot

func (p *StavePreview) Snapshot(ctx context.Context, opts Options, outputPath string) error

func (*StavePreview) Start

func (p *StavePreview) Start(ctx context.Context, opts Options) error

type Summary

type Summary struct {
	Analyzer  analysis.Analyser
	Actions   ActionRunner
	Formatter summaryFormatter
	Out       io.Writer
	In        io.Reader
	TopN      int
	PageSize  int
	Language  string
}

func NewSummary

func NewSummary(out io.Writer, in io.Reader, analyzer analysis.Analyser, formatter *report.Formatter) *Summary

func (*Summary) Snapshot

func (s *Summary) Snapshot(ctx context.Context, opts Options, outputPath string) error

func (*Summary) Start

func (s *Summary) Start(ctx context.Context, opts Options) error

type TUI

type TUI interface {
	Start(ctx context.Context, opts Options) error
	Snapshot(ctx context.Context, opts Options, outputPath string) error
}

func NewStavePreview

func NewStavePreview(legacy *Summary) TUI