envutil

README

Env Util

Provide some commonly ENV util functions.

Install

go get github.com/gookit/goutil/envutil

Go docs

• Go docs

Functions API

func Environ() map[string]string
func GetBool(name string, def ...bool) bool
func GetInt(name string, def ...int) int
func Getenv(name string, def ...string) string
func HasShellEnv(shell string) bool
func IsConsole(out io.Writer) bool
func IsGithubActions() bool
func IsLinux() bool
func IsMSys() bool
func IsMac() bool
func IsSupport256Color() bool
func IsSupportColor() bool
func IsSupportTrueColor() bool
func IsTerminal(fd uintptr) bool
func IsWSL() bool
func IsWin() bool
func IsWindows() bool
func ParseEnvValue(val string) string
func ParseValue(val string) (newVal string)
func SetEnvs(mp map[string]string)
func StdIsTerminal() bool
func VarParse(val string) string
func VarReplace(s string) string

Code Check & Testing

gofmt -w -l ./
golint ./...

Testing:

go test -v ./envutil/...

Test limit by regexp:

go test -v -run ^TestSetByKeys ./envutil/...

Documentation

Index

• Variables
• func Environ() map[string]string
• func GetBool(name string, def ...bool) bool
• func GetInt(name string, def ...int) int
• func Getenv(name string, def ...string) string
• func HasShellEnv(shell string) bool
• func IsConsole(out io.Writer) bool
• func IsGithubActions() bool
• func IsLinux() bool
• func IsMSys() bool
• func IsMac() bool
• func IsSupport256Color() bool
• func IsSupportColor() bool
• func IsSupportTrueColor() bool
• func IsTerminal(fd uintptr) bool
• func IsWSL() bool
• func IsWin() bool
• func IsWindows() bool
• func ParseEnvValue(val string) string
• func ParseValue(val string) (newVal string)
• func SetEnvs(mp map[string]string)
• func StdIsTerminal() bool
• func VarParse(val string) string
• func VarReplace(s string) string

Variables

var ValueGetter = os.Getenv

ValueGetter Env value provider func.

TIPS: you can custom provide data.

Functions

func Environ

func Environ() map[string]string

Environ like os.Environ, but will returns key-value map[string]string data.

func GetBool

func GetBool(name string, def ...bool) bool

GetBool get bool ENV value by key name, can with default value

func GetInt

func GetInt(name string, def ...int) int

GetInt get int ENV value by key name, can with default value

func Getenv

func Getenv(name string, def ...string) string

Getenv get ENV value by key name, can with default value

func HasShellEnv

func HasShellEnv(shell string) bool

HasShellEnv has shell env check.

Usage:

HasShellEnv("sh")
HasShellEnv("bash")

func IsConsole

func IsConsole(out io.Writer) bool

IsConsole check out is console env. alias of the sysutil.IsConsole()

func IsGithubActions

func IsGithubActions() bool

IsGithubActions env

func IsLinux

func IsLinux() bool

IsLinux system

func IsMSys

func IsMSys() bool

IsMSys msys(MINGW64) env. alias of the sysutil.IsMSys()

func IsMac

func IsMac() bool

IsMac system

func IsSupport256Color

func IsSupport256Color() bool

IsSupport256Color render

func IsSupportColor

func IsSupportColor() bool

IsSupportColor check current console is support color.

Supported:

linux, mac, or windows's ConEmu, Cmder, putty, git-bash.exe

Not support:

windows cmd.exe, powerShell.exe

func IsSupportTrueColor

func IsSupportTrueColor() bool

IsSupportTrueColor render. IsSupportRGBColor

func IsTerminal

func IsTerminal(fd uintptr) bool

IsTerminal isatty check

Usage:

envutil.IsTerminal(os.Stdout.Fd())

func IsWSL

func IsWSL() bool

IsWSL system env https://github.com/Microsoft/WSL/issues/423#issuecomment-221627364

func IsWin

func IsWin() bool

IsWin system. linux windows darwin

func IsWindows

func IsWindows() bool

IsWindows system. alias of IsWin

func ParseEnvValue

func ParseEnvValue(val string) string

ParseEnvValue alias of the ParseValue

func ParseValue

func ParseValue(val string) (newVal string)

ParseValue parse ENV var value from input string, support default value.

Format:

${var_name}            Only var name
${var_name | default}  With default value

Usage:

envutil.ParseValue("${ APP_NAME }")
envutil.ParseValue("${ APP_ENV | dev }")

func SetEnvs

func SetEnvs(mp map[string]string)

SetEnvs to os

func StdIsTerminal

func StdIsTerminal() bool

StdIsTerminal os.Stdout is terminal

func VarParse

func VarParse(val string) string

VarParse alias of the ParseValue

func VarReplace

func VarReplace(s string) string

VarReplace replaces ${var} or $var in the string according to the values.

is alias of the os.ExpandEnv()