go-sprout/sprout

View on GitHub
registry/env/functions.go

Summary

Maintainability
A
0 mins
Test Coverage
package env

import (
    "os"
)

// Env retrieves the value of an environment variable.
//
// Parameters:
//
//    key string - the name of the environment variable.
//
// Returns:
//
//    string - the value of the environment variable.
//
// Example:
//
//    {{ "PATH" | env }} // Output: "/usr/bin:/bin:/usr/sbin:/sbin"
func (er *EnvironmentRegistry) Env(key string) string {
    return os.Getenv(key)
}

// ExpandEnv replaces ${var} or $var in the string based on the values of the
// current environment variables.
//
// Parameters:
//
//    str string - the string with environment variables to expand.
//
// Returns:
//
//    string - the expanded string.
//
// Example:
//
//    {{ "Path is $PATH" | expandEnv }} // Output: "Path is /usr/bin:/bin:/usr/sbin:/sbin"
func (er *EnvironmentRegistry) ExpandEnv(str string) string {
    return os.ExpandEnv(str)
}