https://github.com/nanvenomous/gofigure
https://github.com/nanvenomous/gofigure
command-line configuration configuration-management convenient declarative explicit functional-programming golang static
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/nanvenomous/gofigure
- Owner: nanvenomous
- License: gpl-3.0
- Created: 2023-05-13T22:49:26.000Z (over 2 years ago)
- Default Branch: mainline
- Last Pushed: 2023-05-14T19:52:08.000Z (over 2 years ago)
- Last Synced: 2025-04-12T23:09:13.531Z (6 months ago)
- Topics: command-line, configuration, configuration-management, convenient, declarative, explicit, functional-programming, golang, static
- Language: Go
- Homepage:
- Size: 21.5 KB
- Stars: 9
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
- License: LICENSE
Awesome Lists containing this project
README
# gofigure
Gofigure is an opinionated configuration library for go projects
### Install
```bash
go get github.com/nanvenomous/gofigure
```
### Example
- run this example directly at [examples/basic](https://github.com/nanvenomous/gofigure/tree/mainline/examples/basic)
```go
package main
import (
"fmt"
"github.com/nanvenomous/gofigure"
)
// name your project (to be used for directory naming)
const PROJECT_NAME = "my-gofigure-test-project"
// Define the structure of your config
type myGlobalConfigType struct {
User struct {
Name string `yaml:"name"`
Email string `yaml:"email"`
} `yaml:"user"`
VerbosityLevel uint8 `yaml:"verbosity_level"`
}
// Create a config entity, set default values (if desired)
var myGlobalConfig = &myGlobalConfigType{VerbosityLevel: 1}
// Define the explicit interface to your configuration
func SetUsername(unm string) {
gofigure.CheckErr(gofigure.GlobalConfig) // check for file/parsing errors only when accessing config, or replace with your own check, you do you, boo
myGlobalConfig.User.Name = unm
}
func Username() string {
gofigure.CheckErr(gofigure.GlobalConfig)
return myGlobalConfig.User.Name
}
func VerbosityLevel() uint8 {
gofigure.CheckErr(gofigure.GlobalConfig)
return myGlobalConfig.VerbosityLevel
}
func main() {
var err error
// initialize files, set defaults
gofigure.Setup(PROJECT_NAME)
gofigure.Register(gofigure.GlobalConfig, myGlobalConfig) // gofigure supports Global, Local, and Cache configurations
// access the config data
fmt.Println(Username()) // ""
SetUsername("nanvenomous") //
fmt.Println(Username()) // "nanvenomous"
fmt.Println(VerbosityLevel()) // 1
// write the config to disk, so you can get it on next program run
gofigure.WriteAll() // uses go standard lib to coose location by your project name and OS
// prints the paths to all your registered config files (in case your user is wondering :)
gofigure.Where() // output depends on your os & your project name
// remove all configuration files (really nice for uninstall scripts)
if err = gofigure.RemoveAll(); err != nil {
panic(err)
}
}
```
### Why
- **Functional api** (so the rest of your project **only needs to consume** the configuration)
- **Explicit** yet flexible set/get methods
- Handle errors... or don't
- Return errors or return a zero value
- Fail due to config only when config is needed
- Essentially it's up to you
- **Static** config
- In-code, automatic defaults that ship with your binary
- Config & file creation on start
- No need to guess if values exist (unless you want to)
- **Convenience methods** for anywhere in application lifecycle
- Write everything to disk
- List all registered configuration files
- Remove all configuration files (nice for uninstall scripts)