utils

Documentation

Index

• func CwdToGitRoot() error
• func GetTemplateByBytes(name string, data map[string]interface{}) ([]byte, error)
• func GetTemplateByString(name string, data map[string]interface{}) (string, error)
• func IsBinaryFile(fileName string) bool
• func IsCommandAvailable(cmd string) bool
• func IsDir(dir string) bool
• func IsFile(filePath string) bool
• func LoadTemplates(files embed.FS) error
• func NewTemplateByString(format string, data map[string]interface{}) (string, error)
• func ReadFile(filePath string) (string, error)
• func SplitText(text string, chunkSize int) []string
• type Data
  • func ConvertToMap(args []string) Data

Functions

func CwdToGitRoot

func CwdToGitRoot() error

func GetTemplateByBytes

func GetTemplateByBytes(name string, data map[string]interface{}) ([]byte, error)

GetTemplateByBytes returns the parsed template as a byte.

func GetTemplateByString

func GetTemplateByString(name string, data map[string]interface{}) (string, error)

GetTemplateByString returns the parsed template as a string.

func IsBinaryFile

func IsBinaryFile(fileName string) bool

func IsCommandAvailable

func IsCommandAvailable(cmd string) bool

IsCommandAvailable checks whether a command is available in the PATH.

func IsDir

func IsDir(dir string) bool

IsDir returns true if given path is a directory, or returns false when it's a file or does not exist.

func IsFile

func IsFile(filePath string) bool

IsFile returns true if given path is a file, or returns false when it's a directory or does not exist.

func LoadTemplates

func LoadTemplates(files embed.FS) error

LoadTemplates loads all the templates found in the templates directory.

func NewTemplateByString

func NewTemplateByString(format string, data map[string]interface{}) (string, error)

func ReadFile

func ReadFile(filePath string) (string, error)

func SplitText

func SplitText(text string, chunkSize int) []string

Types

type Data

type Data map[string]interface{}

Data defines a custom type for the template data.

func ConvertToMap

func ConvertToMap(args []string) Data

ConvertToMap converts a slice of strings to a map.