utils

Documentation

Index

• Constants
• func CombineEnv(envs ...*[]string) []string
• func CombineEnvMaps(envs ...*map[string]string) map[string]string
• func EnvMapAsSlice(env map[string]string) []string
• func EnvSliceAsMap(env []string) map[string]string
• func GetCacheDir() (string, error)
• func GetOSShell(envShell *platform.PlatformMap[string]) string
• func GetOSShellArgs(cmd string) []string
• func GetRawFileURL(gitURL, ref, path string) (string, error)
• func GetRealPath(env []string, path string) string
• func GetShellWhich() string
• func IsGitURL(url string) bool
• func IsRawFileURL(url string) bool
• func PathExists(path string) (bool, error)
• func ResolveEnvPaths(envs ...[]string) []string
• func RunCmdAsFile(env []string, contents string, envShell *platform.PlatformMap[string]) error
• func RunCmdGetOutput(env []string, bin string, args ...string) ([]byte, error)
• func RunCmdGetSuccess(env []string, bin string, args ...string) (bool, error)
• func RunCmdGetSuccessPassThrough(env []string, bin string, args ...string) (bool, error)
• func RunCmdPassThrough(env []string, bin string, args ...string) error
• func RunCmdPassThroughChained(env []string, commands [][]string) error
• type GitHostType
  • func DetectGitHostType(host string) GitHostType
• type GitURLInfo
  • func ParseGitURL(url string) (*GitURLInfo, error)

Constants

const UNIX_DEFAULT_SHELL string = "bash"

UNIX_DEFAULT_SHELL is the default shell used on Unix-like systems if SHELL environment variable is not set.

Functions

func CombineEnv

func CombineEnv(envs ...*[]string) []string

CombineEnv merges multiple slices of environment variable strings. Later slices will override earlier ones if keys conflict.

func CombineEnvMaps

func CombineEnvMaps(envs ...*map[string]string) map[string]string

CombineEnvMaps merges multiple maps of environment variables. Later maps will override earlier ones if keys conflict.

func EnvMapAsSlice

func EnvMapAsSlice(env map[string]string) []string

EnvMapAsSlice converts a map of environment variables to a slice of "KEY=VALUE" strings.

func EnvSliceAsMap

func EnvSliceAsMap(env []string) map[string]string

EnvSliceAsMap converts a slice of environment variable strings ("KEY=VALUE") to a map.

func GetCacheDir

func GetCacheDir() (string, error)

GetCacheDir returns the path to the user's cache directory for the application. It creates the directory if it doesn't exist. The cache directory is typically located at `$XDG_CACHE_HOME` on Linux/macOS and `%LocalAppData%` on Windows.

func GetOSShell

func GetOSShell(envShell *platform.PlatformMap[string]) string

GetOSShell returns the appropriate shell for the current operating system. It considers the SHELL environment variable on Unix-like systems and allows overrides via envShell.

func GetOSShellArgs

func GetOSShellArgs(cmd string) []string

GetOSShellArgs returns the appropriate shell arguments for executing a command string.

func GetRawFileURL

func GetRawFileURL(gitURL, ref, path string) (string, error)

GetRawFileURL converts a Git repository URL to a raw file URL for direct access. Supports GitHub, GitLab (including self-hosted), and Bitbucket (including self-hosted). For unknown hosts, it attempts to use GitLab-style raw URLs as a fallback. Parameters:

• gitURL: The Git repository URL (SSH or HTTPS)
• ref: The branch, tag, or commit (defaults to "master" if empty)
• path: The file path within the repository

func GetRealPath

func GetRealPath(env []string, path string) string

GetRealPath resolves a path string, expanding environment variables and replacing "~" with the user's home directory. It takes a slice of environment variables to temporarily set during expansion.

func GetShellWhich

func GetShellWhich() string

GetShellWhich returns the command used to find the path of an executable (e.g., "which" or "where").

func IsGitURL

func IsGitURL(url string) bool

IsGitURL checks if a string is likely a Git repository URL (not a raw file URL). It checks for "git@" prefix or URLs ending with ".git".

func IsRawFileURL

func IsRawFileURL(url string) bool

IsRawFileURL checks if a URL is a direct raw file URL.

func PathExists

func PathExists(path string) (bool, error)

PathExists checks if a file or directory exists at the given path. It returns true if the path exists, false otherwise. It does not distinguish between files and directories. An error is returned if os.Stat encounters an issue other than fs.ErrNotExist.

func ResolveEnvPaths

func ResolveEnvPaths(envs ...[]string) []string

ResolveEnvPaths takes one or more slices of environment variable strings (e.g., "KEY=VALUE"), resolves any paths within the values using GetRealPath, and returns a single combined slice.

func RunCmdAsFile

func RunCmdAsFile(env []string, contents string, envShell *platform.PlatformMap[string]) error

RunCmdAsFile writes the given contents to a temporary shell script and executes it. This is useful for running multi-line commands or scripts.

func RunCmdGetOutput

func RunCmdGetOutput(env []string, bin string, args ...string) ([]byte, error)

RunCmdGetOutput executes a command and returns its standard output.

func RunCmdGetSuccess

func RunCmdGetSuccess(env []string, bin string, args ...string) (bool, error)

RunCmdGetSuccess executes a command and returns true if it succeeds (exit code 0). Standard input, output, and error are not passed through.

func RunCmdGetSuccessPassThrough

func RunCmdGetSuccessPassThrough(env []string, bin string, args ...string) (bool, error)

RunCmdGetSuccessPassThrough executes a command, passes through streams, and returns true if it succeeds.

func RunCmdPassThrough

func RunCmdPassThrough(env []string, bin string, args ...string) error

RunCmdPassThrough executes a command and passes through its standard input, output, and error streams. It also resolves environment variable paths.

func RunCmdPassThroughChained

func RunCmdPassThroughChained(env []string, commands [][]string) error

RunCmdPassThroughChained executes a series of commands sequentially, passing through streams. If any command fails, the chain stops and an error is returned.

Types

type GitHostType

type GitHostType string

GitHostType represents the type of Git hosting service.

const (
	GitHostGitHub    GitHostType = "github"
	GitHostGitLab    GitHostType = "gitlab"
	GitHostBitbucket GitHostType = "bitbucket"
	GitHostUnknown   GitHostType = "unknown"
)

func DetectGitHostType

func DetectGitHostType(host string) GitHostType

DetectGitHostType detects the Git hosting service from a host string. It checks for known patterns in the hostname.

type GitURLInfo

type GitURLInfo struct {
	Host  string // e.g., "github.com", "gitlab.com"
	Owner string // e.g., "chenasraf"
	Repo  string // e.g., "sofmani"
}

GitURLInfo holds parsed information from a Git URL.

func ParseGitURL

func ParseGitURL(url string) (*GitURLInfo, error)

ParseGitURL parses a Git URL (SSH or HTTPS) and extracts host, owner, and repo. Supports formats:

• git@github.com:owner/repo.git
• https://github.com/owner/repo.git
• https://github.com/owner/repo