app

Documentation

Index

• Constants
• Variables
• func Comp(actions ...CompAction) ...
• func Delete(name, path string) error
• func Edit(path, defaultContent, name string, validate func(s string) error) error
• func Register[Flags, Data any](app *Command[Flags, Data]) *cobra.Command
• func Root(cmd *cobra.Command)
• type Command
• type CompAction
  • func CompGitLocalBranch(current bool) CompAction
• type CompResult
  • func CompBuilder(_ []string) (*CompResult, error)
  • func CompGitRemote(_ []string) (*CompResult, error)
  • func CompGitRemoteBranch(_ []string) (*CompResult, error)
  • func CompGitTag(_ []string) (*CompResult, error)
  • func CompGroup(args []string) (*CompResult, error)
  • func CompJob(_ []string) (*CompResult, error)
  • func CompRemote(_ []string) (*CompResult, error)
  • func CompRepo(args []string) (*CompResult, error)
  • func CompTemplate(_ []string) (*CompResult, error)
  • func CompWorkflow(_ []string) (*CompResult, error)
• type Context
  • func (ctx *Context[Flags, Data]) Arg(idx int) string
  • func (ctx *Context[Flags, Data]) ArgDefault(idx int, def string) string
  • func (ctx *Context[Flags, Data]) ArgLen() int
  • func (ctx *Context[Flags, Data]) OnClose(f func() error)
• type Empty
• type InitFunction
• type PrepareFunction
• type RunFunction

Constants

const CompNoSpaceFlag = cobra.ShellCompDirectiveNoSpace | cobra.ShellCompDirectiveNoFileComp

Variables

var EmptyCompResult = &CompResult{
	Flag: cobra.ShellCompDirectiveNoFileComp,
}

Functions

func Comp

func Comp(actions ...CompAction) func(cmd *cobra.Command, args []string, toComplete string) ([]string, cobra.ShellCompDirective)

func Delete

func Delete(name, path string) error

func Edit

func Edit(path, defaultContent, name string, validate func(s string) error) error

func Register

func Register[Flags, Data any](app *Command[Flags, Data]) *cobra.Command

func Root

func Root(cmd *cobra.Command)

Types

type Command

type Command[Flags, Data any] struct {
	Use    string
	Desc   string
	Action string

	Prepare PrepareFunction[Flags]

	PrepareNoFlag func(cmd *cobra.Command)

	Init InitFunction[Flags, Data]

	Run RunFunction[Flags, Data]

	RunNoContext func() error
}

type CompAction

type CompAction func(args []string) (*CompResult, error)

func CompGitLocalBranch

func CompGitLocalBranch(current bool) CompAction

type CompResult

type CompResult struct {
	Items []string
	Flag  cobra.ShellCompDirective
}

func CompBuilder

func CompBuilder(_ []string) (*CompResult, error)

func CompGitRemote

func CompGitRemote(_ []string) (*CompResult, error)

func CompGitRemoteBranch

func CompGitRemoteBranch(_ []string) (*CompResult, error)

func CompGitTag

func CompGitTag(_ []string) (*CompResult, error)

func CompGroup

func CompGroup(args []string) (*CompResult, error)

func CompJob

func CompJob(_ []string) (*CompResult, error)

func CompRemote

func CompRemote(_ []string) (*CompResult, error)

func CompRepo

func CompRepo(args []string) (*CompResult, error)

func CompTemplate

func CompTemplate(_ []string) (*CompResult, error)

func CompWorkflow

func CompWorkflow(_ []string) (*CompResult, error)

type Context

type Context[Flags, Data any] struct {
	Flags *Flags
	Data  *Data
	// contains filtered or unexported fields
}

func (*Context[Flags, Data]) Arg

func (ctx *Context[Flags, Data]) Arg(idx int) string

func (*Context[Flags, Data]) ArgDefault

func (ctx *Context[Flags, Data]) ArgDefault(idx int, def string) string

func (*Context[Flags, Data]) ArgLen

func (ctx *Context[Flags, Data]) ArgLen() int

func (*Context[Flags, Data]) OnClose

func (ctx *Context[Flags, Data]) OnClose(f func() error)

type Empty

type Empty struct{}

type InitFunction

type InitFunction[Flags, Data any] func(ctx *Context[Flags, Data]) error

type PrepareFunction

type PrepareFunction[Flags any] func(cmd *cobra.Command, flags *Flags)

type RunFunction

type RunFunction[Flags, Data any] func(ctx *Context[Flags, Data]) error