Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/xsam/go-hybrid
libs and tools for Golang
https://github.com/xsam/go-hybrid
cli cmdline golang hybrid library utility
Last synced: 3 months ago
JSON representation
libs and tools for Golang
- Host: GitHub
- URL: https://github.com/xsam/go-hybrid
- Owner: XSAM
- License: bsd-3-clause
- Created: 2020-03-14T07:59:45.000Z (almost 5 years ago)
- Default Branch: master
- Last Pushed: 2023-05-05T02:31:38.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T20:18:19.939Z (4 months ago)
- Topics: cli, cmdline, golang, hybrid, library, utility
- Language: Go
- Homepage:
- Size: 135 KB
- Stars: 6
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# go-hybrid
[](https://coveralls.io/github/XSAM/go-hybrid?branch=master)
[](https://goreportcard.com/report/github.com/XSAM/go-hybrid)
[](https://pkg.go.dev/mod/github.com/XSAM/go-hybrid)
This repository provides common utility packages for Golang. Such as `log`, `error` and `cmdutil` lib.
- [go-hybrid](#go-hybrid)
- [Installation](#installation)
- [Example](#example)
- [Packages](#packages)
- [cmdutil](#cmdutil)
- [Flag rules and variables](#flag-rules-and-variables)
- [errorw](#errorw)
- [log](#log)
- [metadata](#metadata)
- [builtinutil](#builtinutil)
# Installation
```bash
go get github.com/XSAM/go-hybrid
```
# [Example](_example/)
```
make
./bin/example
```
# Packages
## [cmdutil](https://pkg.go.dev/github.com/XSAM/go-hybrid/cmdutil)
`cmdutil` offer `ResolveFlagVariable` to register a struct field into [cobra](https://github.com/spf13/cobra) as a flag.
For example:
```golang
type Flag struct {
Number int `flag:"env"`
Duration time.Duration `flag-usage:"change the duration"`
}
var flag Flag
var cmd cobra.Command
cmdutil.ResolveFlagVariable(&cmd, &flag)
```
`ResolveFlagVariable` will resolve struct through the struct tag. So there is no need to invoke `cmd.PersistentFlags()`, `ResolveFlagVariable` already do that for you.
Furthermore, `ResolveFlagVariable` extends the ability of `cobra`, it can automatically read the environment variable if you like. Simply add `env` to the `flag:""`.
The priority of the value assignment is:
`flag parameter > environment variable > default value`
For instance, setting a variable though a flag parameter and an environment variable at the same time, the variable value will be the flag parameter value.
### Flag rules and variables
Add `flag:""` or `flag-usage:""` to the struct tag and let `cmdutil` know that you want to resolve this variable.
Use `flag-usage` to add usage for a flag.
| key | example | description | |
|------|---------------------|--------------------------------------------------|---|
| env | `env`, `env=true` | read environment variable. | |
| name | `name=foo` | not like generated name? use it to overwrite it. | |
| flat | `flat`, `flat=true` | ignore prefix name. | |
Currently supported type: `bool`, `string`, `int`, `int32`, `int64`, `time.Duration`, `[]int`, `[]time.Duration`, `[]string`, `[]bool`, `map[string]string`, `map[string]int`
## [errorw](https://pkg.go.dev/github.com/XSAM/go-hybrid/errorw)
`errrow` is an error type which wraps fields and callstack. It implements `stackTracer`, `causer`, `GRPCStatus` and `zapcore.ObjectMarshaler` interface.
Also, it uses gRPC status as an API error. So it can be directly returned as a gRPC error.
[grpc-gateway](https://github.com/grpc-ecosystem/grpc-gateway/blob/554b3dac4972c2957a8bc8e8ba15a241a6352b93/runtime/errors.go#L16) provides an approach that converting a gRPC error code into the corresponding HTTP response status. Therefore, you can use it even you want HTTP status codes.
## [log](https://pkg.go.dev/github.com/XSAM/go-hybrid/log)
`log` wraps [zap](go.uber.org/zap) as logger. It mainly provides `BgLogger()` and `Logger(ctx context.Context)` to access a concrete logger.
And, it provides customized preset config to control the log output style, such as `JSON` and `Text` style. You can use `environment` package to switch it. Check [this file](environment/service.go) for more details.
## [metadata](https://pkg.go.dev/github.com/XSAM/go-hybrid/metadata)
You can inject some const variables relevant to the program itself, such as *gitVersion*, *gitCommit*, *gitBranch* and *buildTime*. Then you can fetch these variables from `metadata.AppInfo`.
Also, you can use `cmdutil.Version` to add `version` command to `cobra`.
You can check out [Makefile](./Makefile) and learn how to inject these variables.
## [builtinutil](https://pkg.go.dev/github.com/XSAM/go-hybrid/builtinutil)
Providing `UserHomeDir`, `Recovery` and `WrappedGo`
`WrappedGo` wraps a goroutine with a recovery. So you will not worry about forget to recover a goroutine.