command

package

v0.0.0-...-1327151 Latest Latest Go to latest Published: Apr 13, 2020 License: BSD-3-Clause Imports: 11 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

Package command provides a common structure for building command line programs.

This section is empty.

This section is empty.

func BackgroundContext(log *zap.Logger) context.Context

BackgroundContext returns a context suitable for a command-line tool or service.

func Logger() (*zap.Logger, error)

Logger initializes a logger suitable for command-line applications.

func Run(m MainStatus)

func RunError(m MainError)

type Base struct {
	Log *zap.Logger
}

Base is a base for all subcommands.

func NewBase(l *zap.Logger) Base

NewBase builds a new base command for the named tool.

func (b Base) CheckClose(statusp *subcommands.ExitStatus, c io.Closer)

CheckClose closes c. On error it logs and writes to the status pointer. Intended for deferred Close() calls.

func (b Base) Error(err error) subcommands.ExitStatus

Error logs err and returns a failing exit code.

func (b Base) Fail(format string, args ...interface{}) subcommands.ExitStatus

Fail logs an error message and returns a failing exit code.

func (Base) SetFlags(f *flag.FlagSet)

SetFlags is a stub implementation of the SetFlags methods that does nothing.

func (b Base) Status(err error) subcommands.ExitStatus

Status fails if the provided error is non-nil, and returns success otherwise.

func (b Base) UsageError(format string, args ...interface{}) subcommands.ExitStatus

UsageError logs a usage error and returns a suitable exit code.

type MainError func(context.Context, *zap.Logger) error

MainError is an entry point returning an error.

type MainStatus func(context.Context, *zap.Logger) int

MainStatus is an entry point returnint an exit status.