util

Documentation

Index

• Constants
• Variables
• func AddGroupedCommands(mainCommand *cobra.Command, group cobra.Group, cmds []*cobra.Command)
• func AllComandsHelpFlag(command *cobra.Command)
• func AppendFlagHelp(flag *pflag.Flag, helpTemplate string) *pflag.Flag
• func FileExists(path string) (bool, error)
• func GetAvailableEphemeralPort(iface string) (int, error)
• func GetFlagBoolAnnotation(flag *pflag.Flag, annotation BoolFlagType) bool
• func GetHelp(flag *pflag.Flag) string
• func GetWorkspaceDir() (string, error)
• func GetWorkspaceDirAndShort() (string, string, error)
• func HasHelp(flag *pflag.Flag) bool
• func IsHidden(flag *pflag.Flag) bool
• func IsStdinPresent() (bool, error)
• func MakeSpinner(suffix string) *spinner.Spinner
• func MarkFlag(flag *pflag.Flag, flagTypes ...BoolFlagType) *pflag.Flag
• func MarkFlagRequiredWithHelp(flag *pflag.Flag, helpTemplate string) *pflag.Flag
• func PersistentPreRunChain(command *cobra.Command, args []string) error
• type BoolFlagType

Constants

const (
	StrTrue  = "true"
	StrFalse = "false"
)

const (
	HelpTemplate = "bns_annotation_help_template"
)

Variables

var (
	ErrInvalidValue = errors.New("invalid value")
)

Functions

func AddGroupedCommands

func AddGroupedCommands(mainCommand *cobra.Command, group cobra.Group, cmds []*cobra.Command)

func AllComandsHelpFlag

func AllComandsHelpFlag(command *cobra.Command)

func AppendFlagHelp

func AppendFlagHelp(flag *pflag.Flag, helpTemplate string) *pflag.Flag

func FileExists

func FileExists(path string) (bool, error)

func GetAvailableEphemeralPort

func GetAvailableEphemeralPort(iface string) (int, error)

func GetFlagBoolAnnotation

func GetFlagBoolAnnotation(flag *pflag.Flag, annotation BoolFlagType) bool

func GetHelp

func GetHelp(flag *pflag.Flag) string

func GetWorkspaceDir

func GetWorkspaceDir() (string, error)

func GetWorkspaceDirAndShort

func GetWorkspaceDirAndShort() (string, string, error)

func HasHelp

func HasHelp(flag *pflag.Flag) bool

func IsHidden

func IsHidden(flag *pflag.Flag) bool

func IsStdinPresent

func IsStdinPresent() (bool, error)

func MakeSpinner

func MakeSpinner(suffix string) *spinner.Spinner

func MarkFlag

func MarkFlag(flag *pflag.Flag, flagTypes ...BoolFlagType) *pflag.Flag

func MarkFlagRequiredWithHelp

func MarkFlagRequiredWithHelp(flag *pflag.Flag, helpTemplate string) *pflag.Flag

func PersistentPreRunChain

func PersistentPreRunChain(command *cobra.Command, args []string) error

Types

type BoolFlagType

type BoolFlagType string

const (
	FlagHidden     BoolFlagType = "bns_annotation_hidden"
	FlagRequired   BoolFlagType = cobra.BashCompOneRequiredFlag
	FlagDirname    BoolFlagType = cobra.BashCompSubdirsInDir
	FlagAllowBlank BoolFlagType = "bns_annotation_allow_blank"
)