genenv

type Config struct {
	// Package holds the name of the generated package.
	//
	// NOTE
	// Package value is not parsed and must ben not a path.
	Package string `json:"package" yaml:"package"`

	// Target holds the generated package directory path. Relative paths
	// must be relative to the module root directory.
	Target string `json:"target" yaml:"target"`

	// Header holds the generated files header.
	//
	// Default:
	//   // Code generated by genenv. DO NOT EDIT.
	Header string

	// Variables holds the environment variable key/Spec map.
	Variables map[string]Spec `json:"variables" yaml:"variables"`
	// contains filtered or unexported fields
}

type ModInfo struct {
	// Path holds the go module path.
	// E.g. "github.com/marcozac/genenv"
	Path string `json:"Path"`

	// Dir holds the go module directory.
	// E.g. "/my/module/directory"
	Dir string `json:"Dir"`

	// GoMod holds the go.mod file path.
	// E.g. "/my/module/directory/go.mod"
	GoMod string `json:"GoMod"`
}

type Spec struct {
	// Allow holds a list of allowed variable values.
	// No entries means "any value".
	Allow []string `json:"allow" yaml:"allow"`

	// Deny holds a list of denied variable values.
	// No entries means "nothing".
	Deny []string `json:"deny" yaml:"deny"`

	// Required allows to mark an environment variable as required,
	// returning an error if it has no value.
	Required bool `json:"required" yaml:"required"`

	// Doc allows to document the generated function by an optional
	// godoc comment.
	//
	// Default:
	//   // <FuncName> returns the value of the environment variable <Key>.
	Doc string `json:"doc" yaml:"doc"`

	// Key holds the environment variable key.
	//
	// NOTE:
	// Do not configure this field: overwritten by initialization.
	Key string `json:"-" yaml:"-"`

	// Name holds the name of the function to generate.
	//
	// NOTE:
	// Do not configure this field: overwritten by initialization.
	Name string `json:"-" yaml:"-"`
}

type StrConv struct {
	B *strings.Builder
	// contains filtered or unexported fields
}