program

Documentation

Overview

Package program wraps the initial interaction with the end user, before (if ever) the control is passed to the tea.Program.

Index

• type Option
  • func WithBuildInfo(version, commit, date string) Option
  • func WithFlagSet(fs *flag.FlagSet, args []string) Option
  • func WithGoModInfo() Option
  • func WithInput(file fs.File) Option
  • func WithLogFile(path string) Option
  • func WithOutput(w io.Writer) Option
• type Program
  • func New(opts ...Option) *Program
  • func (p *Program) Run() error

Types

type Option

type Option func(*Program)

Option is a function that can be passed to WithOptions.

func WithBuildInfo

func WithBuildInfo(version, commit, date string) Option

WithBuildInfo sets the version information of this program.

func WithFlagSet

func WithFlagSet(fs *flag.FlagSet, args []string) Option

WithFlagSet is an optional way to set the flag set for the program. Useful in tests.

func WithGoModInfo

func WithGoModInfo() Option

WithGoModInfo reads build info and sets its fields, if its available.

func WithInput

func WithInput(file fs.File) Option

WithInput sets the stdin for the program. This should be used for testing the features that read from stdin.

func WithLogFile

func WithLogFile(path string) Option

WithLogFile sets the path to the log file.

func WithOutput

func WithOutput(w io.Writer) Option

WithOutput sets the stdout writer for the program. This should be used for testing some of the basic outputs (non-interactive).

type Program

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

Program holds the program configuration.

func New

func New(opts ...Option) *Program

New return a new Program instance. Optional configuration is available using `With...` functions.

func (*Program) Run

func (p *Program) Run() error

Run parses the command line arguments and runs the program.