util

Documentation

Index

• Variables
• func CheckAuth(cfg config.Config) bool
• func DisableAuthCheck(cmd *cobra.Command)
• func ExactArgs(n int, msg string) cobra.PositionalArgs
• func FlagErrorWrap(err error) error
• func FlagErrorf(format string, args ...interface{}) error
• func IsAuthCheckEnabled(cmd *cobra.Command) bool
• func IsUserCancellation(err error) bool
• func MinimumArgs(n int, msg string) cobra.PositionalArgs
• func MutuallyExclusive(message string, conditions ...bool) error
• func NilBoolFlag(cmd *cobra.Command, p **bool, name string, shorthand string, usage string) *pflag.Flag
• func NilStringFlag(cmd *cobra.Command, p **string, name string, shorthand string, usage string) *pflag.Flag
• func NoArgsQuoteReminder(cmd *cobra.Command, args []string) error
• func RegisterBranchCompletionFlags(gitc gitClient, cmd *cobra.Command, flags ...string) error
• func StringEnumFlag(cmd *cobra.Command, p *string, name, shorthand, defaultValue string, ...) *pflag.Flag
• func StringSliceEnumFlag(cmd *cobra.Command, p *[]string, name, shorthand string, ...) *pflag.Flag
• type Authenticator
  • func NewPatAuthenticator(cfg config.Config) (instance Authenticator, err error)
• type CmdContext
  • func NewCmdContext() (ctx CmdContext, err error)
• type ExternalCommandExitError
  • func NewExternalCommandExitError(err *exec.ExitError) ExternalCommandExitError
  • func (e ExternalCommandExitError) Error() string
  • func (e ExternalCommandExitError) ExitCode() int
• type FlagError
  • func (fe *FlagError) Error() string
  • func (fe *FlagError) Unwrap() error
• type NoResultsError
  • func NewNoResultsError(message string) NoResultsError
  • func (e NoResultsError) Error() string

Variables

var ErrCancel = errors.New("CancelError")

CancelError signals user-initiated cancellation

var ErrSilent = errors.New("SilentError")

SilentError is an error that triggers exit code 1 without any error messaging

Functions

func CheckAuth

func CheckAuth(cfg config.Config) bool

func DisableAuthCheck

func DisableAuthCheck(cmd *cobra.Command)

func ExactArgs

func ExactArgs(n int, msg string) cobra.PositionalArgs

func FlagErrorWrap

func FlagErrorWrap(err error) error

FlagError returns a new FlagError that wraps the specified error.

func FlagErrorf

func FlagErrorf(format string, args ...interface{}) error

FlagErrorf returns a new FlagError that wraps an error produced by fmt.Errorf(format, args...).

func IsAuthCheckEnabled

func IsAuthCheckEnabled(cmd *cobra.Command) bool

func IsUserCancellation

func IsUserCancellation(err error) bool

func MinimumArgs

func MinimumArgs(n int, msg string) cobra.PositionalArgs

func MutuallyExclusive

func MutuallyExclusive(message string, conditions ...bool) error

func NilBoolFlag

func NilBoolFlag(cmd *cobra.Command, p **bool, name string, shorthand string, usage string) *pflag.Flag

NilBoolFlag defines a new flag with a bool pointer receiver. This is useful for differentiating between the flag being explicitly set to a false value and the flag not being passed at all.

func NilStringFlag

func NilStringFlag(cmd *cobra.Command, p **string, name string, shorthand string, usage string) *pflag.Flag

NilStringFlag defines a new flag with a string pointer receiver. This is useful for differentiating between the flag being set to a blank value and the flag not being passed at all.

func NoArgsQuoteReminder

func NoArgsQuoteReminder(cmd *cobra.Command, args []string) error

func RegisterBranchCompletionFlags

func RegisterBranchCompletionFlags(gitc gitClient, cmd *cobra.Command, flags ...string) error

RegisterBranchCompletionFlags suggests and autocompletes known remote git branches for flags passed

func StringEnumFlag

func StringEnumFlag(cmd *cobra.Command, p *string, name, shorthand, defaultValue string, options []string, usage string) *pflag.Flag

StringEnumFlag defines a new string flag that only allows values listed in options.

func StringSliceEnumFlag

func StringSliceEnumFlag(cmd *cobra.Command, p *[]string, name, shorthand string, defaultValues, options []string, usage string) *pflag.Flag

Types

type Authenticator

type Authenticator interface {
	GetAuthorizationHeader(organizationName string) (string, error)
}

func NewPatAuthenticator

func NewPatAuthenticator(cfg config.Config) (instance Authenticator, err error)

type CmdContext

type CmdContext interface {
	Prompter() (prompter.Prompter, error)
	Context() (context.Context, error)
	Config() (config.Config, error)
	Connection(organization string) (*azuredevops.Connection, error)
	IOStreams() (*iostreams.IOStreams, error)
	Printer(string) (printer.Printer, error)
	GitClient() (*git.Client, error)
}

func NewCmdContext

func NewCmdContext() (ctx CmdContext, err error)

type ExternalCommandExitError

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

func NewExternalCommandExitError

func NewExternalCommandExitError(err *exec.ExitError) ExternalCommandExitError

func (ExternalCommandExitError) Error

func (e ExternalCommandExitError) Error() string

func (ExternalCommandExitError) ExitCode

func (e ExternalCommandExitError) ExitCode() int

type FlagError

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

A *FlagError indicates an error processing command-line flags or other arguments. Such errors cause the application to display the usage message.

func (*FlagError) Error

func (fe *FlagError) Error() string

func (*FlagError) Unwrap

func (fe *FlagError) Unwrap() error

type NoResultsError

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

func NewNoResultsError

func NewNoResultsError(message string) NoResultsError

func (NoResultsError) Error

func (e NoResultsError) Error() string