glenux-archive/spf13--viper
1
0
Fork 0
mirror of https://github.com/spf13/viper synced 2024-05-18 02:36:43 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: propose deprecating the global Viper instance

Browse source 
Signed-off-by: Mark Sagi-Kazar <mark.sagikazar@gmail.com>
This commit is contained in:
Mark Sagi-Kazar 2021-09-23 10:07:37 +02:00
parent c943b3ef27
commit 99e9188c7c
No known key found for this signature in database
GPG key ID: 31AB0439F4C5C90E
2 changed files with 25 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/adr/0005-deprecate-setters-in-favor-of-functional-options-during-initialization.md
View file

@ -6,6 +6,8 @@ Date: 2021-07-20
Proposed
Referenced by [8. Deprecate the global Viper instance](0008-deprecate-the-global-viper-instance.md)
## Context
The Viper struct currently acts as a facade for reading, writing and watching configuration for changes.

23
docs/adr/0008-deprecate-the-global-viper-instance.md Normal file
View file

@ -0,0 +1,23 @@
# 8. Deprecate the global Viper instance
Date: 2021-09-23
## Status
Proposed
References [5. Deprecate setters in favor of functional options during initialization](0005-deprecate-setters-in-favor-of-functional-options-during-initialization.md)
## Context
With the deprecation of setters in favor of functional options, it becomes almost impossible to get away with instantiating Viper.
In addition to that, people should be discouraged from accessing a global Viper instance.
## Decision
Deprecate the global Viper instance and the global access functions.
## Consequences
People will still be able to create a global instance of their own,
but instantiating a custom Viper instance will become the primary solution for using Viper.