templateutils

Documentation

Index

• Variables
• func Add(args ...int) int
• func AppendSlice(slice []any, value any) []any
• func FileBase(path string) string
• func FileSep() string
• func FileTrimExtFunc(path string) string
• func FilterMatch(pattern string, values []string) ([]string, error)
• func HasSuffix(s, suffix string) bool
• func KeysToMapWithDefault(defaultValue any, keys []string) (map[string]any, error)
• func Last(list any) (any, error)
• func MakeSlice() []any
• func MapString(pattern, replace string, values []string) ([]string, error)
• func Matches(pattern, value string) (bool, error)
• func MustTemplate(fs embed.FS, name string) *template.Template
• func ReplaceAll(s string, old string, new string) string
• func ReplaceAllRegex(pattern, replace, value string) (string, error)
• func SliceContains(slice []any, value any) bool
• func Sub(args ...int) int
• func ToJSON(v any) (string, error)
• func ToJSONPretty(v any) (string, error)
• func WithCommonFuncs(funcMap template.FuncMap) template.FuncMap
• func ZipToMap(keys []string, valuesArg any) (map[string]any, error)

Variables

var UtilityFunctions = template.FuncMap{
	"split":                strings.Split,
	"join":                 strings.Join,
	"basename":             filepath.Base,
	"filterMatch":          FilterMatch,
	"mapString":            MapString,
	"zipToMap":             ZipToMap,
	"keysToMapWithDefault": KeysToMapWithDefault,
	"replace":              ReplaceAllRegex,
	"hasSuffix":            HasSuffix,
	"toLower":              strings.ToLower,
	"add":                  Add,
	"sub":                  Sub,
	"last":                 Last,
	"makeSlice":            MakeSlice,
	"appendSlice":          AppendSlice,
	"sliceContains":        SliceContains,
	"matches":              Matches,
}

Functions

func Add

func Add(args ...int) int

Add returns the sum of all the arguments.

func AppendSlice

func AppendSlice(slice []any, value any) []any

AppendSlice appends a value to a slice and returns the updated slice.

func FileBase

func FileBase(path string) string

FileBase returns the last element of a filepath.

func FileSep

func FileSep() string

FileSep returns the separator for the current OS.

func FileTrimExtFunc

func FileTrimExtFunc(path string) string

FileTrimExtFunc returns the path without the extension.

func FilterMatch

func FilterMatch(pattern string, values []string) ([]string, error)

FilterMatch returns a json array by filtering the values array with the regex pattern

func HasSuffix

func HasSuffix(s, suffix string) bool

HasSuffix checks if a string has a specific suffix.

func KeysToMapWithDefault

func KeysToMapWithDefault(defaultValue any, keys []string) (map[string]any, error)

KeysToMapWithDefault returns a json map by mapping the keys array to the static defaultValue Example keysToMapWithDefault(0, ['a', 'b']) => {"a": 0, "b": 0}

func Last

func Last(list any) (any, error)

Last returns the last element of a list.

func MakeSlice

func MakeSlice() []any

MakeSlice creates and returns a new slice of any type.

func MapString

func MapString(pattern, replace string, values []string) ([]string, error)

MapString takes in a regex pattern and replacement as well as a json array of strings roughly `unmarshal value | sed s/pattern/replace/g | marshal`

func Matches

func Matches(pattern, value string) (bool, error)

Matches returns true if the value matches the regex pattern.

func MustTemplate

func MustTemplate(fs embed.FS, name string) *template.Template

func ReplaceAll

func ReplaceAll(s string, old string, new string) string

ReplaceAll replaces all occurrences of old with new in s.

func ReplaceAllRegex

func ReplaceAllRegex(pattern, replace, value string) (string, error)

ReplaceAllRegex replaces all occurrences of the regex pattern with the replace string in value.

func SliceContains

func SliceContains(slice []any, value any) bool

SliceContains checks if a slice contains a specific value.

func Sub

func Sub(args ...int) int

Sub returns the difference of all the arguments.

func ToJSON

func ToJSON(v any) (string, error)

ToJSON converts any value to a JSON string.

func ToJSONPretty

func ToJSONPretty(v any) (string, error)

ToJSONPretty converts any value to a pretty-printed JSON string.

func WithCommonFuncs

func WithCommonFuncs(funcMap template.FuncMap) template.FuncMap

func ZipToMap

func ZipToMap(keys []string, valuesArg any) (map[string]any, error)

ZipToMap returns a json map by zipping the keys and values arrays Example: zipToMap(['a', 'b'], [1, 2]) => {"a": 1, "b": 2}