flags

Documentation

Index

• Constants
• func AddGlobalFlags(cmd *cobra.Command, defaultInteractive bool)
• func FlagsInterceptor(streams ioutils.Streams) interceptors.Interceptor
• func FlagsInterceptorWithoutParser(streams ioutils.Streams) interceptors.Interceptor
• func NoFlagName(name string) string
• func RegisterNoableBool(flags *pflag.FlagSet, name string, value bool, usage string) *bool
• func RegisterNoableBoolP(flags *pflag.FlagSet, name string, shorthand string, defaultValue bool, ...) *bool
• type MultiString
  • func (s *MultiString) First() string
  • func (s *MultiString) Get() []string
  • func (s *MultiString) Set(value string) error
  • func (s *MultiString) String() string
  • func (s *MultiString) Type() string

Constants

const (
	AspectFlagPrefix              = "aspect:"
	AspectLockVersion             = AspectFlagPrefix + "lock_version"
	AspectConfigFlagName          = AspectFlagPrefix + "config"
	AspectSystemConfigFlagName    = AspectFlagPrefix + "system_config"
	AspectWorkspaceConfigFlagName = AspectFlagPrefix + "workspace_config"
	AspectHomeConfigFlagName      = AspectFlagPrefix + "home_config"
	AspectInteractiveFlagName     = AspectFlagPrefix + "interactive"
)

const (
	BoolFlagTrue  = "true"
	BoolFlagFalse = "false"
	BoolFlagYes   = "yes"
	BoolFlagNo    = "no"
	BoolFlag1     = "1"
	BoolFlag0     = "0"
)

const (
	// The prefix that Bazel & Aspect use for negative flags such as --nohome_rc && --aspect:nohome_config
	NoFlagPrefix = "no"
)

Functions

func AddGlobalFlags

func AddGlobalFlags(cmd *cobra.Command, defaultInteractive bool)

AddGlobalFlags will add Aspect specific flags to all cobra commands.

func FlagsInterceptor

func FlagsInterceptor(streams ioutils.Streams) interceptors.Interceptor

FlagsInterceptor will parse the incoming flags and remove any aspect specific flags or bazel startup flags from the list of args.

func FlagsInterceptorWithoutParser

func FlagsInterceptorWithoutParser(streams ioutils.Streams) interceptors.Interceptor

FlagsInterceptorWithoutParser will remove any aspect specific flags or bazel startup flags from the list of args.

func NoFlagName

func NoFlagName(name string) string

Prefixes a flag name with "no" to determine the Bazel negative flag from a flag name. Also takes into consideration the 'aspect:' prefix so that a flag such as 'aspect:foo' get a negative flag name of 'aspect:nofoo'. For example, `nohome_rc` is the negative of `home_rc` and `aspect:nohome_config` is the negative of 'aspect:home_config'

func RegisterNoableBool

func RegisterNoableBool(flags *pflag.FlagSet, name string, value bool, usage string) *bool

RegisterNoableBool registers a boolean flag that supports Bazel option parsing.

func RegisterNoableBoolP

func RegisterNoableBoolP(
	flags *pflag.FlagSet,
	name string,
	shorthand string,
	defaultValue bool,
	usage string) *bool

RegisterNoableBoolP registers a boolean flag that supports Bazel option parsing with a shorthand. https://bazel.build/reference/command-line-reference#option-syntax

By default the noable variants are -[no]foo which mimics how Bazel handles boolean flags. For Aspect CLI flags, which start with 'aspect:', the noable variants are --aspect:[no]foo.

This implementation normalizes any user-provided values before processing. Hence, `--foo=yes` is the same as `--foo=YES`.

Examples:

--foo
--nofoo
--foo=yes
--foo=no
--foo=1
--foo=0

Types

type MultiString

type MultiString struct {
	// contains filtered or unexported fields
}

MultiString is the golang implementation of bazel multi-string arguments that satisfies Value from cobra's Flags().Var functions.

func (*MultiString) First

func (s *MultiString) First() string

First satisfies Value from cobra's Flags().Var functions

func (*MultiString) Get

func (s *MultiString) Get() []string

func (*MultiString) Set

func (s *MultiString) Set(value string) error

Set satisfies Value from cobra's Flags().Var functions.

func (*MultiString) String

func (s *MultiString) String() string

String satisfies Value from cobra's Flags().Var functions.

func (*MultiString) Type

func (s *MultiString) Type() string

Type satisfies Value from cobra's Flags().Var functions.