expandpath

Documentation

Index

• Variables
• func ExpandEnvironmentVariable(envInfoItems []EnvKeyInfo) map[string]string
• func ExpandVariables(pathContainsEnvVariables string) string
• func ExpandVariablesIf(isExpand bool, pathContainsEnvVariables string) string
• func GetCompiledPath(pathTemplate string, compilingMap map[string]string) string
• func GetEnvironmentVariables(pathContainsEnvVarStartingDollarSymbol string) []string
• func Home(path string) (string, *errorwrapper.Wrapper)
• type EnvKeyInfo
  • func GetDollarOrPercentSymbolIdentifierEnvInfoItems(stringToCheck string) []EnvKeyInfo
  • func GetEnvInfoItemsKeyNames(slice []string) []EnvKeyInfo

Variables

var DisableCache bool

TODO refactor later DisableCache will disable caching of the homeCaps directory. Caching is enabled by default.

Functions

func ExpandEnvironmentVariable

func ExpandEnvironmentVariable(envInfoItems []EnvKeyInfo) map[string]string

ExpandEnvironmentVariable

function takes an array of environment variables (string) as input
and outputs a map of expanded path of those variables if the paths exist.

func ExpandVariables

func ExpandVariables(pathContainsEnvVariables string) string

ExpandVariables

function takes a string input and replaces any word that starts with "$" in the input with its expanded path (if exists) and returns the new string.

Acceptable Env paths:

${Java_home} $java_home %{java_home} %java_home all will be expanded

func ExpandVariablesIf

func ExpandVariablesIf(
	isExpand bool,
	pathContainsEnvVariables string,
) string

ExpandVariablesIf

Acceptable Env paths: ${Java_home} $java_home %{java_home} %java_home all will be expand e

func GetCompiledPath

func GetCompiledPath(
	pathTemplate string,
	compilingMap map[string]string,
) string

GetCompiledPath

exactly replaces as is.

func GetEnvironmentVariables

func GetEnvironmentVariables(
	pathContainsEnvVarStartingDollarSymbol string,
) []string

getVariables function takes a string input and identifies every word that begins with "$" or every word within two "%" in that input string then returns an array of those words. If input is empty or has no such word then returns nil.

func Home

func Home(path string) (string, *errorwrapper.Wrapper)

Home expands the path to include the homeCaps directory if the path is prefixed with `~`. If it isn't prefixed with `~`, the path is returned as-is. Reference : https://bit.ly/3rZbbKH

Types

type EnvKeyInfo

type EnvKeyInfo struct {
	GivenAs,
	SimplifiedName string
}

func GetDollarOrPercentSymbolIdentifierEnvInfoItems

func GetDollarOrPercentSymbolIdentifierEnvInfoItems(
	stringToCheck string,
) []EnvKeyInfo

func GetEnvInfoItemsKeyNames

func GetEnvInfoItemsKeyNames(slice []string) []EnvKeyInfo

GetEnvInfoItemsKeyNames

will be retrieved from slice strings

Key Names may be formatter like:

${identifier} or $identifier or %{identifier} or %identifier

returns exact keys as given ${identifier} will be returns as given ${identifier}