config

package

v1.2.3 Latest Latest Go to latest Published: Feb 17, 2023 License: MIT Imports: 14 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cr1cr1/go-commons

Documentation ¶

Index ¶

func AppendStringArgs(cmd *cobra.Command, args []string, key string) []string
func AppendStringArgsf(cmd *cobra.Command, args []string, key string, format string) []string
func AppendStringSplitArgs(cmd *cobra.Command, args []string, key string, splitPattern string) []string
func CheckRequiredFlags(cmd *cobra.Command, requiredFlags []string)
func InitConfig(opts *Opts)
func PrefixKey(cmd *cobra.Command, keyName string) string
func ViperBindPFlag(cmd *cobra.Command, name string)
func ViperBindPFlagSet(cmd *cobra.Command, flags *pflag.FlagSet)
func ViperBindPersistentPFlag(cmd *cobra.Command, name string)
func ViperGetBool(cmd *cobra.Command, key string) bool
func ViperGetDuration(cmd *cobra.Command, key string) time.Duration
func ViperGetInt(cmd *cobra.Command, key string) int
func ViperGetString(cmd *cobra.Command, key string) string
func ViperIsSet(cmd *cobra.Command, key string) bool
func ViperSet(cmd *cobra.Command, key, value string)
type Opts
- func DefaultConfigOpts(opts *Opts) *Opts

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func AppendStringArgs ¶

func AppendStringArgs(cmd *cobra.Command, args []string, key string) []string

AppendStringArgs appends viper value to existing args slice

func AppendStringArgsf ¶

func AppendStringArgsf(cmd *cobra.Command, args []string, key string, format string) []string

AppendStringArgsf appends viper value to existing args slice with optional formatted output with key and value

func AppendStringSplitArgs ¶

func AppendStringSplitArgs(cmd *cobra.Command, args []string, key string, splitPattern string) []string

AppendSplitArgs appends viper value to existing args slice after splitting them by splitPattern (default regex whitespace)

func CheckRequiredFlags ¶

func CheckRequiredFlags(cmd *cobra.Command, requiredFlags []string)

CheckRequiredFlags exits with error when one ore more required flags are not set

func InitConfig ¶

func InitConfig(opts *Opts)

InitConfig reads in config file and ENV variables if set.

func PrefixKey ¶

func PrefixKey(cmd *cobra.Command, keyName string) string

PrefixKey prepends current and parent Use to specified key name

func ViperBindPFlag ¶

func ViperBindPFlag(cmd *cobra.Command, name string)

ViperBindPFlag is a convenience wrapper over viper.BindPFlag for local flags

func ViperBindPFlagSet ¶ added in v1.2.3

func ViperBindPFlagSet(cmd *cobra.Command, flags *pflag.FlagSet)

ViperBindPFlagSet is a convenience wrapper over viper.BindPFlag for local FlagSet

if flags is nil, the cmd.Flags() will be used

func ViperBindPersistentPFlag ¶

func ViperBindPersistentPFlag(cmd *cobra.Command, name string)

ViperBindPersistentPFlag is a convenience wrapper over viper.BindPFlag for persistent flags

func ViperGetBool ¶

func ViperGetBool(cmd *cobra.Command, key string) bool

ViperGetBool is a convenience wrapper returning bool value

func ViperGetDuration ¶

func ViperGetDuration(cmd *cobra.Command, key string) time.Duration

ViperGetDuration is a convenience wrapper returning duration value

func ViperGetInt ¶

func ViperGetInt(cmd *cobra.Command, key string) int

ViperGetInt is a convenience wrapper returning string value

func ViperGetString ¶

func ViperGetString(cmd *cobra.Command, key string) string

ViperGetString is a convenience wrapper returning string value

func ViperIsSet ¶

func ViperIsSet(cmd *cobra.Command, key string) bool

ViperIsSet is a convenience wrapper returning true if a key is set

func ViperSet ¶ added in v1.2.3

func ViperSet(cmd *cobra.Command, key, value string)

ViperSet is a convenience wrapper setting an override value for specified key

Types ¶

type Opts ¶

type Opts struct {
	EnvPrefix       string
	ConfigType      string
	ConfigName      string
	UserConfigPaths []string
	LogLevelKey     string
	LogFormatKey    string
	Flags           *pflag.FlagSet
}

func DefaultConfigOpts ¶ added in v1.2.0

func DefaultConfigOpts(opts *Opts) *Opts

DefaultConfigOpts sets default ConfigOpts if uninitialized or fields are empty

Source Files ¶

View all Source files

config.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL