README
¶
Gommon - Go common libraries
Gommon is a collection of common util libraries written in Go.
It has the following components:
- errors error wrapping, inspection, multi error (error list), common error types
- log fine grained level control and reasonable performance
- noodle embed static assets for web application with
.noodleignoresupport - generator render go template, generate methods for logger interface based on
gommon.yml - structure data structure like Set etc. to go
- util small utils over standard libraries utils
Legacy
- config v1 A YAML config reader with template support
- log v1 A logrus like structured logger
- runner A os/exec wrapper
- requests A pythonic wrapper for
net/http, HTTP for Gopher
Dependencies
Currently we only have one non standard library dependencies (cmd and examples are not considered), see Gopkg.lock
- go-yaml/yaml for read config written in YAML
- we don't need most feature of YAML, and want to have access to the parser directly to report which line has incorrect semantic (after checking it in application).
- might write one in ANTLR
- we also have a DSL work in progress RCL: Reika Configuration Language, which is like HCL
- we don't need most feature of YAML, and want to have access to the parser directly to report which line has incorrect semantic (after checking it in application).
Removed
- pkg/errors for including context in error, removed in #59
replaced by
gommon/errors
Development
- install go https://golang.org/
- install dep https://github.com/golang/dep
make dep-installmake test
License
MIT
Contribution
Currently, gommon is in a very violate state, please open issues after it becomes stable.
About
Gommon is inspired by many existing libraries, attribution and comparision can be found in doc/attribution.
Gommon was part of Ayi and split out for wider use. The name Gommon is suggested by @arrowrowe. The original blog post can be found in dongyue web's blog. Thanks all the folks in @dyweb especially @gaocegege for their support in early development.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gommon
gommon is the commandline util for generator
|
gommon is the commandline util for generator |
|
Package errors provides multi error, wrapping and inspection.
|
Package errors provides multi error, wrapping and inspection. |
|
errortype
Package errortype defines helper for inspect common error types generated in standard library, so you don't need to import tons of packages for their sentinel error and custom error type.
|
Package errortype defines helper for inspect common error types generated in standard library, so you don't need to import tons of packages for their sentinel error and custom error type. |
|
Package generator render go template, call external commands, generate gommon specific methods based on gommon.yml
|
Package generator render go template, call external commands, generate gommon specific methods based on gommon.yml |
|
Package log provides structured logging with fine grained control over libraries using a tree of logger registry TODO: add convention and usage
|
Package log provides structured logging with fine grained control over libraries using a tree of logger registry TODO: add convention and usage |
|
_benchmarks
Package benchmarks provides benchmark using go test and simulated real environment using pprof
|
Package benchmarks provides benchmark using go test and simulated real environment using pprof |
|
handlers/cli
Package cli generates human readable text with color and display time in delta.
|
Package cli generates human readable text with color and display time in delta. |
|
handlers/json
Package json writes log in JSON format, it escapes string in json based encoding/json, It does not use encoding/json directly because all the fields have known type
|
Package json writes log in JSON format, it escapes string in json based encoding/json, It does not use encoding/json directly because all the fields have known type |
|
Package noodle helps embedding static assets into go binary, it supports using ignore file
|
Package noodle helps embedding static assets into go binary, it supports using ignore file |
|
Package playground is used for testing out issues and language features
|
Package playground is used for testing out issues and language features |
|
issue_noodle_50
for i, ele := range slice is reusing same struct https://github.com/dyweb/gommon/issues/50
|
for i, ele := range slice is reusing same struct https://github.com/dyweb/gommon/issues/50 |
|
Package structure add some missing common data structures to Golang
|
Package structure add some missing common data structures to Golang |
|
util
|
|
|
cast
Package cast convert types safely and drop incompatible types during conversion it is inspired by https://github.com/spf13/cast
|
Package cast convert types safely and drop incompatible types during conversion it is inspired by https://github.com/spf13/cast |
|
color
Package color defines color code for pretty print in linux shell, windows is not supported
|
Package color defines color code for pretty print in linux shell, windows is not supported |
|
envutil
Package envutil wraps environment variable related operations
|
Package envutil wraps environment variable related operations |
|
fsutil
Package fsutil adds ignore support for walk
|
Package fsutil adds ignore support for walk |
|
genutil
Package genutil contains helper when generating files, it is used to break dependency cycle between generator package and packages that contain generator logic like log, noodle
|
Package genutil contains helper when generating files, it is used to break dependency cycle between generator package and packages that contain generator logic like log, noodle |
|
hashutil
Package hashutil provides alloc free alternatives for pkg/hash
|
Package hashutil provides alloc free alternatives for pkg/hash |
|
httputil
Package httputil provides helper for net/http, i.e.
|
Package httputil provides helper for net/http, i.e. |
|
logutil
Package logutil is a registry of loggers, it is required for all lib and app that use gommon/log.
|
Package logutil is a registry of loggers, it is required for all lib and app that use gommon/log. |
|
maputil
Package maputil provides wrapper for common map operations like merge, get keys, due to Go's type system only map[string]string is supported
|
Package maputil provides wrapper for common map operations like merge, get keys, due to Go's type system only map[string]string is supported |
|
runtimeutil
Package runtimeutil provides wrapper to get caller, stack etc.
|
Package runtimeutil provides wrapper to get caller, stack etc. |
|
testutil
Package testutil defines helper functions that fails test instead of return error
|
Package testutil defines helper functions that fails test instead of return error |
Click to show internal directories.
Click to hide internal directories.