utils

Documentation

Index

• Variables
• func CleanupWorkDir(fs afero.Fs, path string)
• func CreateWorkDir(fs afero.Fs) (string, error)
• func Experimental() bool
• func FS(ctx context.Context) afero.Fs
• func HasJsonOrYamlExt(str string) bool
• func HasSuffix(str string, extensions []string) bool
• func IsFile(ctx context.Context, path string) (bool, error)
• func IsJson(data string) bool
• func IsYamlMap(data string) bool
• func RenderFromTemplates(input any, efs embed.FS) ([]byte, error)
• func RenderFromTemplatesWithGlob(input any, main string, glob []string, efs embed.FS) ([]byte, error)
• func RenderFromTemplatesWithMain(input any, main string, efs embed.FS) ([]byte, error)
• func SetColorEnabled(flagNoColor, flagForceColor bool)
• func SetupTemplate(efs embed.FS) (*template.Template, error)
• func SetupTemplateWithGlob(glob []string, efs embed.FS) (*template.Template, error)
• func ToJSON(data []byte) ([]byte, error)
• func WithFS(ctx context.Context, fs afero.Fs) context.Context
• func WriteTempFile(ctx context.Context, data, prefix string) (string, error)

Variables

var ColorEnabled bool

Functions

func CleanupWorkDir

func CleanupWorkDir(fs afero.Fs, path string)

CleanupWorkDir removes all files in a directory Eat any errors so we can call it from defer

func CreateWorkDir

func CreateWorkDir(fs afero.Fs) (string, error)

CreateWorkDir creates the working directory in tmp and some subdirectories

func Experimental

func Experimental() bool

detect if the EC_EXPERIMENTAL env var is set to enable experimental features

func FS

func FS(ctx context.Context) afero.Fs

func HasJsonOrYamlExt

func HasJsonOrYamlExt(str string) bool

func HasSuffix

func HasSuffix(str string, extensions []string) bool

func IsFile

func IsFile(ctx context.Context, path string) (bool, error)

func IsJson

func IsJson(data string) bool

detect if the string is json

func IsYamlMap

func IsYamlMap(data string) bool

detect if the string is yamlMap

func RenderFromTemplates

func RenderFromTemplates(input any, efs embed.FS) ([]byte, error)

Here we do the ExecuteTemplate for the caller and return just the output

func RenderFromTemplatesWithGlob

func RenderFromTemplatesWithGlob(input any, main string, glob []string, efs embed.FS) ([]byte, error)

func RenderFromTemplatesWithMain

func RenderFromTemplatesWithMain(input any, main string, efs embed.FS) ([]byte, error)

func SetColorEnabled

func SetColorEnabled(flagNoColor, flagForceColor bool)

func SetupTemplate

func SetupTemplate(efs embed.FS) (*template.Template, error)

Here we assume the caller will do the Execute or ExecuteTemplate themselves

func SetupTemplateWithGlob

func SetupTemplateWithGlob(glob []string, efs embed.FS) (*template.Template, error)

func ToJSON

func ToJSON(data []byte) ([]byte, error)

ToJSON converts a single YAML document into a JSON document or returns an error. If the document appears to be JSON the YAML decoding path is not used.

func WithFS

func WithFS(ctx context.Context, fs afero.Fs) context.Context

func WriteTempFile

func WriteTempFile(ctx context.Context, data, prefix string) (string, error)

create a file in a temp dir with contents of data