helpers

Documentation

Index

• Variables
• func CancelOnSignal(ctx context.Context, signal_ os.Signal, cancel func()) error
• func CastList[To any, From any](list []From) ([]To, bool)
• func CastList2[To any, From any](list interface{}) ([]To, bool)
• func CastMapMember[To any](m map[string]interface{}, k string) (*To, bool)
• func CastStringMap[To any, From any](m map[string]From) (map[string]To, bool)
• func CastToNumberList[To Number, From Number](list []From) ([]To, bool)
• func ConvertJSONArrayToYAML(jsonContent string) (string, error)
• func ConvertJSONMapToYAML(jsonContent string) (string, error)
• func ConvertYAMLArrayToJSON(yamlContent string) (string, error)
• func ConvertYAMLMapToJSON(yamlContent string) (string, error)
• func CreateHtmlTemplate(name string) *html.Template
• func CreateTemplate(name string) *template.Template
• func InterfaceListToStringList(list []interface{}) []string
• func InterfaceToStringList(list interface{}) []string
• func LoadJSONFile(path string, target interface{}) error
• func LoadYAMLFile(path string, target interface{}) error
• func RenderHtmlTemplateString(tmpl string, data interface{}) (string, error)
• func RenderTemplate(tmpl TemplateExecute, data interface{}) (string, error)
• func RenderTemplateFile(filename string, data interface{}) (string, error)
• func RenderTemplateString(tmpl string, data interface{}) (string, error)
• func SetFloatListReflectValue[To Number](value reflect.Value, v interface{}) error
• func SetIntListReflectValue[To Number](value reflect.Value, v interface{}) error
• func SetReflectValue(value reflect.Value, v interface{}) error
• func StringInSlice(needle string, haystack []string) bool
• func StructToMap(i interface{}, lowerCaseKeys bool) map[string]interface{}
• type FloatNumber
• type Number
• type SignedInt
• type TemplateExecute
• type UnsignedInt

Variables

var TemplateFuncs = template.FuncMap{

	"trim":                    strings.TrimSpace,
	"trimRightSpace":          trimRightSpace,
	"trimTrailingWhitespaces": trimRightSpace,
	"rpad":                    rpad,
	"quote":                   quote,
	"stripNewlines":           stripNewlines,
	"quoteNewlines":           quoteNewlines,

	"toUpper": strings.ToUpper,
	"toLower": strings.ToLower,

	"replace":       replace,
	"replaceRegexp": replaceRegexp,

	"add": add,
	"sub": sub,
	"div": div,
	"mul": mul,

	"parseFloat": parseFloat,
	"parseInt":   parseInt,

	"currency": currency,

	"padLeft":  padLeft,
	"padRight": padRight,

	"bold":          bold,
	"underline":     underline,
	"italic":        italic,
	"strikethrough": strikethrough,
	"code":          code,
	"codeBlock":     codeBlock,

	"toYaml":      toYaml,
	"indentBlock": indentBlock,
}

TemplateFuncs provides helpers for the standard cobra usage and help templates

Functions

func CancelOnSignal

func CancelOnSignal(ctx context.Context, signal_ os.Signal, cancel func()) error

func CastList

func CastList[To any, From any](list []From) ([]To, bool)

CastList casts a list of From objects to To, by casting it to an interface{} in between.

func CastList2

func CastList2[To any, From any](list interface{}) ([]To, bool)

CastList2 attempts even harder to cast a list of From object to To, by checking if we might be dealing with a list masquerading as a interface{}, then a []interface{}, before checking for []To.

func CastMapMember

func CastMapMember[To any](m map[string]interface{}, k string) (*To, bool)

func CastStringMap

func CastStringMap[To any, From any](m map[string]From) (map[string]To, bool)

func CastToNumberList

func CastToNumberList[To Number, From Number](list []From) ([]To, bool)

CastToNumberList casts a list of From objects to To. This is useful for transform between different int types, for example.

func ConvertJSONArrayToYAML

func ConvertJSONArrayToYAML(jsonContent string) (string, error)

func ConvertJSONMapToYAML

func ConvertJSONMapToYAML(jsonContent string) (string, error)

func ConvertYAMLArrayToJSON

func ConvertYAMLArrayToJSON(yamlContent string) (string, error)

func ConvertYAMLMapToJSON

func ConvertYAMLMapToJSON(yamlContent string) (string, error)

func CreateHtmlTemplate

func CreateHtmlTemplate(name string) *html.Template

func CreateTemplate

func CreateTemplate(name string) *template.Template

func InterfaceListToStringList

func InterfaceListToStringList(list []interface{}) []string

func InterfaceToStringList

func InterfaceToStringList(list interface{}) []string

func LoadJSONFile

func LoadJSONFile(path string, target interface{}) error

func LoadYAMLFile

func LoadYAMLFile(path string, target interface{}) error

func RenderHtmlTemplateString

func RenderHtmlTemplateString(tmpl string, data interface{}) (string, error)

func RenderTemplate

func RenderTemplate(tmpl TemplateExecute, data interface{}) (string, error)

func RenderTemplateFile

func RenderTemplateFile(filename string, data interface{}) (string, error)

func RenderTemplateString

func RenderTemplateString(tmpl string, data interface{}) (string, error)

func SetFloatListReflectValue

func SetFloatListReflectValue[To Number](value reflect.Value, v interface{}) error

func SetIntListReflectValue

func SetIntListReflectValue[To Number](value reflect.Value, v interface{}) error

func SetReflectValue

func SetReflectValue(value reflect.Value, v interface{}) error

func StringInSlice

func StringInSlice(needle string, haystack []string) bool

func StructToMap

func StructToMap(i interface{}, lowerCaseKeys bool) map[string]interface{}

Types

type FloatNumber

type FloatNumber interface {
	float32 | float64
}

type Number

type Number interface {
	int | int8 | int16 | int32 | int64 | uint | uint8 | uint16 | uint32 | uint64 | uintptr | float32 | float64
}

type SignedInt

type SignedInt interface {
	int | int8 | int16 | int32 | int64
}

type TemplateExecute

type TemplateExecute interface {
	Execute(wr io.Writer, data any) error
}

type UnsignedInt

type UnsignedInt interface {
	uint | uint8 | uint16 | uint32 | uint64 | uintptr
}