tool

Documentation

Index

• Variables
• func FilepathRelIfShorter(fileName string) string
• func FlagDefaults(addFlags func(*flag.FlagSet)) string
• func PrintErrExit(err error)
• func Run()
• type Command
  • func (c *Command) Name() string
  • func (c *Command) Runnable() bool
  • func (c *Command) Usage()

Variables

var CmdVersion = &Command{
	UsageLine: "version",
	Short:     "displays the program version",
	Run: func(_ *Command, _ io.Writer, _ []string) error {
		fmt.Println(Name, "version", Version)
		return nil
	},
}

var Commands []*Command

Commands lists the available commands and help topics. The order here is the order in which they are printed by 'go help'.

var ErrFormatPrefix string

var FormatErr = PrintErrExit

var Name string

var Title string

var Version = "<not set>"

Functions

func FilepathRelIfShorter

func FilepathRelIfShorter(fileName string) string

func FlagDefaults

func FlagDefaults(addFlags func(*flag.FlagSet)) string

func PrintErrExit

func PrintErrExit(err error)

func Run

func Run()

Types

type Command

type Command struct {
	// Run runs the command.
	// The args are the arguments after the command name.
	Run func(cmd *Command, w io.Writer, args []string) error

	// UsageLine is the one-line usage message.
	// The first word in the line is taken to be the command name.
	UsageLine string

	// Short is the short description shown in the 'go help' output.
	Short string

	// Long is the long message shown in the 'go help <this-command>' output.
	Long string

	// Flag is a set of flags specific to this command.
	Flag flag.FlagSet

	// CustomFlags indicates that the command will do its own
	// flag parsing.
	CustomFlags bool

	Hidden       bool
	ExtraArgsReq int
	ExtraArgsMax int
}

A Command is an implementation of a go command like go build or go fix.

func (*Command) Name

func (c *Command) Name() string

Name returns the command's name: the first word in the usage line.

func (*Command) Runnable

func (c *Command) Runnable() bool

Runnable reports whether the command can be run; otherwise it is a documentation pseudo-command such as importpath.

func (*Command) Usage

func (c *Command) Usage()