cfg

package

v0.2.19 Latest Latest Go to latest Published: May 2, 2024 License: MIT Imports: 18 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func GenerateDefaultEnvs(cfg any, filePath string, opts ...Option) error

func GenerateMarkdown(cfg any, filePath string, opts ...Option) error

func GenerateYamlTemplate(cfg any, filePath string, opts ...Option) error

func Load(cfg any, opts ...Option) error

Load environment variables from `os env`, flags, `.env`, `.yaml` files and pass it to struct.

For local development use `.env` file from root project.

Load also call a `Validate` method if it proided.

Example:

var config internalConfig.Config
if err := cfg.Load(&config); err != nil {
	logger.Fatalf("could not load configuration: %v", err)
}

func LoadForTests(cfg any, opts ...Option) error

LoadForTests environment variables from `os env`, flags, `.env`, `.yaml` files and pass it to struct.

Disabled flags detection and any cli features.

For local development use `.env` file from root project.

LoadForTests also call a `Validate` method if it proided.

Example:

var config internalConfig.Config
if err := cfg.LoadForTests(&config); err != nil {
	logger.Fatalf("could not load configuration: %v", err)
}

func ValidateConfig(cfg any, opts ...Option) error

ValidateConfig validates config struct with environment variables and custom validation functions.

type Config = aconfig.Config

type Option func(*options)

func WithContext(v context.Context) Option

func WithLoaderConfig(v Config) Option

WithEnvFile - path to dotenv config file

func WithValidate(v bool) Option

func WithValidateFuncs(items ...ValidateFn) Option

type ValidateFn struct {
	Tag                      string
	Fn                       validator.Func
	CallValidationEvenIfNull []bool
}