ready

package
v0.3.0 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2026 License: MIT Imports: 8 Imported by: 0

Documentation

Overview

Package ready provides the "ready" shortcut command — a quick way to list issues that are available for work.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewCmd

func NewCmd(f *cmdutil.Factory, runFn ...func(context.Context, RunInput) error) *cli.Command

NewCmd constructs the "ready" command, which lists issues that are ready for work. The optional runFn parameter replaces the default Run for testing; when injected, the service is not constructed and the runFn receives the fully-resolved RunInput so flag parsing can be verified in isolation.

func Run

func Run(ctx context.Context, input RunInput) error

Run executes the ready workflow: queries for ready issues ordered by priority and writes the result to the output writer. The Ready field of input.Filter is always forced to true — this command's purpose is the ready set.

Types

type RunInput

type RunInput struct {
	Service driving.Service
	// Filter narrows the ready set. The Ready field is always forced to true
	// by Run regardless of what the caller sets, so callers may omit it.
	Filter        driving.IssueFilterInput
	OrderBy       driving.OrderBy
	Direction     driving.SortDirection
	JSON          bool
	Limit         int
	Columns       []cmdutil.Column
	WriteTo       io.Writer
	ColorScheme   *iostreams.ColorScheme
	TerminalWidth int
}

RunInput holds the parameters for the ready command's core logic, decoupled from CLI flag parsing so it can be tested directly.

Jump to

Keyboard shortcuts

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