cmdutil

Documentation

Index

• Variables
• func CheckAuth(cfg config.Config) bool
• func DetermineEditor(cf func() (config.Config, error)) (string, error)
• func DisableAuthCheck(cmd *cobra.Command)
• func EnableRepoOverride(cmd *cobra.Command, f *Factory)
• func ExactArgs(n int, msg string) cobra.PositionalArgs
• 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 NoArgsQuoteReminder(cmd *cobra.Command, args []string) error
• func ReadFile(filename string, stdin io.ReadCloser) ([]byte, error)
• type Factory
• type FlagError
  • func (fe FlagError) Error() string
  • func (fe FlagError) Unwrap() error

Variables

var CancelError = errors.New("CancelError")

CancelError signals user-initiated cancellation

var SilentError = 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 DetermineEditor

func DetermineEditor(cf func() (config.Config, error)) (string, error)

TODO: consider passing via Factory TODO: support per-hostname settings

func DisableAuthCheck

func DisableAuthCheck(cmd *cobra.Command)

func EnableRepoOverride

func EnableRepoOverride(cmd *cobra.Command, f *Factory)

func ExactArgs

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

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 NoArgsQuoteReminder

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

func ReadFile

func ReadFile(filename string, stdin io.ReadCloser) ([]byte, error)

Types

type Factory

type Factory struct {
	IOStreams  *iostreams.IOStreams
	HttpClient func() (*http.Client, error)
	BaseRepo   func() (ghrepo.Interface, error)
	Remotes    func() (context.Remotes, error)
	Config     func() (config.Config, error)
	Branch     func() (string, error)

	// Executable is the path to the currently invoked gh binary
	Executable string
}

type FlagError

type FlagError struct {
	Err error
}

FlagError is the kind of error raised in flag processing

func (FlagError) Error

func (fe FlagError) Error() string

func (FlagError) Unwrap

func (fe FlagError) Unwrap() error