commander

Documentation

Index

• Variables
• type Commander
  • func New(o conq.Optioner, h conq.Helper) Commander
  • func (c Commander) Execute(root *conq.Cmd, ctx conq.Ctx) error
  • func (c Commander) Helper() conq.Helper
  • func (c Commander) Optioner() conq.Optioner
  • func (c Commander) ResolveCmd(root *conq.Cmd, ctx conq.Ctx) (oc conq.Ctx)

Variables

var CmdCompletion *conq.Cmd = &conq.Cmd{
	Name: "completion",
	Run: func(c conq.Ctx) error {
		line, point, ctype, ok := completionContext()

		if ok {
			return doCompletion(c.Com, c.Path[0], line, point, ctype)
		}

		// show some installation instructions and exit
		var pth strings.Builder
		pth.WriteString(c.Path[0].Name)
		for _, x := range c.Path[1:] {
			fmt.Fprintf(&pth, " %s", x.Name)
		}
		pth.WriteString(" completion")

		fmt.Fprintf(c.Out, "complete -C %q %s\n", pth.String(), c.Path[0].Name)
		return nil
	},
}

Types

type Commander

type Commander struct {
	O conq.Optioner
	H conq.Helper
	P *message.Printer
}

func New

func New(o conq.Optioner, h conq.Helper) Commander

func (Commander) Execute

func (c Commander) Execute(root *conq.Cmd, ctx conq.Ctx) error

func (Commander) Helper

func (c Commander) Helper() conq.Helper

func (Commander) Optioner

func (c Commander) Optioner() conq.Optioner

func (Commander) ResolveCmd

func (c Commander) ResolveCmd(root *conq.Cmd, ctx conq.Ctx) (oc conq.Ctx)

Path should always include the root command and the leaf-command that's being executed