mirror of
https://github.com/spf13/viper.git
synced 2026-09-20 03:18:21 +00:00
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d51b70c9bd | ||
|
|
b39aa9e732 |
-126
@@ -1,126 +0,0 @@
|
||||
# Update Log
|
||||
|
||||
**This document details any major updates required to use new features or improvements in Viper.**
|
||||
|
||||
## v1.20.x
|
||||
|
||||
### New file searching API
|
||||
|
||||
Viper now includes a new file searching API that allows users to customize how Viper looks for config files.
|
||||
|
||||
Viper accepts a custom [`Finder`](https://pkg.go.dev/github.com/spf13/viper#Finder) interface implementation:
|
||||
|
||||
```go
|
||||
// Finder looks for files and directories in an [afero.Fs] filesystem.
|
||||
type Finder interface {
|
||||
Find(fsys afero.Fs) ([]string, error)
|
||||
}
|
||||
```
|
||||
|
||||
It is supposed to return a list of paths to config files.
|
||||
|
||||
The default implementation uses [github.com/sagikazarmark/locafero](https://github.com/sagikazarmark/locafero) under the hood.
|
||||
|
||||
You can supply your own implementation using `WithFinder`:
|
||||
|
||||
```go
|
||||
v := viper.NewWithOptions(
|
||||
viper.WithFinder(&MyFinder{}),
|
||||
)
|
||||
```
|
||||
|
||||
For more information, check out the [Finder examples](https://pkg.go.dev/github.com/spf13/viper#Finder)
|
||||
and the [documentation](https://pkg.go.dev/github.com/sagikazarmark/locafero) for the locafero package.
|
||||
|
||||
### New encoding API
|
||||
|
||||
Viper now allows customizing the encoding layer by providing an API for encoding and decoding configuration data:
|
||||
|
||||
```go
|
||||
// Encoder encodes Viper's internal data structures into a byte representation.
|
||||
// It's primarily used for encoding a map[string]any into a file format.
|
||||
type Encoder interface {
|
||||
Encode(v map[string]any) ([]byte, error)
|
||||
}
|
||||
|
||||
// Decoder decodes the contents of a byte slice into Viper's internal data structures.
|
||||
// It's primarily used for decoding contents of a file into a map[string]any.
|
||||
type Decoder interface {
|
||||
Decode(b []byte, v map[string]any) error
|
||||
}
|
||||
|
||||
// Codec combines [Encoder] and [Decoder] interfaces.
|
||||
type Codec interface {
|
||||
Encoder
|
||||
Decoder
|
||||
}
|
||||
```
|
||||
|
||||
By default, Viper includes the following codecs:
|
||||
|
||||
- JSON
|
||||
- TOML
|
||||
- YAML
|
||||
- Dotenv
|
||||
|
||||
The rest of the codecs are moved to [github.com/go-viper/encoding](https://github.com/go-viper/encoding)
|
||||
|
||||
Customizing the encoding layer is possible by providing a custom registry of codecs:
|
||||
|
||||
- [Encoder](https://pkg.go.dev/github.com/spf13/viper#Encoder) -> [EncoderRegistry](https://pkg.go.dev/github.com/spf13/viper#EncoderRegistry)
|
||||
- [Decoder](https://pkg.go.dev/github.com/spf13/viper#Decoder) -> [DecoderRegistry](https://pkg.go.dev/github.com/spf13/viper#DecoderRegistry)
|
||||
- [Codec](https://pkg.go.dev/github.com/spf13/viper#Codec) -> [CodecRegistry](https://pkg.go.dev/github.com/spf13/viper#CodecRegistry)
|
||||
|
||||
You can supply the registry of codecs to Viper using the appropriate `With*Registry` function:
|
||||
|
||||
```go
|
||||
codecRegistry := viper.NewCodecRegistry()
|
||||
|
||||
codecRegistry.RegisterCodec("myformat", &MyCodec{})
|
||||
|
||||
v := viper.NewWithOptions(
|
||||
viper.WithCodecRegistry(codecRegistry),
|
||||
)
|
||||
```
|
||||
|
||||
### BREAKING: HCL, Java properties, INI removed from core
|
||||
|
||||
In order to reduce third-party dependencies, Viper dropped support for the following formats from the core:
|
||||
|
||||
- HCL
|
||||
- Java properties
|
||||
- INI
|
||||
|
||||
You can still use these formats though by importing them from [github.com/go-viper/encoding](https://github.com/go-viper/encoding):
|
||||
|
||||
```go
|
||||
import (
|
||||
"github.com/go-viper/encoding/hcl"
|
||||
"github.com/go-viper/encoding/javaproperties"
|
||||
"github.com/go-viper/encoding/ini"
|
||||
)
|
||||
|
||||
codecRegistry := viper.NewCodecRegistry()
|
||||
|
||||
{
|
||||
codec := hcl.Codec{}
|
||||
|
||||
codecRegistry.RegisterCodec("hcl", codec)
|
||||
codecRegistry.RegisterCodec("tfvars", codec)
|
||||
|
||||
}
|
||||
|
||||
{
|
||||
codec := &javaproperties.Codec{}
|
||||
|
||||
codecRegistry.RegisterCodec("properties", codec)
|
||||
codecRegistry.RegisterCodec("props", codec)
|
||||
codecRegistry.RegisterCodec("prop", codec)
|
||||
}
|
||||
|
||||
codecRegistry.RegisterCodec("ini", ini.Codec{})
|
||||
|
||||
v := viper.NewWithOptions(
|
||||
viper.WithCodecRegistry(codecRegistry),
|
||||
)
|
||||
```
|
||||
+3
-3
@@ -6,7 +6,7 @@ replace github.com/spf13/viper => ../
|
||||
|
||||
require (
|
||||
github.com/sagikazarmark/crypt v0.26.0
|
||||
github.com/spf13/viper v1.20.1
|
||||
github.com/spf13/viper v1.20.0-alpha.6
|
||||
)
|
||||
|
||||
require (
|
||||
@@ -56,8 +56,8 @@ require (
|
||||
github.com/sagikazarmark/locafero v0.7.0 // indirect
|
||||
github.com/sourcegraph/conc v0.3.0 // indirect
|
||||
github.com/spf13/afero v1.12.0 // indirect
|
||||
github.com/spf13/cast v1.7.1 // indirect
|
||||
github.com/spf13/pflag v1.0.6 // indirect
|
||||
github.com/spf13/cast v1.7.0 // indirect
|
||||
github.com/spf13/pflag v1.0.5 // indirect
|
||||
github.com/subosito/gotenv v1.6.0 // indirect
|
||||
go.etcd.io/etcd/api/v3 v3.5.15 // indirect
|
||||
go.etcd.io/etcd/client/pkg/v3 v3.5.15 // indirect
|
||||
|
||||
+4
-4
@@ -256,10 +256,10 @@ github.com/sourcegraph/conc v0.3.0 h1:OQTbbt6P72L20UqAkXXuLOj79LfEanQ+YQFNpLA9yS
|
||||
github.com/sourcegraph/conc v0.3.0/go.mod h1:Sdozi7LEKbFPqYX2/J+iBAM6HpqSLTASQIKqDmF7Mt0=
|
||||
github.com/spf13/afero v1.12.0 h1:UcOPyRBYczmFn6yvphxkn9ZEOY65cpwGKb5mL36mrqs=
|
||||
github.com/spf13/afero v1.12.0/go.mod h1:ZTlWwG4/ahT8W7T0WQ5uYmjI9duaLQGy3Q2OAl4sk/4=
|
||||
github.com/spf13/cast v1.7.1 h1:cuNEagBQEHWN1FnbGEjCXL2szYEXqfJPbP2HNUaca9Y=
|
||||
github.com/spf13/cast v1.7.1/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
|
||||
github.com/spf13/pflag v1.0.6 h1:jFzHGLGAlb3ruxLB8MhbI6A8+AQX/2eW4qeyNZXNp2o=
|
||||
github.com/spf13/pflag v1.0.6/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||
github.com/spf13/cast v1.7.0 h1:ntdiHjuueXFgm5nzDRdOS4yfT43P5Fnud6DH50rz/7w=
|
||||
github.com/spf13/cast v1.7.0/go.mod h1:ancEpBxwJDODSW/UG4rDrAqiKolqNNh2DX3mk86cAdo=
|
||||
github.com/spf13/pflag v1.0.5 h1:iy+VFUOCP1a+8yFto/drg2CJ5u0yRoB7fZw3DKv/JXA=
|
||||
github.com/spf13/pflag v1.0.5/go.mod h1:McXfInJRrz4CZXVZOBLb0bTZqETkiAhM9Iw0y3An2Bg=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/objx v0.1.1/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/objx v0.4.0/go.mod h1:YvHI0jy2hoMjB+UWwv71VJQ9isScKT/TqJzVSSt89Yw=
|
||||
|
||||
@@ -1535,29 +1535,27 @@ func (v *Viper) MergeInConfig() error {
|
||||
func ReadConfig(in io.Reader) error { return v.ReadConfig(in) }
|
||||
|
||||
func (v *Viper) ReadConfig(in io.Reader) error {
|
||||
config := make(map[string]any)
|
||||
|
||||
err := v.unmarshalReader(in, config)
|
||||
if err != nil {
|
||||
return err
|
||||
if v.configType == "" {
|
||||
return errors.New("cannot decode configuration: config type is not set")
|
||||
}
|
||||
|
||||
v.config = config
|
||||
|
||||
return nil
|
||||
v.config = make(map[string]any)
|
||||
return v.unmarshalReader(in, v.config)
|
||||
}
|
||||
|
||||
// MergeConfig merges a new configuration with an existing config.
|
||||
func MergeConfig(in io.Reader) error { return v.MergeConfig(in) }
|
||||
|
||||
func (v *Viper) MergeConfig(in io.Reader) error {
|
||||
config := make(map[string]any)
|
||||
|
||||
if err := v.unmarshalReader(in, config); err != nil {
|
||||
return err
|
||||
if v.configType == "" {
|
||||
return errors.New("cannot decode configuration: config type is not set")
|
||||
}
|
||||
|
||||
return v.MergeConfigMap(config)
|
||||
cfg := make(map[string]any)
|
||||
if err := v.unmarshalReader(in, cfg); err != nil {
|
||||
return err
|
||||
}
|
||||
return v.MergeConfigMap(cfg)
|
||||
}
|
||||
|
||||
// MergeConfigMap merges the configuration from the map given with an existing config.
|
||||
@@ -1664,21 +1662,15 @@ func (v *Viper) writeConfig(filename string, force bool) error {
|
||||
}
|
||||
|
||||
func (v *Viper) unmarshalReader(in io.Reader, c map[string]any) error {
|
||||
format := strings.ToLower(v.getConfigType())
|
||||
if format == "" {
|
||||
return errors.New("cannot decode configuration: unable to determine config type")
|
||||
}
|
||||
|
||||
buf := new(bytes.Buffer)
|
||||
buf.ReadFrom(in)
|
||||
|
||||
// TODO: remove this once SupportedExts is deprecated/removed
|
||||
format := strings.ToLower(v.getConfigType())
|
||||
|
||||
if !slices.Contains(SupportedExts, format) {
|
||||
return UnsupportedConfigError(format)
|
||||
}
|
||||
|
||||
// TODO: return [UnsupportedConfigError] if the registry does not contain the format
|
||||
// TODO: consider deprecating this error type
|
||||
decoder, err := v.decoderRegistry.Decoder(format)
|
||||
if err != nil {
|
||||
return ConfigParseError{err}
|
||||
|
||||
@@ -1542,14 +1542,6 @@ func TestReadConfig(t *testing.T) {
|
||||
})
|
||||
}
|
||||
|
||||
func TestReadConfigWithSetConfigFile(t *testing.T) {
|
||||
v := New()
|
||||
v.SetConfigFile("config.yaml") // Dummy value to infer config type from file extension
|
||||
err := v.ReadConfig(bytes.NewBuffer(yamlMergeExampleSrc))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, 45000, v.GetInt("hello.pop"))
|
||||
}
|
||||
|
||||
func TestIsSet(t *testing.T) {
|
||||
v := New()
|
||||
v.SetConfigType("yaml")
|
||||
@@ -2067,14 +2059,6 @@ func TestMergeConfig(t *testing.T) {
|
||||
assert.Equal(t, "bar", v.GetString("fu"))
|
||||
}
|
||||
|
||||
func TestMergeConfigWithSetConfigFile(t *testing.T) {
|
||||
v := New()
|
||||
v.SetConfigFile("config.yaml") // Dummy value to infer config type from file extension
|
||||
err := v.MergeConfig(bytes.NewBuffer(yamlMergeExampleSrc))
|
||||
require.NoError(t, err)
|
||||
assert.Equal(t, 45000, v.GetInt("hello.pop"))
|
||||
}
|
||||
|
||||
func TestMergeConfigOverrideType(t *testing.T) {
|
||||
v := New()
|
||||
v.SetConfigType("json")
|
||||
|
||||
Reference in New Issue
Block a user