utils

package
v1.12.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 6, 2022 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConvertEnvVars added in v1.4.22

func ConvertEnvVars(envVarsMap map[any]any) []string

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

func ConvertFromJSON(jsonString string) (any, error)

ConvertFromJSON converts the provided JSON-encoded string to Go data types

func ConvertPathsToAbsolutePaths

func ConvertPathsToAbsolutePaths(paths []string) ([]string, error)

ConvertPathsToAbsolutePaths converts a slice of paths to a slice of absolute paths

func ConvertToHclAst added in v1.6.0

func ConvertToHclAst(data any) (ast.Node, error)

ConvertToHclAst converts the provided value to an HCL abstract syntax tree

func ConvertToJSON added in v1.6.0

func ConvertToJSON(data any) (string, error)

ConvertToJSON converts the provided value to a JSON-encoded string

func ConvertToJSONFast added in v1.6.0

func ConvertToJSONFast(data any) (string, error)

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

func ConvertToYAML(data any) (string, error)

ConvertToYAML converts the provided value to a YAML string

func EnsureDir added in v1.5.0

func EnsureDir(fileName string) error

EnsureDir accepts a file path and creates all the intermediate subdirectories

func FileExists

func FileExists(filename string) bool

FileExists checks if the file exists and is not a directory

func FileOrDirExists added in v1.11.3

func FileOrDirExists(filename string) bool

FileOrDirExists checks if the file or directory exists

func GetGlobMatches added in v1.4.21

func GetGlobMatches(pattern string) ([]string, error)

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 IsDirectory

func IsDirectory(path string) (bool, error)

IsDirectory checks if the path is a directory

func IsPathAbsolute added in v1.4.0

func IsPathAbsolute(path string) bool

IsPathAbsolute checks if the provided file path is absolute

func IsYaml

func IsYaml(file string) bool

IsYaml checks if the file has YAML extension (does not check file schema, nor validates the file)

func JoinAbsolutePathWithPath added in v1.4.27

func JoinAbsolutePathWithPath(basePath string, providedPath string) (string, error)

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

func JoinAbsolutePathWithPaths(basePath string, paths []string) ([]string, error)

JoinAbsolutePathWithPaths joins a base path with each item in the path slice and returns a slice of absolute paths

func MapKeyExists added in v1.4.1

func MapKeyExists(m map[string]any, key string) bool

MapKeyExists checks if a key already defined in a map

func PathMatch added in v1.4.21

func PathMatch(pattern, name string) (bool, error)

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

func PrintAsHcl(data any) error

PrintAsHcl prints the provided value as HCL (HashiCorp Language) document to the console

func PrintAsJSON

func PrintAsJSON(data any) error

PrintAsJSON prints the provided value as YAML document to the console

func PrintAsYAML

func PrintAsYAML(data any) error

PrintAsYAML prints the provided value as YAML document to the console

func PrintError added in v1.3.26

func PrintError(err error)

PrintError prints errors to std.Output

func PrintErrorToStdError added in v1.4.10

func PrintErrorToStdError(err error)

PrintErrorToStdError prints errors to std.Error

func PrintErrorToStdErrorAndExit added in v1.3.26

func PrintErrorToStdErrorAndExit(err error)

PrintErrorToStdErrorAndExit prints errors to std.Error and exits with an error code

func PrintErrorVerbose added in v1.4.26

func PrintErrorVerbose(verbose bool, err error)

PrintErrorVerbose checks the log level and prints errors to std.Output

func PrintInfo added in v1.4.12

func PrintInfo(message string)

PrintInfo prints the provided info message

func PrintInfoVerbose added in v1.4.12

func PrintInfoVerbose(verbose bool, message string)

PrintInfoVerbose checks the log level and prints the provided info message

func PrintMessage added in v1.5.0

func PrintMessage(message string)

PrintMessage prints the provided message to the console

func PrintMessageVerbose added in v1.5.0

func PrintMessageVerbose(verbose bool, message string)

PrintMessageVerbose checks the log level and prints the provided message to the console

func SliceContainsInt

func SliceContainsInt(s []int, i int) bool

SliceContainsInt checks if an int is present in a slice

func SliceContainsString

func SliceContainsString(s []string, str string) bool

SliceContainsString checks if a string is present in a slice

func SliceContainsStringStartsWith

func SliceContainsStringStartsWith(s []string, str string) bool

SliceContainsStringStartsWith checks if a slice contains a string that the given string begins with

func SliceOfInterfacesToSliceOdStrings added in v1.9.0

func SliceOfInterfacesToSliceOdStrings(input []any) []string

SliceOfInterfacesToSliceOdStrings converts a slice of any to a slice os strings

func SliceOfStringsToSpaceSeparatedString

func SliceOfStringsToSpaceSeparatedString(s []string) string

SliceOfStringsToSpaceSeparatedString checks if an int is present in a slice

func StringKeysFromMap

func StringKeysFromMap(m map[string]any) []string

StringKeysFromMap returns a slice of sorted string keys from the provided map

func TrimBasePathFromPath

func TrimBasePathFromPath(basePath string, path string) string

TrimBasePathFromPath trims the base path prefix from the path

func UniqueStrings

func UniqueStrings(input []string) []string

UniqueStrings returns a unique subset of the string slice provided

func WriteTerraformBackendConfigToFileAsHcl added in v1.7.0

func WriteTerraformBackendConfigToFileAsHcl(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(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

func WriteToFileAsJSON(filePath string, data any, fileMode os.FileMode) error

WriteToFileAsJSON converts the provided value to YAML and writes it to the specified file

func WriteToFileAsYAML

func WriteToFileAsYAML(filePath string, data any, fileMode os.FileMode) error

WriteToFileAsYAML converts the provided value to YAML and writes it to the specified file

Types

This section is empty.

Jump to

Keyboard shortcuts

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