README
¶
go-core
go-core is the Core SDK for Standards Lab's Go Elemental standard. It provides layered configuration, a dependency graph and the process lifecycle that runs it, and logging.
github.com/standards-lab/go-core is a single Go module with the process-level packages every
program in the standard builds on.
Standard
go-core is the Core SDK of
Go Elemental, the
minimal-dependency Go standard. This README and each package's doc.go document the
repository; the standard's principles it enhances are stated below.
It enhances the standard's dependency line: where Go Elemental admits packages as idiomatic and
stable as the standard library, this repository depends on the standard library alone.
Packages
config— loads configuration in layers: a base file, an environment overlay, and secrets.graph— a typed dependency graph: nodes described inertly, each a name and a constructor, and a Build that constructs what the roots reach into a System of computed layers.lifecycle— runs a builtgraphSystem: starts its layers in order, tracks and reports readiness, watches for runtime failures, and shuts the layers down in reverse within a timeout. A value takes part through the interfaces it implements.Execis the one-shot form a CLI command uses;Runis the long-running form a service uses.logging— builds an*slog.Loggerfrom a configuration thatconfigloads.process— the parts of a binary's main sequence that run before the program's own infrastructure exists: the signal-derived root context, pre-logger failure reporting, and the exit-code convention.process/processtest— the integration toolkit: it builds a program once per suite run and runs it as a subprocess. It then waits on what a client observes, interrupts the process and reads its exit code, and relays a backing service's connection so a test can sever it.Runruns the program once and returns its stdout, stderr, and exit code.
Development
Tasks run through mise:
mise run check # build, vet, format, fix, tidy, test, and lint; writes nothing
mise run currency # report requirements, Go, tools, and actions behind their latest
mise run upgrade # upgrade the go directive, requirements, and tools to their latest
License
Directories
¶
| Path | Synopsis |
|---|---|
|
Package config loads layered JSON configuration and defines the contract a configuration type implements to take part in that load.
|
Package config loads layered JSON configuration and defines the contract a configuration type implements to take part in that load. |
|
Package graph is a typed dependency graph.
|
Package graph is a typed dependency graph. |
|
Package lifecycle runs a built graph.System: process startup, readiness, and graceful shutdown.
|
Package lifecycle runs a built graph.System: process startup, readiness, and graceful shutdown. |
|
Package logging constructs the *slog.Logger a process writes through, from a configuration that takes part in the layered load.
|
Package logging constructs the *slog.Logger a process writes through, from a configuration that takes part in the layered load. |
|
Package process holds the parts of a binary's main sequence that run before the program's own infrastructure exists: reporting a failure or a usage error when there is no logger yet, the signal-derived root context, and the exit-code convention the reporters return.
|
Package process holds the parts of a binary's main sequence that run before the program's own infrastructure exists: reporting a failure or a usage error when there is no logger yet, the signal-derived root context, and the exit-code convention the reporters return. |
|
processtest
Package processtest is the integration toolkit for a program built on the process package.
|
Package processtest is the integration toolkit for a program built on the process package. |
|
processtest/internal/testprog
command
Command testprog is the program the processtest package's own tests run: it answers on a loopback address, waits for the interrupt, and exits with the code its environment names, so the runner is proved against a real subprocess without a service behind it.
|
Command testprog is the program the processtest package's own tests run: it answers on a loopback address, waits for the interrupt, and exits with the code its environment names, so the runner is proved against a real subprocess without a service behind it. |
Click to show internal directories.
Click to hide internal directories.