Documentation
¶
Index ¶
- Variables
- func AddFormatFlags(cmd *cobra.Command, exportTarget *Exporter)
- func AddGroup(parent *cobra.Command, title string, cmds ...*cobra.Command)
- func AddJSONFlags(cmd *cobra.Command, exportTarget *Exporter, fields []string)
- func AddJSONFlagsWithoutShorthand(cmd *cobra.Command, exportTarget *Exporter, fields []string)
- func CheckAuth(cfg gh.Config) bool
- func DetermineEditor(cf func() (gh.Config, error)) (string, error)
- func DisableAuthCheck(cmd *cobra.Command)
- func DisableAuthCheckFlag(flag *pflag.Flag)
- 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 GlobPaths(patterns []string) ([]string, 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 NewJSONExporter() *jsonExporter
- 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() (bbrepo.Interface, error)
- func Partition[T any](slice []T, predicate func(T) bool) ([]T, []T)
- func ReadFile(filename string, stdin io.ReadCloser) ([]byte, 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
- func StructExportData(s interface{}, fields []string) map[string]interface{}
- 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 PendingError = errors.New("PendingError")
PendingError signals nothing failed but something is pending
var SilentError = errors.New("SilentError")
SilentError is an error that triggers exit code 1 without any error messaging
Functions ¶
func AddFormatFlags ¶
func DetermineEditor ¶
TODO: consider passing via Factory TODO: support per-hostname settings
func DisableAuthCheck ¶
func DisableAuthCheckFlag ¶
func EnableRepoOverride ¶
func FlagErrorWrap ¶
FlagErrorWrap 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 GlobPaths ¶
GlobPaths expands a list of file patterns into a list of file paths. If no files match a pattern, that pattern will return an error. If no pattern is passed, this returns an empty list and no error.
For information on supported glob patterns, see https://pkg.go.dev/path/filepath#Match
func IsAuthCheckEnabled ¶
func IsUserCancellation ¶
func MinimumArgs ¶
func MinimumArgs(n int, msg string) cobra.PositionalArgs
func MutuallyExclusive ¶
func NewJSONExporter ¶
func NewJSONExporter() *jsonExporter
NewJSONExporter returns an Exporter to emit JSON.
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 ¶
func Partition ¶
Partition takes a slice of any type T and separates it into two slices of the same type based on the provided predicate function. Any item that returns true for the predicate will be included in the first slice returned, and any item that returns false for the predicate will be included in the second slice returned.
func RegisterBranchCompletionFlags ¶
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 StructExportData ¶
Basic function that can be used with structs that need to implement the exportable interface. It has numerous limitations so verify that it works as expected with the struct and fields you want to export. If it does not, then implementing a custom ExportData method is necessary. Perhaps this should be moved up into exportData for the case when a struct does not implement the exportable interface, but for now it will need to be explicitly used.
Types ¶
type Factory ¶
type Factory struct {
AppVersion string
ExecutableName string
Browser browser.Browser
GitClient *git.Client
IOStreams *iostreams.IOStreams
Prompter prompter.Prompter
BaseRepo func() (bbrepo.Interface, error)
Branch func() (string, error)
Config func() (gh.Config, error)
HttpClient func() (*http.Client, error)
// PlainHttpClient is a special HTTP client that does not automatically set
// auth and other headers. This is meant to be used in situations where the
// client needs to specify the headers itself (e.g. during login).
PlainHttpClient func() (*http.Client, error)
Remotes func() (context.Remotes, error)
}
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