Clean APIs for your Go Applications. Inspired by functional options pattern.
package main
import (
"fmt"
"github.com/kataras/go-options"
)
type appOptions struct {
Name string
MaxRequests int
DevMode bool
EnableLogs bool
}
type app struct {
options appOptions
}
func newApp(setters ...options.OptionSetter) *app {
opts := appOptions{Name: "My App's Default Name"} // any default options here
options.Struct(&opts, setters...) // convert any dynamic options to the appOptions struct, fills non-default options from the setters
app := &app{options: opts}
return app
}
// Name sets the appOptions.Name field
// pass an (optionall) option via static func
func Name(val string) options.OptionSetter {
return options.Option("Name", val)
}
// Dev sets the appOptions.DevMode & appOptions.EnableLogs field
// pass an (optionall) option via static func
func Dev(val bool) options.OptionSetter {
return options.Options{"DevMode": val, "EnableLogs": val}
}
// and so on...
func passDynamicOptions() {
myApp := newApp(options.Options{"MaxRequests": 17, "DevMode": true})
fmt.Printf("passDynamicOptions: %#v\n", myApp.options)
}
func passDynamicOptionsAlternative() {
myApp := newApp(options.Option("MaxRequests", 17), options.Option("DevMode", true))
fmt.Printf("passDynamicOptionsAlternative: %#v\n", myApp.options)
}
func passFuncsOptions() {
myApp := newApp(Name("My name"), Dev(true))
fmt.Printf("passFuncsOptions: %#v\n", myApp.options)
}
// go run $GOPATH/github.com/kataras/go-options/example/main.go
func main() {
passDynamicOptions()
passDynamicOptionsAlternative()
passFuncsOptions()
}
The only requirement is the Go Programming Language, at least v1.7.
$ go get -u github.com/kataras/go-options
If you'd like to discuss this package, or ask questions about it, feel free to
- Explore these questions.
- Post an issue or idea here.
- Navigate to the Chat.
Current: v0.0.1
Read more about Semantic Versioning 2.0.0
- http://semver.org/
- https://en.wikipedia.org/wiki/Software_versioning
- https://wiki.debian.org/UpstreamGuide#Releases_and_Versions
The author of go-options is @kataras.
If you are interested in contributing to the go-options project, please make a PR.
This project is licensed under the MIT License.
License can be found here.