command

Documentation

Index

• Constants
• Variables
• func Admin(ctx *env.Context)
• func Gem(ctx *env.Context)
• func Help(ctx *env.Context)
• func List(ctx *env.Context)
• func Ruby(ctx *env.Context)
• func Use(ctx *env.Context)
• func Version(ctx *env.Context)
• type Command
• type CommandRouter
  • func NewRouter(handler HandlerFunc) *CommandRouter
  • func (r *CommandRouter) Dispatch(ctx *env.Context, cmd string)
  • func (r *CommandRouter) Handle(cmds []string, handler HandlerFunc)
• type HandlerFunc

Constants

const (
	SINGLE_REGISTRATION = iota
	MULTI_REGISTRATION
)

Variables

var (
	CommandRegistry  = make(map[string]Command)
	AdminCmdRegistry = make(map[string]Command)
)

Functions

func Admin

func Admin(ctx *env.Context)

func Gem

func Gem(ctx *env.Context)

func Help

func Help(ctx *env.Context)

func List

func List(ctx *env.Context)

List all rubies registered with uru, identifying the currently active ruby

func Ruby

func Ruby(ctx *env.Context)

func Use

func Use(ctx *env.Context)

func Version

func Version(ctx *env.Context)

Types

type Command

type Command struct {
	Name    string
	Aliases []string
	Usage   string
	HelpMsg string
	Eg      string
}

type CommandRouter

type CommandRouter struct {
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter(handler HandlerFunc) *CommandRouter

Returns a newly configured, ready-to-use command router. Provide a default handler function that will be called when no predefined commands can be matched against the user specified command string. Most often used when creating a top-level command router in which arbitrary tokens are used to activate a particular ruby runtime.

If the default handler function is nil, the function will never be called.

func (*CommandRouter) Dispatch

func (r *CommandRouter) Dispatch(ctx *env.Context, cmd string)

Dispatch calls a previously bound function corresponding to the user specified command string, passing a context as the only arg. If the command string is not a recognized command, and the CommandRouter instance has been created with a non-nil default handler, the default handler will be invoked with a context as the only arg.

func (*CommandRouter) Handle

func (r *CommandRouter) Handle(cmds []string, handler HandlerFunc)

Handle binds a function to a set of user CLI command alias strings. The bound function is be executed whenever a user specifies one of the command aliases.

type HandlerFunc

type HandlerFunc func(*env.Context)