Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ii64/go-binder
Go binding configuration and command flag made easy✨✨
https://github.com/ii64/go-binder
binder cli-flags config flags go golang json toml yaml
Last synced: 3 months ago
JSON representation
Go binding configuration and command flag made easy✨✨
- Host: GitHub
- URL: https://github.com/ii64/go-binder
- Owner: ii64
- License: mit
- Created: 2021-07-19T07:17:07.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-10-26T16:27:24.000Z (over 2 years ago)
- Last Synced: 2024-10-14T06:09:26.880Z (4 months ago)
- Topics: binder, cli-flags, config, flags, go, golang, json, toml, yaml
- Language: Go
- Homepage:
- Size: 2.34 MB
- Stars: 19
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](LICENSE)
[](https://pkg.go.dev/github.com/ii64/go-binder)
[](https://deepsource.io/gh/ii64/go-binder/?ref=repository-badge)
✨Binding configuration and command flag made easy!✨
You can use multiple keys tag to simplify the look like this [(supported feature\*\*)](https://github.com/golang/go/issues/40281):
```go
// single tag key
type MyConfig struct {
Token string `json:"token_json" xml:"token_xml" arg:"token" env:"token" environ:"TOKEN"`
}
// multiple tag keys
type MyConfig struct {
Token string `json xml bson yaml toml arg env:"token" environ:"TOKEN"`
}
```
Below is default mapping implementation of `binder.RegisterCmdArgs = defaultRegisterCmdArgsFlagStd` that use standard golang `flag` package to perform command flag.
The `` is a placeholder for parent key, `binder.BindArgs(Loaded, "my")` this case `` will be replaced with `my`, if there's field with type `struct` in the component, it'll be replaced to `my..`
| Tag | Go Code | Description |
| ----------------- | ------------------------------------------------------- | --------------------------------------------------------------------------------- |
| `arg:"token"` | `flag.StringVar(val, ".token", *val, argUsage)` | Used for binding flag with contextual key `` |
| `argx:"token"` | `flag.StringVar(val, "token", *val, argUsage)` | Used for binding flag |
| `bind:"log"` | _No equivalent_ | Used for binder to differ `struct` parent sub context `.log.` |
| `env:"token"` | `os.Getenv(".token")` | Used for binding to environment variable with contextual key `` |
| `environ:"token"` | `os.Getenv("token")` | Used for binding to environment |
| `usage:""` | Used as `argUsage` | Description for flag |
| `ignore:"true"` | _No equivalent_ | Ignore struct field |
| `bind:"abc"` | _No equivalent_ | Used for mapstructure (`bind` is default value of `binder.TagName`) |
Other:
- `arg` and `argx` (dedicated) basically has same function.
- `env` and `environ` (dedicated) basically has same function.
- Currently you can't have _dedicated key_ for configuration because the way it parsed is from _Unmarshaller_ that results in `map[string]interface{}`, but this definitely possible to implement.
More thing you can learn from the example below.
## Example
See more on [example](./_examples/) directory.
```text
$ ./main -h
Filename "config.json" ext ".json"
Usage of ./main:
-dedicatedArg string
-my.Ktes int
-my.Sub.Hello string
-my.Sub.PtrOfSub.YourName string
this is the usage
-my.Sub.SubOfSub.InSub
-my.count int
this is the usage (default 121)
-my.log.Directory string
-my.log.SubLog int
-my.log.filename string
-my.mycount int
this is the usage mycount
-my.mystring string
this is the usage mystring
-my.stringslice value
a string slice arg
-my.token string
(default "some default value")
```
### Note
Contributions are welcome
```text
**) Reverted feature as from 1.16 but found it useful
```
## License
[](https://opensource.org/licenses/MIT)