cfg

package

v0.2.14 Latest Latest Go to latest Published: Mar 9, 2024 License: MIT Imports: 17 Imported by: 3

Details

This section is empty.

This section is empty.

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)
}

type Option func(*options)

func WithAllowUnknownFields(v bool) Option

WithAllowUnknownFields - allow unknown fields in config

By default it true

func WithContext(v context.Context) Option

func WithEnvFile(v string) Option

WithEnvFile - path to don env config file

func WithSkipFlags(v bool) Option

WithSkipFlags - skip flags parsing

By default it true

func WithValidate(v bool) Option

func WithValidateFuncs(items ...ValidateFn) Option

func WithVersion(v string) Option

func WithYamlFile(v string) Option

WithYamlFile path to yaml config file

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