Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/traefik/paerser
Loads configuration from many sources
https://github.com/traefik/paerser
cli-flags configuration environment-variables go golang golang-library json toml yaml
Last synced: 5 days ago
JSON representation
Loads configuration from many sources
- Host: GitHub
- URL: https://github.com/traefik/paerser
- Owner: traefik
- License: apache-2.0
- Created: 2020-08-15T21:30:26.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-29T08:17:40.000Z (4 months ago)
- Last Synced: 2024-12-28T15:02:29.752Z (12 days ago)
- Topics: cli-flags, configuration, environment-variables, go, golang, golang-library, json, toml, yaml
- Language: Go
- Homepage:
- Size: 109 KB
- Stars: 56
- Watchers: 16
- Forks: 19
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# Paerser
[](https://pkg.go.dev/github.com/traefik/paerser)
[](https://github.com/traefik/paerser/actions)
[](https://goreportcard.com/report/github.com/traefik/paerser)
## Features
Loads configuration from many sources:
- CLI flags
- Configuration files in YAML, TOML, JSON format
- Environment variables
It also provides a simple CLI commands handling system.
## Examples
### Configuration
#### CLI Flags
```go
package flag_test
import (
"log"
"github.com/davecgh/go-spew/spew"
"github.com/traefik/paerser/flag"
)
type ConfigExample struct {
Foo string
Bar Bar
Great bool
}
type Bar struct {
Sub *Sub
List []string
}
type Sub struct {
Name string
Value int
}
func ExampleDecode() {
args := []string{
"--foo=aaa",
"--great=true",
"--bar.list=AAA,BBB",
"--bar.sub.name=bbb",
"--bar.sub.value=6",
}
config := ConfigExample{}
err := flag.Decode(args, &config)
if err != nil {
log.Fatal(err)
}
spew.Config = spew.ConfigState{
Indent: "\t",
DisablePointerAddresses: true,
}
spew.Dump(config)
// Output:
// (flag_test.ConfigExample) {
// Foo: (string) (len=3) "aaa",
// Bar: (flag_test.Bar) {
// Sub: (*flag_test.Sub)({
// Name: (string) (len=3) "bbb",
// Value: (int) 6
// }),
// List: ([]string) (len=2 cap=2) {
// (string) (len=3) "AAA",
// (string) (len=3) "BBB"
// }
// },
// Great: (bool) true
// }
}
```
#### File
```go
package file_test
import (
"fmt"
"log"
"os"
"github.com/davecgh/go-spew/spew"
"github.com/traefik/paerser/file"
)
type ConfigExample struct {
Foo string
Bar Bar
Great bool
}
type Bar struct {
Sub *Sub
List []string
}
type Sub struct {
Name string
Value int
}
func ExampleDecode() {
tempFile, err := os.CreateTemp("", "paeser-*.yml")
if err != nil {
log.Fatal(err)
}
defer func() { _ = os.RemoveAll(tempFile.Name()) }()
data := `
foo: aaa
bar:
sub:
name: bbb
value: 6
list:
- AAA
- BBB
great: true
`
_, err = fmt.Fprint(tempFile, data)
if err != nil {
log.Fatal(err)
}
// Read configuration file
filePath := tempFile.Name()
config := ConfigExample{}
err = file.Decode(filePath, &config)
if err != nil {
log.Fatal(err)
}
spew.Config = spew.ConfigState{
Indent: "\t",
DisablePointerAddresses: true,
}
spew.Dump(config)
// Output:
// (file_test.ConfigExample) {
// Foo: (string) (len=3) "aaa",
// Bar: (file_test.Bar) {
// Sub: (*file_test.Sub)({
// Name: (string) (len=3) "bbb",
// Value: (int) 6
// }),
// List: ([]string) (len=2 cap=2) {
// (string) (len=3) "AAA",
// (string) (len=3) "BBB"
// }
// },
// Great: (bool) true
// }
}
```
#### Environment Variables
```go
package env_test
import (
"log"
"os"
"github.com/davecgh/go-spew/spew"
"github.com/traefik/paerser/env"
)
type ConfigExample struct {
Foo string
Bar Bar
Great bool
}
type Bar struct {
Sub *Sub
List []string
}
type Sub struct {
Name string
Value int
}
func ExampleDecode() {
_ = os.Setenv("MYAPP_FOO", "aaa")
_ = os.Setenv("MYAPP_GREAT", "true")
_ = os.Setenv("MYAPP_BAR_LIST", "AAA,BBB")
_ = os.Setenv("MYAPP_BAR_SUB_NAME", "bbb")
_ = os.Setenv("MYAPP_BAR_SUB_VALUE", "6")
config := ConfigExample{}
err := env.Decode(os.Environ(), "MYAPP_", &config)
if err != nil {
log.Fatal(err)
}
spew.Config = spew.ConfigState{
Indent: "\t",
DisablePointerAddresses: true,
}
spew.Dump(config)
// Output:
// (env_test.ConfigExample) {
// Foo: (string) (len=3) "aaa",
// Bar: (env_test.Bar) {
// Sub: (*env_test.Sub)({
// Name: (string) (len=3) "bbb",
// Value: (int) 6
// }),
// List: ([]string) (len=2 cap=2) {
// (string) (len=3) "AAA",
// (string) (len=3) "BBB"
// }
// },
// Great: (bool) true
// }
}
```
### CLI Commands
```go
TODO
```