flag

Documentation

Index

• Constants
• Variables
• func SetModeFlag()
• type Flag
  • func (f *Flag) Set(value string) error
  • func (f *Flag) String() string
• type Logger
  • func NewLogger(logger commonlogger.Logger) (*Logger, error)
  • func (l *Logger) ModeFlagSet(mode *ModeFlag)
• type ModeFlag
  • func NewModeFlag(defaultValue string, allowed []string) *ModeFlag
  • func (m *ModeFlag) IsDev() bool
  • func (m *ModeFlag) IsProd() bool

Constants

const (
	// ModeDev is the development mode
	ModeDev = "dev"

	// ModeProd is the production mode
	ModeProd = "prod"
)

Variables

var Mode = NewModeFlag(ModeDev, []string{ModeDev, ModeProd})

Mode is the environment mode

var (
	NilModeFlagError = errors.New("mode flag cannot be nil")
)

Functions

func SetModeFlag

func SetModeFlag()

SetModeFlag sets the mode flag

Types

type Flag

type Flag struct {
	// contains filtered or unexported fields
}

Flag is a custom flag type

func (*Flag) Set

func (f *Flag) Set(value string) error

Set validates and sets the flag value

func (*Flag) String

func (f *Flag) String() string

String returns the string representation of the flag value

type Logger

type Logger struct {
	// contains filtered or unexported fields
}

Logger is the logger for the flag

func NewLogger

func NewLogger(logger commonlogger.Logger) (*Logger, error)

NewLogger is the logger for the flag

func (*Logger) ModeFlagSet

func (l *Logger) ModeFlagSet(mode *ModeFlag)

ModeFlagSet is the flag set for the mode

type ModeFlag

type ModeFlag struct {
	Flag
}

ModeFlag is a custom flag type for mode

func NewModeFlag

func NewModeFlag(defaultValue string, allowed []string) *ModeFlag

NewModeFlag creates a new ModeFlag with allowed values

func (*ModeFlag) IsDev

func (m *ModeFlag) IsDev() bool

IsDev returns true if the mode is development

func (*ModeFlag) IsProd

func (m *ModeFlag) IsProd() bool

IsProd returns true if the mode is production