cmd

Documentation

Overview

Package cmd offers functions for running programs in a Shell-like way.

Index

• func Exec(a *goyek.A, cmdLine string, opts ...Option) bool
• type Option
  • func Dir(s string) Option
  • func Env(k, v string) Option
  • func Stderr(w io.Writer) Option
  • func Stdin(r io.Reader) Option
  • func Stdout(w io.Writer) Option

Examples

• Exec

Functions

func Exec

func Exec(a *goyek.A, cmdLine string, opts ...Option) bool

Exec runs the command. It calls a.Error[f] and returns false in case of any problems. Example usage:

cmd.Exec(a, "FOO=foo BAR=baz ./foo --bar=baz", cmd.Dir("pkg"))

Example

goyek.Define(goyek.Task{
	Name:  "diff",
	Usage: "git diff",
	Action: func(a *goyek.A) {
		cmd.Exec(a, "git diff --exit-code")

		sb := &strings.Builder{}
		out := io.MultiWriter(a.Output(), sb)
		cmd.Exec(a, "git status --porcelain", cmd.Stdout(out))
		if sb.Len() > 0 {
			a.Error("git status --porcelain returned output")
		}
	},
})

Types

type Option

type Option func(a *goyek.A, cmd *exec.Cmd)

Option configures the command.

func Dir

func Dir(s string) Option

Dir is an option to set the working directory.

func Env

func Env(k, v string) Option

Env is an option to set an environment variable.

func Stderr

func Stderr(w io.Writer) Option

Stderr is an option to set the standard error.

func Stdin

func Stdin(r io.Reader) Option

Stdin is an option to set the standard input.

func Stdout

func Stdout(w io.Writer) Option

Stdout is an option to set the standard output.