README
¶
grench
grench is an opinionated, zero-dependency utility library for developing Go applications.
The grench (derived from the words 'go' and 'wrench') project aims to provide an importable, version-controlled package for commonly-used utility packages. These packages are usually too trivial to have its own dedicated package, yet pasting them into all your Go applications makes it hard to maintain whenever there are changes/fixes. The grench package provides all of these so you can focus on getting your Go application up and running.
Packages are not guaranteed to have a stable API and may be subjected to change. Packages may also graduate into its library and be removed from grench eventually. All of these changes will be documented accordingly in the CHANGELOG.
Install
grench requires Go 1.13 or later.
To install grench, use go get to fetch the latest version:
go get -u github.com/loozhengyuan/grench
Once installed, you may import it directly into your Go application:
import "github.com/loozhengyuan/grench"
License
Directories
¶
| Path | Synopsis |
|---|---|
|
auth
|
|
|
oauth2
Package oauth2 provides the implementation of the OAuth 2.0 specification as defined in RFC6749.
|
Package oauth2 provides the implementation of the OAuth 2.0 specification as defined in RFC6749. |
|
oauth2/pkce
Package pkce provides the implementation of the Proof Key for Code Exchange specification as defined in RFC7636.
|
Package pkce provides the implementation of the Proof Key for Code Exchange specification as defined in RFC7636. |
|
oidc
Package oidc provides the implementation of the OpenID Connect 1.0 specification.
|
Package oidc provides the implementation of the OpenID Connect 1.0 specification. |
|
Package build provides the build information of an application.
|
Package build provides the build information of an application. |
|
Package config provides the tools for managing application configuration.
|
Package config provides the tools for managing application configuration. |
|
Package health provides the health check interface and service.
|
Package health provides the health check interface and service. |
|
http
|
|
|
header
Package header provides the constants for HTTP headers.
|
Package header provides the constants for HTTP headers. |
|
middleware
Package middleware provides http middleware.
|
Package middleware provides http middleware. |
|
mime
Package mime provides the constants for MIME types.
|
Package mime provides the constants for MIME types. |
|
Package kv provides interface for interacting with a key-value store.
|
Package kv provides interface for interacting with a key-value store. |
|
fs
Package fs provides a local filesystem implementation of the kv.Store interface.
|
Package fs provides a local filesystem implementation of the kv.Store interface. |
|
mem
Package mem provides a in-memory implementation of the kv.Store interface.
|
Package mem provides a in-memory implementation of the kv.Store interface. |
|
utils
|
|
|
coalesce
Package coalesce provides coalesce helper functions.
|
Package coalesce provides coalesce helper functions. |
|
pointer
Package pointer provides pointer helper functions.
|
Package pointer provides pointer helper functions. |