cmdutil

Documentation

Index

• Variables
• func AddJSONFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)
• 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 OverrideBaseRepoFunc(f *Factory, override string) func() (ghrepo.Interface, error)
• func ReadFile(filename string, stdin io.ReadCloser) ([]byte, error)
• type Browser
  • func NewBrowser(launcher string, stdout, stderr io.Writer) Browser
• type Exporter
• type Factory
• type FlagError
  • func (fe FlagError) Error() string
  • func (fe FlagError) Unwrap() error
• type JSONFlagError
• type TestBrowser
  • func (b *TestBrowser) Browse(url string) error
  • func (b *TestBrowser) BrowsedURL() string
  • func (b *TestBrowser) Verify(t _testing, url string)

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 AddJSONFlags

func AddJSONFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)

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 OverrideBaseRepoFunc

func OverrideBaseRepoFunc(f *Factory, override string) func() (ghrepo.Interface, error)

func ReadFile

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

Types

type Browser

type Browser interface {
	Browse(string) error
}

func NewBrowser

func NewBrowser(launcher string, stdout, stderr io.Writer) Browser

type Exporter

type Exporter interface {
	Fields() []string
	Write(io *iostreams.IOStreams, data interface{}) error
}

type Factory

type Factory struct {
	IOStreams *iostreams.IOStreams
	Browser   Browser

	HttpClient func() (*http.Client, error)
	BaseRepo   func() (ghrepo.Interface, error)
	Remotes    func() (context.Remotes, error)
	Config     func() (config.Config, error)
	Branch     func() (string, error)

	ExtensionManager extensions.ExtensionManager

	// 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

type JSONFlagError

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

type TestBrowser

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

func (*TestBrowser) Browse

func (b *TestBrowser) Browse(url string) error

func (*TestBrowser) BrowsedURL

func (b *TestBrowser) BrowsedURL() string

func (*TestBrowser) Verify

func (b *TestBrowser) Verify(t _testing, url string)