This Golang package helps to load values from configuration files, most specifically json and yaml types. For .env, .properties or toml extensions, please checkout for another great packages to solve your context:
- Golang 1.21
Config Loader are the main structure in the package. It will provide the Parse() function to read values from config file, returning the map[string]interface{}.
type FileProperties struct {
Name_ string `json:"name"`
Type_ string `json:"type"`
PathLocations_ []string `json:"path_locations"`
FinalPath string `json:"final_path"`
}| Property | Description |
|---|---|
| Name | Name of config file |
| Type | Specifies the type of file (yaml or json) |
| PathLocations | List of paths according to the context (local environment, container, CI/CD etc.) |
| FinalPath | After parse, this properties will have the definitive config file path location |
example.yaml
AppName: "my-app"
Version: "1.0.0"
LogLevel: 0Basic implementation
import(
// another imports here
configloader "github.com/eviccari/config-loader"
)
func main() {
cl := configLoader.New().
Name("app").
FileType(filehandlers.YML).
PathLocations(".", "./configs"). // assuming that file location is . or ./configs
Build()
configs, err := cl.Parse()
if err != nil {
panic(err)
}
fmt.Println(configs["AppName"])
fmt.Println(fp.FinalPath)
}The output:
$ go run main.go
my-app
./configsAlso, you can bind configs into another more complex struct using golang json package:
example2.yaml
app_name: "my-app"
app_version: "1.0.0"
log_level: 0
api:
port: 3000
path: "/"import(
// another imports here
configloader "github.com/eviccari/config-loader"
)
type MyConf struct {
AppName string `json:"app_name"`
AppVersion string `json:"app_version"`
LogLevel int `json:"log_level"`
API struct {
Port int `json:"port"`
Path string `json:"path"`
} `json:"api"`
}
func main() { // Error handling are ignored to simplify, do not that in your app ;)
cl := configloader.New().
Name("example2").
FileType(configloader.YAML).
PathLocations(".", "./configs-test").
Build()
configs, _ := cl.Parse()
configsAsBytes, _ := json.Marshal(configs)
myConf := MyConf{}
json.Unmarshal(configsAsBytes, &myConf)
fmt.Println(myConf.API.Port)
}The output:
$ go run main.go
3000Thank you! Enjoy!
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent