flagutil

Documentation

Overview

Package flagutil is a helper package for processing and interactive command line flags

Index

• Variables
• func EnableOutputFlagCompletion(cmd *cobra.Command)
• func EnableStaticFlagCompletion(cmd *cobra.Command, flagName string, validValues []string)
• func FlagDescription(localizer localize.Localizer, messageID string, validOptions ...string) string
• func IsValidInput(input string, validValues ...string) bool
• func RegisterServiceAccountCompletionFunc(cmd *cobra.Command, flagName string, connFunc factory.ConnectionFunc) error
• func RegisterUserCompletionFunc(cmd *cobra.Command, flagName string, connFunc factory.ConnectionFunc) error
• type FlagOptions
  • func WithFlagOptions(cmd *cobra.Command, flagName string) *FlagOptions
• type FlagSet
  • func NewFlagSet(cmd *cobra.Command, localizer localize.Localizer) *FlagSet
  • func (fs *FlagSet) AddOutput(output *string)
  • func (fs *FlagSet) AddPage(page *int32)
  • func (fs *FlagSet) AddSize(page *int32)
  • func (fs *FlagSet) AddYes(yes *bool)

Variables

var (
	ValidOutputFormats       = []string{dump.JSONFormat, dump.YAMLFormat, dump.YMLFormat}
	CredentialsOutputFormats = []string{credentials.EnvFormat, credentials.JSONFormat, credentials.PropertiesFormat}
)

Functions

func EnableOutputFlagCompletion

func EnableOutputFlagCompletion(cmd *cobra.Command)

EnableOutputFlagCompletion enables autocompletion for output flag

func EnableStaticFlagCompletion

func EnableStaticFlagCompletion(cmd *cobra.Command, flagName string, validValues []string)

EnableStaticFlagCompletion enables autocompletion for flags with predefined valid values

func FlagDescription

func FlagDescription(localizer localize.Localizer, messageID string, validOptions ...string) string

FlagDescription creates a flag description and adds a list of valid options (if any)

func IsValidInput

func IsValidInput(input string, validValues ...string) bool

IsValidInput checks if the input value is in the range of valid values

func RegisterServiceAccountCompletionFunc

func RegisterServiceAccountCompletionFunc(cmd *cobra.Command, flagName string, connFunc factory.ConnectionFunc) error

RegisterNameFlagCompletionFunc adds the user list to flag dynamic completion

func RegisterUserCompletionFunc

func RegisterUserCompletionFunc(cmd *cobra.Command, flagName string, connFunc factory.ConnectionFunc) error

RegisterUserCompletionFunc adds the user list to flag dynamic completion

Types

type FlagOptions

type FlagOptions struct {
	Required func() error
}

FlagOptions defines additional flag options

func WithFlagOptions

func WithFlagOptions(cmd *cobra.Command, flagName string) *FlagOptions

WithFlagOptions returns additional functions to custom the default flag settings

type FlagSet

type FlagSet struct {
	*pflag.FlagSet
	// contains filtered or unexported fields
}

func NewFlagSet

func NewFlagSet(cmd *cobra.Command, localizer localize.Localizer) *FlagSet

NewFlagSet returns a new flag set with some common flags

func (*FlagSet) AddOutput

func (fs *FlagSet) AddOutput(output *string)

AddOutput adds an output flag to the command

func (*FlagSet) AddPage

func (fs *FlagSet) AddPage(page *int32)

AddPage adds a "page" flag to the command

func (*FlagSet) AddSize

func (fs *FlagSet) AddSize(page *int32)

AddSize adds a "size" flag to the command

func (*FlagSet) AddYes

func (fs *FlagSet) AddYes(yes *bool)

AddYes adds a "yes" flag to the command