common

Documentation

Index

• Constants
• type LogLevel
  • func LogLevelStringToIota(level string) (LogLevel, error)
  • func (ll LogLevel) String() string
• type OutputFormat
  • func OutputFormatStringToIota(format string) (OutputFormat, error)
  • func (of OutputFormat) String() string

Constants

const (
	// related to the --output flag
	DefaultOutputFormat = "text"
	OutputFlagName      = "output"
	OutputFlagShort     = "o"
	OutputConfigPath    = OutputFlagName

	// related to the --profile flag
	ProfileFlagName  = "profile"
	ProfileFlagShort = "p"

	// related to the --config-file flag
	ConfigFilePathFlagName = "config-file"

	// related to the --log-level flag
	LogLevelFlagName   = "log-level"
	DefaultLogLevel    = "info"
	LogLevelConfigPath = LogLevelFlagName
)

Types

type LogLevel

type LogLevel int

const (
	DEBUG LogLevel = iota
	INFO
	WARN
	ERROR
)

func LogLevelStringToIota

func LogLevelStringToIota(level string) (LogLevel, error)

func (LogLevel) String

func (ll LogLevel) String() string

type OutputFormat

type OutputFormat int

Represents an enum of valid values for the format of the output for this CLI execution

const (
	JSON OutputFormat = iota
	YAML
	TEXT
)

func OutputFormatStringToIota

func OutputFormatStringToIota(format string) (OutputFormat, error)

func (OutputFormat) String

func (of OutputFormat) String() string