README
¶
About
This repository contains the implementations of some commonly used libraries.
Development
Setup
Execute the following commands to install git hooks:
ln -s ../../githooks/pre-commit .git/hooks/: Run checks and tests before committing.ln -s ../../githooks/commit-msg .git/hooks/: Check whether the commit message conforms to conventional commits.
The pre-commit hook requires the following tools to be installed:
- mockgen: Generate mock files.
- wire: Generate dependency injection files.
- golangci-lint: Linters.
Test
cd deployments && cp .env.example .envand edit.env, thensource .env.- Launch containers
cd deployments && docker compose up -d. - Now you can run tests via
go testcommand.
Directories
¶
| Path | Synopsis |
|---|---|
|
pkg
|
|
|
concurrent
Package concurrent implements concurrency related functions.
|
Package concurrent implements concurrency related functions. |
|
constant
Package constant defines some constants.
|
Package constant defines some constants. |
|
db
Package db defines database related APIs.
|
Package db defines database related APIs. |
|
dlock
Package dlock implements distributed lock.
|
Package dlock implements distributed lock. |
|
encoding
Package encoding defines interfaces that convert data to and from byte-level and textual representations.
|
Package encoding defines interfaces that convert data to and from byte-level and textual representations. |
|
glock
Package glock implements goroutine lock.
|
Package glock implements goroutine lock. |
|
graceful
Package graceful implements general graceful shutdown functions.
|
Package graceful implements general graceful shutdown functions. |
|
limiter
Package limiter implements a rate limiter with support for peak shaving.
|
Package limiter implements a rate limiter with support for peak shaving. |
|
log
Package log implements a common logger based on slog.
|
Package log implements a common logger based on slog. |
|
otel
Package otel implements [OpenTelemetry] related functions.
|
Package otel implements [OpenTelemetry] related functions. |
|
util
Package util implements some utility functions.
|
Package util implements some utility functions. |
Click to show internal directories.
Click to hide internal directories.