Documentation
¶
Index ¶
- Constants
- func Coalesce[T comparable](v ...T) (result T)
- func ConvertEnvVars(envVarsMap map[any]any) []string
- func ConvertFromJSON(jsonString string) (any, error)
- func ConvertPathsToAbsolutePaths(paths []string) ([]string, error)
- func ConvertToHclAst(data any) (ast.Node, error)
- func ConvertToJSON(data any) (string, error)
- func ConvertToJSONFast(data any) (string, error)
- func ConvertToYAML(data any) (string, error)
- func EnsureDir(fileName string) error
- func FileExists(filename string) bool
- func FileOrDirExists(filename string) bool
- func GetAllFilesInDir(dir string) ([]string, error)
- func GetAllYamlFilesInDir(dir string) ([]string, error)
- func GetGlobMatches(pattern string) ([]string, error)
- func GetLatestGitHubRepoRelease(owner string, repo string) (string, error)
- func IsDirectory(path string) (bool, error)
- func IsGolangTemplate(str string) (bool, error)
- func IsPathAbsolute(path string) bool
- func IsYaml(file string) bool
- func JoinAbsolutePathWithPath(basePath string, providedPath string) (string, error)
- func JoinAbsolutePathWithPaths(basePath string, paths []string) ([]string, error)
- func LogDebug(cliConfig schema.CliConfiguration, message string)
- func LogError(err error)
- func LogErrorAndExit(err error)
- func LogInfo(cliConfig schema.CliConfiguration, message string)
- func LogTrace(cliConfig schema.CliConfiguration, message string)
- func LogWarning(cliConfig schema.CliConfiguration, message string)
- func MapKeyExists(m map[string]any, key string) bool
- func PathMatch(pattern, name string) (bool, error)
- func PrintAsHcl(data any) error
- func PrintAsJSON(data any) error
- func PrintAsYAML(data any) error
- func PrintMessage(message string)
- func PrintMessageInColor(message string, messageColor *color.Color)
- func ProcessTmpl(tmplName string, tmplValue string, tmplData any, ...) (string, error)
- func ProcessTmplWithDatasources(cliConfig schema.CliConfiguration, settingsSection schema.Settings, ...) (string, error)
- func SliceContainsInt(s []int, i int) bool
- func SliceContainsString(s []string, str string) bool
- func SliceContainsStringHasPrefix(s []string, prefix string) bool
- func SliceContainsStringStartsWith(s []string, str string) bool
- func SliceOfInterfacesToSliceOdStrings(input []any) []string
- func SliceOfPathsContainsPath(paths []string, checkPath string) bool
- func SliceOfStringsToSpaceSeparatedString(s []string) string
- func SortMapByKeysAndValuesUniq(m map[string][]string) map[string][]string
- func StringKeysFromMap(m map[string]any) []string
- func TrimBasePathFromPath(basePath string, path string) string
- func UniqueStrings(input []string) []string
- func WriteTerraformBackendConfigToFileAsHcl(cliConfig schema.CliConfiguration, filePath string, backendType string, ...) error
- func WriteToFileAsHcl(cliConfig schema.CliConfiguration, filePath string, data any, ...) error
- func WriteToFileAsJSON(filePath string, data any, fileMode os.FileMode) error
- func WriteToFileAsYAML(filePath string, data any, fileMode os.FileMode) error
Constants ¶
const ( LogLevelTrace = "Trace" LogLevelDebug = "Debug" LogLevelInfo = "Info" LogLevelWarning = "Warning" )
Variables ¶
This section is empty.
Functions ¶
func Coalesce ¶ added in v1.31.0
func Coalesce[T comparable](v ...T) (result T)
Coalesce returns the first non-empty argument. Arguments must be comparable
func ConvertEnvVars ¶ added in v1.4.22
ConvertEnvVars convert ENV vars from a map to a list of strings in the format ["key1=val1", "key2=val2", "key3=val3" ...]
func ConvertFromJSON ¶ added in v1.9.0
ConvertFromJSON converts the provided JSON-encoded string to Go data types
func ConvertPathsToAbsolutePaths ¶
ConvertPathsToAbsolutePaths converts a slice of paths to a slice of absolute paths
func ConvertToHclAst ¶ added in v1.6.0
ConvertToHclAst converts the provided value to an HCL abstract syntax tree
func ConvertToJSON ¶ added in v1.6.0
ConvertToJSON converts the provided value to a JSON-encoded string
func ConvertToJSONFast ¶ added in v1.6.0
ConvertToJSONFast converts the provided value to a JSON-encoded string using 'ConfigFastest' config and json.Marshal without indents
func ConvertToYAML ¶ added in v1.6.0
ConvertToYAML converts the provided value to a YAML string
func EnsureDir ¶ added in v1.5.0
EnsureDir accepts a file path and creates all the intermediate subdirectories
func FileExists ¶
FileExists checks if the file exists and is not a directory
func FileOrDirExists ¶ added in v1.11.3
FileOrDirExists checks if the file or directory exists
func GetAllFilesInDir ¶ added in v1.55.0
GetAllFilesInDir returns all files in the provided directory and all subdirectories
func GetAllYamlFilesInDir ¶ added in v1.55.0
GetAllYamlFilesInDir returns all YAML files in the provided directory and all subdirectories
func GetGlobMatches ¶ added in v1.4.21
GetGlobMatches tries to read and return the Glob matches content from the sync map if it exists in the map, otherwise it finds and returns all files matching the pattern, stores the files in the map and returns the files
func GetLatestGitHubRepoRelease ¶ added in v1.60.0
GetLatestGitHubRepoRelease returns the latest release tag for a GitHub repository
func IsDirectory ¶
IsDirectory checks if the path is a directory
func IsGolangTemplate ¶ added in v1.66.0
IsGolangTemplate checks if the provided string is a Go template
func IsPathAbsolute ¶ added in v1.4.0
IsPathAbsolute checks if the provided file path is absolute
func IsYaml ¶
IsYaml checks if the file has YAML extension (does not check file schema, nor validates the file)
func JoinAbsolutePathWithPath ¶ added in v1.4.27
JoinAbsolutePathWithPath checks if the provided path is absolute. If the provided path is relative, it joins the base path with the path and returns the absolute path
func JoinAbsolutePathWithPaths ¶
JoinAbsolutePathWithPaths joins a base path with each item in the path slice and returns a slice of absolute paths
func LogDebug ¶ added in v1.33.0
func LogDebug(cliConfig schema.CliConfiguration, message string)
LogDebug logs the provided debug message
func LogErrorAndExit ¶ added in v1.33.0
func LogErrorAndExit(err error)
LogErrorAndExit logs errors to std.Error and exits with an error code
func LogInfo ¶ added in v1.33.0
func LogInfo(cliConfig schema.CliConfiguration, message string)
LogInfo logs the provided info message
func LogTrace ¶ added in v1.33.0
func LogTrace(cliConfig schema.CliConfiguration, message string)
LogTrace logs the provided trace message
func LogWarning ¶ added in v1.33.0
func LogWarning(cliConfig schema.CliConfiguration, message string)
LogWarning logs the provided warning message
func MapKeyExists ¶ added in v1.4.1
MapKeyExists checks if a key already defined in a map
func PathMatch ¶ added in v1.4.21
PathMatch returns true if `name` matches the file name `pattern`. PathMatch will automatically use your system's path separator to split `name` and `pattern`. On systems where the path separator is `'\'`, escaping will be disabled.
Note: this is meant as a drop-in replacement for filepath.Match(). It assumes that both `pattern` and `name` are using the system's path separator. If you can't be sure of that, use filepath.ToSlash() on both `pattern` and `name`, and then use the Match() function instead.
func PrintAsHcl ¶ added in v1.6.0
PrintAsHcl prints the provided value as HCL (HashiCorp Language) document to the console
func PrintAsJSON ¶
PrintAsJSON prints the provided value as YAML document to the console
func PrintAsYAML ¶
PrintAsYAML prints the provided value as YAML document to the console
func PrintMessage ¶ added in v1.5.0
func PrintMessage(message string)
PrintMessage prints the message to the console
func PrintMessageInColor ¶ added in v1.54.0
PrintMessageInColor prints the message to the console using the provided color
func ProcessTmpl ¶ added in v1.25.0
func ProcessTmpl(tmplName string, tmplValue string, tmplData any, ignoreMissingTemplateValues bool) (string, error)
ProcessTmpl parses and executes Go templates
func ProcessTmplWithDatasources ¶ added in v1.70.0
func ProcessTmplWithDatasources( cliConfig schema.CliConfiguration, settingsSection schema.Settings, tmplName string, tmplValue string, tmplData any, ignoreMissingTemplateValues bool, ) (string, error)
ProcessTmplWithDatasources parses and executes Go templates with datasources
func SliceContainsInt ¶
SliceContainsInt checks if an int is present in a slice
func SliceContainsString ¶
SliceContainsString checks if a string is present in a slice
func SliceContainsStringHasPrefix ¶ added in v1.23.0
SliceContainsStringHasPrefix checks if a slice contains a string that begins with the given prefix
func SliceContainsStringStartsWith ¶
SliceContainsStringStartsWith checks if a slice contains a string that the given string begins with
func SliceOfInterfacesToSliceOdStrings ¶ added in v1.9.0
SliceOfInterfacesToSliceOdStrings converts a slice of any to a slice os strings
func SliceOfPathsContainsPath ¶ added in v1.17.0
SliceOfPathsContainsPath checks if a slice of file paths contains a path
func SliceOfStringsToSpaceSeparatedString ¶
SliceOfStringsToSpaceSeparatedString checks if an int is present in a slice
func SortMapByKeysAndValuesUniq ¶ added in v1.54.0
SortMapByKeysAndValuesUniq sorts the provided map by the keys, sorts the map values (lists of strings), and makes the values unique
func StringKeysFromMap ¶
StringKeysFromMap returns a slice of sorted string keys from the provided map
func TrimBasePathFromPath ¶
TrimBasePathFromPath trims the base path prefix from the path
func UniqueStrings ¶
UniqueStrings returns a unique subset of the string slice provided
func WriteTerraformBackendConfigToFileAsHcl ¶ added in v1.7.0
func WriteTerraformBackendConfigToFileAsHcl( cliConfig schema.CliConfiguration, filePath string, backendType string, backendConfig map[any]any, ) error
WriteTerraformBackendConfigToFileAsHcl writes the provided Terraform backend config to the specified file https://dev.to/pdcommunity/write-terraform-files-in-go-with-hclwrite-2e1j https://pkg.go.dev/github.com/hashicorp/hcl/v2/hclwrite
func WriteToFileAsHcl ¶ added in v1.6.0
func WriteToFileAsHcl( cliConfig schema.CliConfiguration, filePath string, data any, fileMode os.FileMode, ) error
WriteToFileAsHcl converts the provided value to HCL (HashiCorp Language) and writes it to the specified file
func WriteToFileAsJSON ¶
WriteToFileAsJSON converts the provided value to YAML and writes it to the specified file
Types ¶
This section is empty.
Source Files