cmd

Documentation

Index

• Constants
• Variables
• func DisableColor(noColor bool)
• func EnvOrDefault(key string, defaultVal string) string
• func Exit(err error)
• func ExitWithVersion()
• func VerifyBuildpackAPI(kind, name, requested string, logger log.Logger) error
• func VerifyPlatformAPI(requested string, logger log.Logger) error
• type BuildpackAPIVerifier
  • func (v *BuildpackAPIVerifier) VerifyBuildpackAPI(kind, name, requested string, logger log.Logger) error
• type ErrorFail
  • func FailCode(code int, action ...string) *ErrorFail
  • func FailErr(err error, action ...string) *ErrorFail
  • func FailErrCode(err error, code int, action ...string) *ErrorFail
  • func (e *ErrorFail) Error() string

Constants

const (
	EnvDeprecationMode     = "CNB_DEPRECATION_MODE"
	DefaultDeprecationMode = ModeWarn

	ModeQuiet = "quiet"
	ModeWarn  = "warn"
	ModeError = "error"
)

const (
	CodeForFailed = 1
	// 2: reserved
	CodeForInvalidArgs = 3

	CodeForIncompatiblePlatformAPI  = 11
	CodeForIncompatibleBuildpackAPI = 12
)

Variables

var (
	DefaultLogger = log.NewDefaultLogger(Stdout)
	Stdout        = color.NewConsole(os.Stdout)
	Stderr        = color.NewConsole(os.Stderr)
)

var (
	// Version is the version of the lifecycle and all produced binaries.
	Version = "0.0.0"
	// SCMCommit is the commit information provided by SCM.
	SCMCommit = ""
	// SCMRepository is the source repository.
	SCMRepository = ""
)

The following variables are injected at compile time.

var DeprecationMode = EnvOrDefault(EnvDeprecationMode, DefaultDeprecationMode)

Functions

func DisableColor

func DisableColor(noColor bool)

func EnvOrDefault

func EnvOrDefault(key string, defaultVal string) string

func Exit

func Exit(err error)

func ExitWithVersion

func ExitWithVersion()

func VerifyBuildpackAPI

func VerifyBuildpackAPI(kind, name, requested string, logger log.Logger) error

func VerifyPlatformAPI

func VerifyPlatformAPI(requested string, logger log.Logger) error

Types

type BuildpackAPIVerifier

type BuildpackAPIVerifier struct{}

func (*BuildpackAPIVerifier) VerifyBuildpackAPI

func (v *BuildpackAPIVerifier) VerifyBuildpackAPI(kind, name, requested string, logger log.Logger) error

type ErrorFail

type ErrorFail struct {
	Err    error
	Code   int
	Action []string
}

func FailCode

func FailCode(code int, action ...string) *ErrorFail

func FailErr

func FailErr(err error, action ...string) *ErrorFail

func FailErrCode

func FailErrCode(err error, code int, action ...string) *ErrorFail

func (*ErrorFail) Error

func (e *ErrorFail) Error() string