mirror
/
viper
mirror of https://github.com/spf13/viper.git
1
0
Fork 1
Code Issues Packages Projects Releases Wiki Activity

Better comments for go doc

This commit is contained in:
spf13 2014-07-11 10:42:07 -04:00
parent c5a9056e3b
commit 38c6d9eca3
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
viper.go
View File

@ -44,6 +44,8 @@ var defaults map[string]interface{} = make(map[string]interface{})
var pflags map[string]*pflag.Flag = make(map[string]*pflag.Flag) var pflags map[string]*pflag.Flag = make(map[string]*pflag.Flag)
var aliases map[string]string = make(map[string]string) var aliases map[string]string = make(map[string]string)
// Explicitly define the path, name and extension of the config file
// Viper will use this and not check any of the config paths
func SetConfigFile(in string) { func SetConfigFile(in string) {
if in != "" { if in != "" {
configFile = in configFile = in
@ -54,6 +56,9 @@ func ConfigFileUsed() string {
return configFile return configFile
} }
// Add a path for viper to search for the config file in.
// Can be called multiple times to define multiple search paths.
func AddConfigPath(in string) { func AddConfigPath(in string) {
if in != "" { if in != "" {
absin := absPathify(in) absin := absPathify(in)
@ -118,6 +123,11 @@ func Marshal(rawVal interface{}) (err error) {
return return
} }
// Bind a specific key to a flag (as used by cobra)
//
// serverCmd.Flags().Int("port", 1138, "Port to run Application server on")
// viper.BindPFlag("port", serverCmd.Flags().Lookup("port"))
//
func BindPFlag(key string, flag *pflag.Flag) (err error) { func BindPFlag(key string, flag *pflag.Flag) (err error) {
if flag == nil { if flag == nil {
return fmt.Errorf("flag for %q is nil", key) return fmt.Errorf("flag for %q is nil", key)
@ -172,6 +182,8 @@ func find(key string) interface{} {
return nil return nil
} }
// Get returns an interface..
// Must be typecast or used by something that will typecast
func Get(key string) interface{} { func Get(key string) interface{} {
key = strings.ToLower(key) key = strings.ToLower(key)
v := find(key) v := find(key)
@ -202,6 +214,8 @@ func IsSet(key string) bool {
return t != nil return t != nil
} }
// Aliases provide another accessor for the same key.
// This enables one to change a name without breaking the application
func RegisterAlias(alias string, key string) { func RegisterAlias(alias string, key string) {
registerAlias(alias, strings.ToLower(key)) registerAlias(alias, strings.ToLower(key))
} }
@ -236,12 +250,16 @@ func InConfig(key string) bool {
return exists return exists
} }
// Set the default value for this key.
// Default only used when no value is provided by the user via flag, config or ENV.
func SetDefault(key string, value interface{}) { func SetDefault(key string, value interface{}) {
// If alias passed in, then set the proper default // If alias passed in, then set the proper default
key = realKey(strings.ToLower(key)) key = realKey(strings.ToLower(key))
defaults[key] = value defaults[key] = value
} }
// The user provided value (via flag)
// Will be used instead of values obtained via config file, ENV or default
func Set(key string, value interface{}) { func Set(key string, value interface{}) {
// If alias passed in, then set the proper override // If alias passed in, then set the proper override
key = realKey(strings.ToLower(key)) key = realKey(strings.ToLower(key))
@ -254,6 +272,8 @@ func (str UnsupportedConfigError) Error() string {
return fmt.Sprintf("Unsupported Config Type %q", string(str)) return fmt.Sprintf("Unsupported Config Type %q", string(str))
} }
// Viper will discover and load the configuration file from disk
// searching in one of the defined paths.
func ReadInConfig() error { func ReadInConfig() error {
jww.INFO.Println("Attempting to read in config file") jww.INFO.Println("Attempting to read in config file")
if !stringInSlice(getConfigType(), SupportedExts) { if !stringInSlice(getConfigType(), SupportedExts) {
@ -301,6 +321,8 @@ func insensativiseMap() {
} }
} }
// Name for the config file.
// Does not include extension.
func SetConfigName(in string) { func SetConfigName(in string) {
if in != "" { if in != "" {
configName = in configName = in