subcmd

package

v0.4.4 Latest Latest Go to latest Published: Jun 11, 2021 License: MIT Imports: 32 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

View Source

var ErrShowedHelp = errors.New("already showed help")

ErrShowedHelp is used in parsing argument function of subcommand when the subcommand showed help. Then caller can exit successfully and silently.

This section is empty.

type Cmd interface {
	ProhibitRootExecution(args []string) bool
	Run(args []string) *Error
	FlagSet() *flag.FlagSet
}

Cmd represents volt's subcommand interface. All subcommands must implement this.

type Error struct {
	Code int
	Msg  string
}

Error is a command error. It also has a exit code.

func DefaultRunner(c Cmd, args []string) *Error

DefaultRunner simply runs command with args

func Run(args []string, cont RunnerFunc) *Error

Run is invoked by main(), each argument means 'volt {subcmd} {args}'.

func (e *Error) Error() string

type RunnerFunc func(c Cmd, args []string) *Error

RunnerFunc invokes c with args. On unit testing, a mock function was given.