Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/theflyingcodr/goconfig
Strongly typed config for golang apps along with a viper implementation.
https://github.com/theflyingcodr/goconfig
Last synced: 9 days ago
JSON representation
Strongly typed config for golang apps along with a viper implementation.
- Host: GitHub
- URL: https://github.com/theflyingcodr/goconfig
- Owner: theflyingcodr
- License: mit
- Created: 2021-08-12T19:48:10.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-06-03T10:03:19.000Z (5 months ago)
- Last Synced: 2024-06-20T16:47:46.764Z (5 months ago)
- Language: Go
- Size: 8.39 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://github.com/theflyingcodr/goconfig/releases)
[](https://github.com/theflyingcodr/goconfig/actions)
[](https://goreportcard.com/report/github.com/theflyingcodr/goconfig)
[](https://golang.org/)
[![Mergify Status][mergify-status]][mergify]
[mergify]: https://mergify.io
[mergify-status]: https://img.shields.io/endpoint.svg?url=https://gh.mergify.io/badges/theflyingcodr/goconfig&style=flat
# goconfig
GoConfig provides strongly typed envrionment variable based configuration for go apps using a friendly Fluent API.
It comes with a viper implementation but others that implement the `ConfigurationLoader` interface can also be added.
Though it is billed as environment variable based, you can load configuration in however you wish, try to keep it 12 factor though with env vars.
## Useage
Useage is very simple, at the start of your main first load your defaults, I tend to have a method like `SetupDefaults` that contains all the
default settings for all environment variables in the application.
Directly after this, call goconfig as shown:
```go
func main(){
config.SetupDefaults()
cfg := goconfig.NewViperConfig("my-app").
WithServer().
WithDeployment().
WithDb().
Load()
}
```
With this simple syntax you can quickly glance at your main file and see the exact requirements for your application.
You can then reference configs directly rather than plucking them out of thin air throughput your code base.
For example, to get the server port do:
```go
svr := cfg.Server.Port
```
It is recommended that you use dependency injection rather than globals to pass these around, as such, they are all pointers.
```go
func NewImportantService(cfg *goconfig.Server){
cfg.Port
}
```
The above injection akes it 100% explicit as to the requirements of your service and is much easier tested than putting config readers throughout your code base.
### Http Clients
We also support setup of custom http clients, this can be done as shown:
```go
func main(){
config.SetupDefaults()
cfg := goconfig.NewViperConfig("my-app").
WithServer().
WithHTTPClient("my-service").
WithHttpClient("my-other-service").
Load()
}
```
Each of these gets its own config keyed off the service name as shown:
```go
EnvHTTPClientHost = "%s.client.host"
EnvHTTPClientPort = "%s.client.port"
...
```
In the case of my-service, it's environment config for host would be `MY-SERVICE.CLIENT.HOST`.
You can add as many as you need and can access them by calling `svcCfg := cfg.CustomHTTPClient("my-service)`.
## Contributing
Contributions are more than welcome, there is a limited set of configs available at present and I'll be adding them as I need them, so if you think you'd
like to use this library but has something missing, like a Cassandra config, either raise an issue, create a PR adding it or both ideally.