command

Documentation

Overview

Package command provides support for addons to executing (CLI) commands.

Index

• Constants
• type Command
  • func New(path string) (cmd *Command)
  • func (r *Command) Output() (b []byte)
  • func (r *Command) Run() (err error)
  • func (r *Command) RunSilent() (err error)
  • func (r *Command) RunWith(ctx context.Context) (err error)
• type Options
  • func (a *Options) Add(option string, s ...string)
  • func (a *Options) Addf(option string, x ...interface{})
• type Reporter
  • func (r *Reporter) Error(path string, err error, output []byte)
  • func (r *Reporter) Output(buffer []byte) (reported int)
  • func (r *Reporter) Run(path string, options Options)
  • func (r *Reporter) Succeeded(path string, output []byte)
• type Writer
  • func (w *Writer) End()
  • func (w *Writer) Write(p []byte) (n int, err error)

Constants

const (
	// Disabled reports: NOTHING.
	Disabled = -2
	// Error reports: error.
	Error = -1
	// Default reports: error, started, succeeded.
	Default = 0
	// LiveOutput reports: error, started, succeeded, output (live).
	LiveOutput = 1
)

Verbosity.

const (
	// Backoff rate increment.
	Backoff = time.Millisecond * 100
	// MaxBackoff max backoff.
	MaxBackoff = 10 * Backoff
	// MinBackoff minimum backoff.
	MinBackoff = Backoff
)

Types

type Command

type Command struct {
	Options  Options
	Path     string
	Dir      string
	Reporter Reporter
	Writer   Writer
}

Command execution.

func New

func New(path string) (cmd *Command)

New returns a command.

func (*Command) Output

func (r *Command) Output() (b []byte)

Output returns the command output.

func (*Command) Run

func (r *Command) Run() (err error)

Run executes the command. The command and output are both reported in task Report.Activity.

func (*Command) RunSilent

func (r *Command) RunSilent() (err error)

RunSilent executes the command. On error: The command (without arguments) and output are reported in task Report.Activity

func (*Command) RunWith

func (r *Command) RunWith(ctx context.Context) (err error)

RunWith executes the command with context. The command and output are both reported in task Report.Activity.

type Options

type Options []string

Options are CLI options.

func (*Options) Add

func (a *Options) Add(option string, s ...string)

Add option.

func (*Options) Addf

func (a *Options) Addf(option string, x ...interface{})

Addf option.

type Reporter

type Reporter struct {
	Verbosity int
	// contains filtered or unexported fields
}

Reporter activity reporter.

func (*Reporter) Error

func (r *Reporter) Error(path string, err error, output []byte)

Error reports command failed in task Report.Activity.

func (*Reporter) Output

func (r *Reporter) Output(buffer []byte) (reported int)

Output reports command output.

func (*Reporter) Run

func (r *Reporter) Run(path string, options Options)

Run reports command started in task Report.Activity.

func (*Reporter) Succeeded

func (r *Reporter) Succeeded(path string, output []byte)

Succeeded reports command succeeded in task Report.Activity.

type Writer

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

Writer records command output.

func (*Writer) End

func (w *Writer) End()

End of writing.

func (*Writer) Write

func (w *Writer) Write(p []byte) (n int, err error)

Write command output.