cli/pkg/cmdutil/errors.go
Wing 57c9ee0ad2 Add tests for secret commands
Co-authored-by: William Martin <williammartin@github.com>
2025-01-15 14:55:16 +01:00

86 lines
2.1 KiB
Go

package cmdutil
import (
"errors"
"fmt"
"github.com/AlecAivazis/survey/v2/terminal"
ghContext "github.com/cli/cli/v2/context"
)
// FlagErrorf returns a new FlagError that wraps an error produced by
// fmt.Errorf(format, args...).
func FlagErrorf(format string, args ...interface{}) error {
return FlagErrorWrap(fmt.Errorf(format, args...))
}
// FlagErrorWrap returns a new FlagError that wraps the specified error.
func FlagErrorWrap(err error) error { return &FlagError{err} }
// A *FlagError indicates an error processing command-line flags or other arguments.
// Such errors cause the application to display the usage message.
type FlagError struct {
// Note: not struct{error}: only *FlagError should satisfy error.
err error
}
func (fe *FlagError) Error() string {
return fe.err.Error()
}
func (fe *FlagError) Unwrap() error {
return fe.err
}
// SilentError is an error that triggers exit code 1 without any error messaging
var SilentError = errors.New("SilentError")
// CancelError signals user-initiated cancellation
var CancelError = errors.New("CancelError")
// PendingError signals nothing failed but something is pending
var PendingError = errors.New("PendingError")
func IsUserCancellation(err error) bool {
return errors.Is(err, CancelError) || errors.Is(err, terminal.InterruptErr)
}
func MutuallyExclusive(message string, conditions ...bool) error {
numTrue := 0
for _, ok := range conditions {
if ok {
numTrue++
}
}
if numTrue > 1 {
return FlagErrorf("%s", message)
}
return nil
}
func ValidateHasOnlyOneRemote(hasRepoOverride bool, remotes func() (ghContext.Remotes, error)) error {
if !hasRepoOverride && remotes != nil {
remotes, err := remotes()
if err != nil {
return err
}
if remotes.Len() > 1 {
return fmt.Errorf("multiple remotes detected %v. please specify which repo to use by providing the -R or --repo argument", remotes)
}
}
return nil
}
type NoResultsError struct {
message string
}
func (e NoResultsError) Error() string {
return e.message
}
func NewNoResultsError(message string) NoResultsError {
return NoResultsError{message: message}
}