envutil

package

v0.0.3 Latest Latest Go to latest Published: Feb 6, 2023 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/zhangyiming748/pretty

Links

Open Source Insights

README ¶

Env Util

Provide some commonly ENV util functions.

Install

go get github.com/zhangyiming748/pretty/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 ¶

Overview ¶

Package envutil provide some commonly ENV util functions.

Index ¶

Variables
func EnvPaths() []string
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 SearchEnv(keywords string, matchValue bool) map[string]string
func SearchEnvKeys(keywords string) map[string]string
func SetEnvs(mp map[string]string)
func StdIsTerminal() bool
func VarParse(val string) string
func VarReplace(s string) string

Constants ¶

This section is empty.

Variables ¶

View Source

var ValueGetter = os.Getenv

ValueGetter Env value provider func.

TIPS: you can custom provide data.

Functions ¶

func EnvPaths ¶

func EnvPaths() []string

EnvPaths get and split $PATH to []string

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 SearchEnv ¶

func SearchEnv(keywords string, matchValue bool) map[string]string

SearchEnv values by given keywords

func SearchEnvKeys ¶

func SearchEnvKeys(keywords string) map[string]string

SearchEnvKeys values by given keywords

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

Types ¶

This section is empty.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL