README
¶
go-common
This project houses Go code shared between ASCE projects. It mostly focuses on logging, CLI, and REST API functionality.
Approved for public release: distribution unlimited. Case Number: AFRL-2024-1060
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
sample
Package main is a sample CLI tool to demonstrate how these libraries are properly composed.
|
Package main is a sample CLI tool to demonstrate how these libraries are properly composed. |
|
pkg
|
|
|
cmd
Package cmd provides reusable cobra commands
|
Package cmd provides reusable cobra commands |
|
config
Package config provides configuration utilities for dealing with configuration from both environment variables and configuration files
|
Package config provides configuration utilities for dealing with configuration from both environment variables and configuration files |
|
config/env
Package env defines functions to load configuration from environment variables
|
Package env defines functions to load configuration from environment variables |
|
embedutil
Package embedutil provides utility functions for embedding documents in a Go binary and producing those documents in various formats
|
Package embedutil provides utility functions for embedding documents in a Go binary and producing those documents in various formats |
|
fsutil
Package fsutil provides filesystem utilities for testing purposes
|
Package fsutil provides filesystem utilities for testing purposes |
|
genschema
Package genschema generates JSON Schema definitions for Go types.
|
Package genschema generates JSON Schema definitions for Go types. |
|
httputil
Package httputil provides utilities for writing http services.
|
Package httputil provides utilities for writing http services. |
|
httputil/promhttputil
Package promhttputil contains a prometheus metrics middleware, relocated from httputil.
|
Package promhttputil contains a prometheus metrics middleware, relocated from httputil. |
|
ioutil
Package ioutil provides io utilities.
|
Package ioutil provides io utilities. |
|
logger
Package logger is common logging functionality to use slog
|
Package logger is common logging functionality to use slog |
|
logger/logutil
Package logutil defines basic logging utilities.
|
Package logutil defines basic logging utilities. |
|
oapiutil
Package oapiutil implements helper functions for utilizing OpenAPI specifications.
|
Package oapiutil implements helper functions for utilizing OpenAPI specifications. |
|
options
Package options provides a framework for defining all overrides of a configurable option in one location.
|
Package options provides a framework for defining all overrides of a configurable option in one location. |
|
options/cobrautil
Package cobrautil defines utility wrapper functions for common cobra flag handling tasks.
|
Package cobrautil defines utility wrapper functions for common cobra flag handling tasks. |
|
options/cobrautil/formats
Package formats defines some example formats for use with the cobrautil and flagutil packages.
|
Package formats defines some example formats for use with the cobrautil and flagutil packages. |
|
options/flagutil
Package flagutil defines utilities for registering and parsing command line flags.
|
Package flagutil defines utilities for registering and parsing command line flags. |
|
options/optionshelp
Package optionshelp produces markdown documentation for options and creates CLI commands utilizing this documentation.
|
Package optionshelp produces markdown documentation for options and creates CLI commands utilizing this documentation. |
|
otel
Package otel provides utilities for initializing and configuring OpenTelemetry.
|
Package otel provides utilities for initializing and configuring OpenTelemetry. |
|
otel/otelhelp
Package otelhelp defines CLI help commands with OTel configuration docs.
|
Package otelhelp defines CLI help commands with OTel configuration docs. |
|
redact
Package redact performs data redaction to prevent credential leakage in logs or the console.
|
Package redact performs data redaction to prevent credential leakage in logs or the console. |
|
runner
Package runner provides common bootstrapping functionality for CLI tools
|
Package runner provides common bootstrapping functionality for CLI tools |
|
secret
Package secret provides utility functions for handling secrets.
|
Package secret provides utility functions for handling secrets. |
|
termdoc
Package termdoc contains string formatting functions for producing CLI documentation that can target both terminal and markdown output.
|
Package termdoc contains string formatting functions for producing CLI documentation that can target both terminal and markdown output. |
|
termdoc/codefmt
Package codefmt contains basic code reformatting functionality.
|
Package codefmt contains basic code reformatting functionality. |
|
termdoc/mdfmt
Package mdfmt contains basic markdown reformatting functionality.
|
Package mdfmt contains basic markdown reformatting functionality. |
|
test
Package test provides test helper functions
|
Package test provides test helper functions |
|
testutil
Package testutil contains utilities for writing tests.
|
Package testutil contains utilities for writing tests. |
|
version
Package version is a helper for extracting versions from the binary
|
Package version is a helper for extracting versions from the binary |
Click to show internal directories.
Click to hide internal directories.