errors

Documentation

Index

• Variables
• func Errorf(format string, args ...interface{}) error
• func New(msg string) error
• func Wrap(cause error, msg string) error
• func Wrapf(cause error, format string, args ...interface{}) error
• type Error
  • func NotImplementedError() *Error
  • func UnknownError(err error, message string) *Error
  • func WrapError(cause error, err Error) Error
  • func (e *Error) Error() string
• type Type

Variables

var NoAPIKeyMessage = `

` + wordwrap.WrapString("Running `fossa analyze` performs a dependency analysis and uploads the result to FOSSA. To run an analysis without uploading results, run:", width) + `
    
    ` + color.HiGreenString("fossa analyze --output") + `

` + wordwrap.WrapString("You can provide your API key by setting the $FOSSA_API_KEY environment variable. For example, try running:", width) + `
    
    ` + color.HiGreenString("FOSSA_API_KEY=<YOUR_API_KEY_HERE> $command") + `

` + wordwrap.WrapString("You can create an API key for your FOSSA account at:", width) + `
    
    ` + color.HiBlueString("$endpoint/account/settings/integrations/api_tokens") + `
`

var NotImplementedMessage = `This code path has not yet been implemented.`

var ReportBugMessage = `

` + color.HiYellowString("REPORTING A BUG:") + `
` + wordwrap.WrapString("Please try troubleshooting before filing a bug. If the suggestions do not help you can file a bug at "+color.HiBlueString("https://github.com/fossas/fossa-cli/issues/new")+".", width) + `
` + wordwrap.WrapString("Please attach the debug logs from:", width) + `
  
  ` + color.HiGreenString("fossa <cmd> --debug") + `
  
` + wordwrap.WrapString("For additional support, contact "+color.MagentaString("support@fossa.com")+".", width)

Functions

func Errorf

func Errorf(format string, args ...interface{}) error

func New

func New(msg string) error

func Wrap

func Wrap(cause error, msg string) error

func Wrapf

func Wrapf(cause error, format string, args ...interface{}) error

Types

type Error

type Error struct {
	ExitCode        int
	Cause           error  // Base error.
	Type            Type   // Type helps us tell the user to log an issue, go to docs, etc.
	Message         string // Help message for the user, contact support, opening an issue, etc.
	Troubleshooting string // Simple solution or debugging instructions.
	Link            string // Link to documentation or reference information.
}

Error is the fossa implementation of errors for providing user-friendly information.

func NotImplementedError

func NotImplementedError() *Error

NotImplemented should be used to signify that a code path is not yet implemented.

func UnknownError

func UnknownError(err error, message string) *Error

UnknownError creates a simple fossa error using an existing error and additional context.

func WrapError

func WrapError(cause error, err Error) Error

func (*Error) Error

func (e *Error) Error() string

type Type

type Type = int

const (
	User Type = iota
	Exec
	Unknown
	NotImplemented
)