template

Documentation

Index

• func AddDotForVariablesInConfigProcessor(bytes []byte) []byte
• func AddQuoteForVariablesInConfigProcessor(bytes []byte) []byte
• func ContentGetter(content string) ([]byte, error)
• func LocalFileGetter(filepath string) ([]byte, error)
• func URLGetter(url string) ([]byte, error)
• type RenderAPI
  • func NewRenderClient(clientOption *TemplateOption, getter getFunc, processors ...processFunc) RenderAPI
• type TemplateOption

Functions

func AddDotForVariablesInConfigProcessor

func AddDotForVariablesInConfigProcessor(bytes []byte) []byte

AddDotForVariablesInConfigProcessor will add dot before varName this is because our variables' syntax is [[ varName ]] while Go's template is [[ .varName ]]

func AddQuoteForVariablesInConfigProcessor

func AddQuoteForVariablesInConfigProcessor(bytes []byte) []byte

AddQuoteForVariablesInConfigProcessor will add quote for special varName When [[ ]] has two words and the first word don't contain quota, add quotes to the second word e.g. [[ env GITHUB_TOKEN]] -> [[ env "GITHUB_TOKEN" ]] [[ env 'GITHUB_TOKEN' ]] -> do nothing [[ env "GITHUB_TOKEN" ]] -> do nothing [[ "env" "GITHUB_TOKEN" ]] -> do nothing [[ GITHUB_TOKEN ]] -> do nothing

func ContentGetter

func ContentGetter(content string) ([]byte, error)

ContentGetter get content bytes from input content

func LocalFileGetter

func LocalFileGetter(filepath string) ([]byte, error)

LocalFileGetter get content bytes from file

func URLGetter

func URLGetter(url string) ([]byte, error)

URLGetter get content bytes from remote url

Types

type RenderAPI

type RenderAPI interface {
	Render(inputStr string, variables any) (string, error)
}

RenderAPI is a interface with render methods

func NewRenderClient

func NewRenderClient(clientOption *TemplateOption, getter getFunc, processors ...processFunc) RenderAPI

NewRenderClient create template render client with template option, getter and processors

type TemplateOption

type TemplateOption struct {
	Name               string
	IgnoreMissKeyError bool
	FuncMap            template.FuncMap
}

TemplateOption is used to config template option