commands

Documentation

Index

• Constants
• Variables
• type Args
  • func NewArgs(args []string) *Args
  • func (a *Args) After(command ...string)
  • func (a *Args) AppendParams(params ...string)
  • func (a *Args) Before(command ...string)
  • func (a *Args) Commands() []*cmd.Cmd
  • func (a *Args) FirstParam() string
  • func (a *Args) GetParam(i int) string
  • func (a *Args) IndexOfParam(param string) int
  • func (a *Args) IsParamsEmpty() bool
  • func (a *Args) LastParam() string
  • func (a *Args) ParamsSize() int
  • func (a *Args) RemoveParam(i int) string
  • func (a *Args) Replace(executable, command string, params ...string)
  • func (a *Args) ReplaceParam(i int, item string)
  • func (a *Args) ToCmd() *cmd.Cmd
• type Command
  • func All() []*Command
  • func (c *Command) List() bool
  • func (c *Command) Name() string
  • func (c *Command) PrintUsage()
  • func (c *Command) Runnable() bool
• type Runner
  • func (r *Runner) Execute() error

Constants

const Version = "0.13.0"

Variables

var (
	NameRe          = "[\\w.][\\w.-]*"
	OwnerRe         = "[a-zA-Z0-9][a-zA-Z0-9-]*"
	NameWithOwnerRe = fmt.Sprintf("^(?:%s|%s\\/%s)$", NameRe, OwnerRe, NameRe)
)

var Basic = []*Command{
	cmdInit,
}

var Branching = []*Command{
	cmdCheckout,
	cmdMerge,
}

var GitHub = []*Command{
	cmdPullRequest,
	cmdFork,
	cmdCiStatus,
	cmdBrowse,
	cmdCompare,
}

var Remote = []*Command{
	cmdClone,
	cmdRemote,
}

Types

type Args

type Args struct {
	Executable string
	Command    string
	Params     []string

	Noop bool
	// contains filtered or unexported fields
}

func NewArgs

func NewArgs(args []string) *Args

func (*Args) After

func (a *Args) After(command ...string)

func (*Args) AppendParams

func (a *Args) AppendParams(params ...string)

func (*Args) Before

func (a *Args) Before(command ...string)

func (*Args) Commands

func (a *Args) Commands() []*cmd.Cmd

func (*Args) FirstParam

func (a *Args) FirstParam() string

func (*Args) GetParam

func (a *Args) GetParam(i int) string

func (*Args) IndexOfParam

func (a *Args) IndexOfParam(param string) int

func (*Args) IsParamsEmpty

func (a *Args) IsParamsEmpty() bool

func (*Args) LastParam

func (a *Args) LastParam() string

func (*Args) ParamsSize

func (a *Args) ParamsSize() int

func (*Args) RemoveParam

func (a *Args) RemoveParam(i int) string

func (*Args) Replace

func (a *Args) Replace(executable, command string, params ...string)

func (*Args) ReplaceParam

func (a *Args) ReplaceParam(i int, item string)

func (*Args) ToCmd

func (a *Args) ToCmd() *cmd.Cmd

type Command

type Command struct {
	Run  func(cmd *Command, args *Args)
	Flag flag.FlagSet

	Usage        string
	Short        string
	Long         string
	GitExtension bool
}

func All

func All() []*Command

func (*Command) List

func (c *Command) List() bool

func (*Command) Name

func (c *Command) Name() string

func (*Command) PrintUsage

func (c *Command) PrintUsage()

func (*Command) Runnable

func (c *Command) Runnable() bool

type Runner

type Runner struct {
	Args []string
}

func (*Runner) Execute

func (r *Runner) Execute() error