profile

Documentation

Overview

Package profile provides profile and store management for environment variable sets.

Index

• Variables
• func Stringify(v any) (string, error)
• type Env
  • func (e *Env) FromEnv(env env.Env)
  • func (e *Env) Stringified() (env.Env, error)
  • func (e *Env) UnmarshalYAML(node ast.Node) error
• type Inheritance
• type InheritanceTracker
  • func (i InheritanceTracker) Format(key string, verbose, withKey bool) string
  • func (i InheritanceTracker) FormatAll(prefix string, verbose bool) string
• type Profile
• type Profiles
  • func (p Profiles) Create(name string)
  • func (p Profiles) Environment(name string) (*InheritanceTracker, error)
  • func (p Profiles) Exists(name string) bool
  • func (p Profiles) Names() []string
• type Store
  • func New(file file.File) (*Store, error)
  • func (s *Store) Load() (*Store, error)
• type Type

Variables

var (
	// ErrUnsupportedFileType is returned when the file type is not supported.
	ErrUnsupportedFileType = errors.New("unsupported file type")
	// ErrProfileNotFound is returned when a profile is not found in the store.
	ErrProfileNotFound = errors.New("profile not found")
)

Functions

func Stringify

func Stringify(v any) (string, error)

Stringify turns any Go value into the dotenv-ready string described earlier.

• Scalars → plain strings (`true`, `5432`, `foo`…).
• Slices / maps / structs → compact JSON wrapped in single quotes (`'["a","b"]'`, `'{"k":"v"}'`).

Types

type Env

type Env map[string]any

Env is a map of environment variable names to their non-stringified values.

func (*Env) FromEnv

func (e *Env) FromEnv(env env.Env)

FromEnv initializes Env from an env.Env.

func (*Env) Stringified

func (e *Env) Stringified() (env.Env, error)

Stringified serializes Env into env.Env using Stringify. – Scalars pass through unchanged. – Non-scalars are JSON-minified and single-quoted (see Stringify).

func (*Env) UnmarshalYAML

func (e *Env) UnmarshalYAML(node ast.Node) error

UnmarshalYAML allows Env to be unmarshaled as its regular type or a sequence of strings.

type Inheritance

type Inheritance map[string]string

Inheritance carries a mapping from environment variable names to where they are inherited from.

type InheritanceTracker

type InheritanceTracker struct {
	// Inheritance is a mapping from environment variable names to where they are inherited from.
	Inheritance Inheritance
	// Env is the environment variables.
	Env env.Env
	// Name is the name of the profile.
	Name string
}

InheritanceTracker holds the environment variables and their inheritance sources.

func (InheritanceTracker) Format

func (i InheritanceTracker) Format(key string, verbose, withKey bool) string

Format returns the formatted value of a single variable.

func (InheritanceTracker) FormatAll

func (i InheritanceTracker) FormatAll(prefix string, verbose bool) string

FormatAll returns all variables, one per line.

type Profile

type Profile struct {
	Env     Env      `toml:"env,omitempty"     yaml:"env,omitempty"`
	DotEnv  []string `toml:"dotenv,omitempty"  yaml:"dotenv,omitempty"`
	Extends []string `toml:"extends,omitempty" yaml:"extends,omitempty"`
}

Profile holds metadata plus an env-var map.

type Profiles

type Profiles map[string]*Profile

Profiles is a map of profile names to their metadata.

func (Profiles) Create

func (p Profiles) Create(name string)

Create creates a new profile in the store.

func (Profiles) Environment

func (p Profiles) Environment(name string) (*InheritanceTracker, error)

Environment returns the merged environment variables for a profile, resolving dependencies.

func (Profiles) Exists

func (p Profiles) Exists(name string) bool

Exists checks if a profile exists in the store.

func (Profiles) Names

func (p Profiles) Names() []string

Names returns the names of the profiles in sorted order.

type Store

type Store struct {
	// File is the file containing the profiles.
	File file.File
	// Profiles is a map of profile names to their metadata.
	Profiles Profiles
	// Type is the type of the file.
	Type Type
}

Store represents the entire file and codec information.

func New

func New(file file.File) (*Store, error)

New creates a new store from the given path.

func (*Store) Load

func (s *Store) Load() (*Store, error)

Load reads the file and unmarshals it into the store.

type Type

type Type string

Type represents the type of the profile file.

const (
	// YAML is the YAML file type.
	YAML Type = "yaml"
	// TOML is the TOML file type.
	TOML Type = "toml"
)