flag

Documentation

Overview

Package flag implements flag-related functionality.

Index

• Constants
• func Add(cmd *cobra.Command, flags ...Flag)
• func Args(ctx context.Context) []string
• func FirstArg(ctx context.Context) string
• func FromContext(ctx context.Context) *pflag.FlagSet
• func GetBool(ctx context.Context, name string) bool
• func GetOrg(ctx context.Context) string
• func GetString(ctx context.Context, name string) string
• func GetYes(ctx context.Context) bool
• func NewContext(ctx context.Context, fs *pflag.FlagSet) context.Context
• type Bool
  • func Yes() Bool
• type Flag
• type Int
• type String
  • func Org() String
• type StringSlice

Constants

const (
	// AccessTokenName denotes the name of the access token flag.
	AccessTokenName = "access-token"

	// VerboseName denotes the name of the verbose flag.
	VerboseName = "verbose"

	// JSONOutputName denotes the name of the json output flag.
	JSONOutputName = "json"

	// LocalOnlyName denotes the name of the local-only flag.
	LocalOnlyName = "local-only"

	// OrgName denotes the name of the org flag.
	OrgName = "org"

	// YesName denotes the name of the yes flag.
	YesName = "yes"
)

Functions

func Add

func Add(cmd *cobra.Command, flags ...Flag)

Add adds flag to cmd, binding them on v should v not be nil.

func Args

func Args(ctx context.Context) []string

Args is shorthand for FromContext(ctx).Args().

func FirstArg

func FirstArg(ctx context.Context) string

FirstArg returns the first arg ctx carries or an empty string in case ctx carries an empty argument set. It panics in case ctx carries no FlagSet.

func FromContext

func FromContext(ctx context.Context) *pflag.FlagSet

FromContext returns the FlagSet ctx carries. It panics in case ctx carries no FlagSet.

func GetBool

func GetBool(ctx context.Context, name string) bool

GetBool returns the value of the named boolean flag ctx carries. It panics in case ctx carries no flags or in case the named flag isn't a boolean one.

func GetOrg

func GetOrg(ctx context.Context) string

GetOrg is shorthand for GetString(ctx, OrgName).

func GetString

func GetString(ctx context.Context, name string) string

GetString returns the value of the named string flag ctx carries. It panics in case ctx carries no flags or in case the named flag isn't a string one.

func GetYes

func GetYes(ctx context.Context) bool

GetOrg is shorthand for GetBool(ctx, YesName).

func NewContext

func NewContext(ctx context.Context, fs *pflag.FlagSet) context.Context

NewContext derives a context that carries fs from ctx.

Types

type Bool

type Bool struct {
	Name        string
	Shorthand   string
	Description string
	Default     bool
	Hidden      bool
}

Bool wraps the set of boolean flags.

func Yes

func Yes() Bool

Yes returns a yes bool flag.

type Flag

type Flag interface {
	// contains filtered or unexported methods
}

Flag wraps the set of flags.

type Int

type Int struct {
	Name        string
	Shorthand   string
	Description string
	Default     int
	Hidden      bool
}

Int wraps the set of int flags.

type String

type String struct {
	Name        string
	Shorthand   string
	Description string
	Default     string
	ConfName    string
	EnvName     string
	Hidden      bool
}

String wraps the set of string flags.

func Org

func Org() String

Org returns an org string flag.

type StringSlice

type StringSlice struct {
	Name        string
	Shorthand   string
	Description string
	Default     []string
	ConfName    string
	EnvName     string
}

StringSlice wraps the set of string slice flags.