--- a/vendor/github.com/spf13/viper/README.md Tue Aug 23 22:33:28 2022 +0200
+++ b/vendor/github.com/spf13/viper/README.md Tue Aug 23 22:39:43 2022 +0200
@@ -11,7 +11,7 @@
[](https://github.com/spf13/viper/actions?query=workflow%3ACI)
[](https://gitter.im/spf13/viper?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
[](https://goreportcard.com/report/github.com/spf13/viper)
-
+
[](https://pkg.go.dev/mod/github.com/spf13/viper)
**Go configuration with fangs!**
@@ -127,11 +127,11 @@
```go
if err := viper.ReadInConfig(); err != nil {
- if _, ok := err.(viper.ConfigFileNotFoundError); ok {
- // Config file not found; ignore error if desired
- } else {
- // Config file was found but another error was produced
- }
+ if _, ok := err.(viper.ConfigFileNotFoundError); ok {
+ // Config file not found; ignore error if desired
+ } else {
+ // Config file was found but another error was produced
+ }
}
// Config file found and successfully parsed
@@ -175,10 +175,10 @@
**Make sure you add all of the configPaths prior to calling `WatchConfig()`**
```go
-viper.WatchConfig()
viper.OnConfigChange(func(e fsnotify.Event) {
fmt.Println("Config file changed:", e.Name)
})
+viper.WatchConfig()
```
### Reading Config from io.Reader
@@ -354,7 +354,7 @@
i := viper.GetInt("flagname") // retrieve value from viper
- ...
+ // ...
}
```
@@ -503,18 +503,18 @@
// open a goroutine to watch remote changes forever
go func(){
for {
- time.Sleep(time.Second * 5) // delay after each request
+ time.Sleep(time.Second * 5) // delay after each request
- // currently, only tested with etcd support
- err := runtime_viper.WatchRemoteConfig()
- if err != nil {
- log.Errorf("unable to read remote config: %v", err)
- continue
- }
+ // currently, only tested with etcd support
+ err := runtime_viper.WatchRemoteConfig()
+ if err != nil {
+ log.Errorf("unable to read remote config: %v", err)
+ continue
+ }
- // unmarshal new config into our runtime config struct. you can also use channel
- // to implement a signal to notify the system of the changes
- runtime_viper.Unmarshal(&runtime_conf)
+ // unmarshal new config into our runtime config struct. you can also use channel
+ // to implement a signal to notify the system of the changes
+ runtime_viper.Unmarshal(&runtime_conf)
}
}()
```
@@ -546,7 +546,7 @@
```go
viper.GetString("logfile") // case-insensitive Setting & Getting
if viper.GetBool("verbose") {
- fmt.Println("verbose enabled")
+ fmt.Println("verbose enabled")
}
```
### Accessing nested keys
@@ -669,7 +669,7 @@
```go
cache1Config := viper.Sub("cache.cache1")
if cache1Config == nil { // Sub returns nil if the key cannot be found
- panic("cache configuration not found")
+ panic("cache configuration not found")
}
cache1 := NewCache(cache1Config)
@@ -681,10 +681,10 @@
```go
func NewCache(v *Viper) *Cache {
- return &Cache{
- MaxItems: v.GetInt("max-items"),
- ItemSize: v.GetInt("item-size"),
- }
+ return &Cache{
+ MaxItems: v.GetInt("max-items"),
+ ItemSize: v.GetInt("item-size"),
+ }
}
```
@@ -726,18 +726,18 @@
v := viper.NewWithOptions(viper.KeyDelimiter("::"))
v.SetDefault("chart::values", map[string]interface{}{
- "ingress": map[string]interface{}{
- "annotations": map[string]interface{}{
- "traefik.frontend.rule.type": "PathPrefix",
- "traefik.ingress.kubernetes.io/ssl-redirect": "true",
- },
- },
+ "ingress": map[string]interface{}{
+ "annotations": map[string]interface{}{
+ "traefik.frontend.rule.type": "PathPrefix",
+ "traefik.ingress.kubernetes.io/ssl-redirect": "true",
+ },
+ },
})
type config struct {
Chart struct{
- Values map[string]interface{}
- }
+ Values map[string]interface{}
+ }
}
var C config
@@ -778,6 +778,15 @@
Viper uses [github.com/mitchellh/mapstructure](https://github.com/mitchellh/mapstructure) under the hood for unmarshaling values which uses `mapstructure` tags by default.
+### Decoding custom formats
+
+A frequently requested feature for Viper is adding more value formats and decoders.
+For example, parsing character (dot, comma, semicolon, etc) separated strings into slices.
+
+This is already available in Viper using mapstructure decode hooks.
+
+Read more about the details in [this blog post](https://sagikazarmark.hu/blog/decoding-custom-formats-with-viper/).
+
### Marshalling to string
You may need to marshal all the settings held in viper into a string rather than write them to a file.
@@ -785,17 +794,17 @@
```go
import (
- yaml "gopkg.in/yaml.v2"
- // ...
+ yaml "gopkg.in/yaml.v2"
+ // ...
)
func yamlStringSettings() string {
- c := viper.AllSettings()
- bs, err := yaml.Marshal(c)
- if err != nil {
- log.Fatalf("unable to marshal config to YAML: %v", err)
- }
- return string(bs)
+ c := viper.AllSettings()
+ bs, err := yaml.Marshal(c)
+ if err != nil {
+ log.Fatalf("unable to marshal config to YAML: %v", err)
+ }
+ return string(bs)
}
```