Documentation ¶
Index ¶
- func Require(verbose bool) func(runtime *goja.Runtime, module *goja.Object)
- type ExecutionError
- type Module
- func (sh *Module) CmdRan(err error) bool
- func (sh *Module) Exec(env map[string]string, stdout, stderr io.Writer, cmd string, args ...string) (ran bool, err error)
- func (sh *Module) ExitStatus(err error) int
- func (sh *Module) OutCmd(cmd string, args ...string) func(args ...string) (string, error)
- func (sh *Module) Output(cmd string, args ...string) (string, error)
- func (sh *Module) OutputWith(env map[string]string, cmd string, args ...string) (string, error)
- func (sh *Module) Run(cmd string, args ...string) error
- func (sh *Module) RunCmd(cmd string, args ...string) func(args ...string) error
- func (sh *Module) RunV(cmd string, args ...string) error
- func (sh *Module) RunWith(env map[string]string, cmd string, args ...string) error
- func (sh *Module) RunWithV(env map[string]string, cmd string, args ...string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
Types ¶
type ExecutionError ¶
func (ExecutionError) Error ¶
func (t ExecutionError) Error() string
type Module ¶
type Module struct { Verbose bool // contains filtered or unexported fields }
func (*Module) CmdRan ¶
CmdRan examines the error to determine if it was generated as a result of a command running via os/exec.Command. If the error is nil, or the command ran (even if it exited with a non-zero exit code), CmdRan reports true. If the error is an unrecognized type, or it is an error from exec.Command that says the command failed to run (usually due to the command not existing or not being executable), it reports false.
func (*Module) Exec ¶
func (sh *Module) Exec(env map[string]string, stdout, stderr io.Writer, cmd string, args ...string) (ran bool, err error)
Exec executes the command, piping its stderr to mage's stderr and piping its stdout to the given writer. If the command fails, it will return an error that, if returned from a target or mg.Deps call, will cause mage to exit with the same code as the command failed with. Env is a list of environment variables to set when running the command, these override the current environment variables set (which are also passed to the command). cmd and args may include references to environment variables in $FOO format, in which case these will be expanded before the command is run.
Ran reports if the command ran (rather than was not found or not executable). Code reports the exit code the command returned if it ran. If err == nil, ran is always true and code is always 0.
func (*Module) ExitStatus ¶
ExitStatus returns the exit status of the error if it is an exec.ExitError or if it implements ExitStatus() int. 0 if it is nil or 1 if it is a different error.
func (*Module) OutputWith ¶
OutputWith is like RunWith, but returns what is written to stdout.
func (*Module) RunCmd ¶
RunCmd returns a function that will call Run with the given command. This is useful for creating command aliases to make your scripts easier to read, like this:
// in a helper file somewhere var g0 = sh.RunCmd("go") // go is a keyword :( // somewhere in your main code if err := g0("install", "github.com/gohugo/hugo"); err != nil { return err }
Args passed to command get baked in as args to the command when you run it. Any args passed in when you run the returned function will be appended to the original args. For example, this is equivalent to the above:
var goInstall = sh.RunCmd("go", "install") goInstall("github.com/gohugo/hugo")
RunCmd uses Exec underneath, so see those docs for more details.