comfunc

Documentation

Index

• func Bool(v any) bool
• func Cmdline(args []string, binName ...string) string
• func CurrentShell(onlyName bool) (path string)
• func Environ() map[string]string
• func ExecCmd(binName string, args []string, workDir ...string) (string, error)
• func ExpandPath(pathStr string) string
• func HasShellEnv(shell string) bool
• func ParseEnvVar(val string, getFn func(string) string) (newVal string)
• func ShellExec(cmdLine string, shells ...string) (string, error)
• func StrToBool(s string) (bool, error)
• func ToBool(v any) (bool, error)

Functions

func Bool

func Bool(v any) bool

Bool try to convert type to bool

func Cmdline

func Cmdline(args []string, binName ...string) string

Cmdline build

func CurrentShell

func CurrentShell(onlyName bool) (path string)

CurrentShell get current used shell env file.

eg "/bin/zsh" "/bin/bash". if onlyName=true, will return "zsh", "bash"

func Environ

func Environ() map[string]string

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

func ExecCmd

func ExecCmd(binName string, args []string, workDir ...string) (string, error)

ExecCmd an command and return output.

Usage:

ExecCmd("ls", []string{"-al"})

func ExpandPath

func ExpandPath(pathStr string) string

ExpandPath will parse first `~` as user home dir path.

func HasShellEnv

func HasShellEnv(shell string) bool

HasShellEnv has shell env check.

Usage:

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

func ParseEnvVar

func ParseEnvVar(val string, getFn func(string) string) (newVal string)

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

Format:

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

Usage:

comfunc.ParseEnvVar("${ APP_NAME }")
comfunc.ParseEnvVar("${ APP_ENV | dev }")

func ShellExec

func ShellExec(cmdLine string, shells ...string) (string, error)

ShellExec exec command by shell cmdLine eg. "ls -al"

func StrToBool

func StrToBool(s string) (bool, error)

StrToBool parse string to bool. like strconv.ParseBool()

func ToBool

func ToBool(v any) (bool, error)

ToBool try to convert type to bool