domain

Documentation

Index

• type Renderer
  • func GetRenderer() Renderer

Types

type Renderer

type Renderer interface {
	//RenderFile renders a template file
	RenderFile(sourcePath string, info os.FileInfo) error

	//RenderPath renders an object (file os directory) in the templates directory
	RenderPath(sourcePath string, info os.FileInfo, err error) error

	//BackupExistingCode make a copy of the changed file
	BackupExistingCode(sourcePath string) error

	//RenderString processing the provided template source file, using the provided variables
	RenderString(spell domain.Spell, commandName string, stringTemplateFileName string, variables map[string]interface{}) (string, error)

	//RenderTemplate renders all templates in the template directory providing the respective variables
	//commandName: specifies the name of the command for which the template will be rendered
	//globalVariables: defines the list of variables (value) which should be provided for rendering all files
	//specificVariables: defines the list of variables (value) which should be provided for rendering specific file names (key)
	RenderTemplate(spell tooldomain.Spell, commandName string, globalVariables map[string]interface{}, specificVariables map[string]map[string]interface{}) error
}

Renderer defines the features delivered by the Code Template Renderer

func GetRenderer

func GetRenderer() Renderer

GetRenderer returns the current component registered to provide the code rendering features