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 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 OverrideBaseRepoFunc(f *Factory, override string) func() (ghrepo.Interface, error)
- func ReadFile(filename string, stdin io.ReadCloser) ([]byte, 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 Exporter
- type Factory
- type FlagError
- type JSONFlagError
- type NoResultsError
Constants ¶
This section is empty.
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 DetermineEditor ¶
TODO: consider passing via Factory TODO: support per-hostname settings
func DisableAuthCheck ¶
func EnableRepoOverride ¶
func FlagErrorWrap ¶
FlagError returns a new FlagError that wraps the specified error.
func FlagErrorf ¶
FlagErrorf returns a new FlagError that wraps an error produced by fmt.Errorf(format, args...).
func IsAuthCheckEnabled ¶
func IsUserCancellation ¶
func MinimumArgs ¶
func MinimumArgs(n int, msg string) cobra.PositionalArgs
func MutuallyExclusive ¶
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 OverrideBaseRepoFunc ¶
Types ¶
type Factory ¶
type Factory struct {
IOStreams *iostreams.IOStreams
Prompter prompter.Prompter
Browser browser.Browser
GitClient *git.Client
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
ExecutableName string
}
func (*Factory) Executable ¶
Executable is the path to the currently invoked binary
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.
type JSONFlagError ¶
type JSONFlagError struct {
// contains filtered or unexported fields
}
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
Source Files