render

func CreateTemplateHelpers ¶

func CreateTemplateHelpers(templatePath string, opts *options.BoilerplateOptions, tmpl *template.Template) template.FuncMap

Create a map of custom template helpers exposed by boilerplate

func PathRelativeToTemplate ¶

func PathRelativeToTemplate(templatePath string, filePath string) string

Returns the given filePath relative to the given templatePath. If filePath is already an absolute path, returns it unchanged.

Example:

pathRelativeToTemplate("/foo/bar/template-file.txt, "../src/code.java")

Returns: "/foo/src/code.java"

func RenderJsonnetTemplate ¶ added in v0.3.5

func RenderJsonnetTemplate(
	templatePath string,
	variables map[string]interface{},
	opts *options.BoilerplateOptions,
) (string, error)

RenderJsonnetTemplate renders the jsonnet template at templatePath to the target location specified in the boilerplate options, passing in the boilerplate variables as Top Level Arguments. Note that this function will also make available the following helper values as External variables:

- templateFolder - outputFolder

func RenderTemplateFromString ¶ added in v0.3.1

func RenderTemplateFromString(templatePath string, templateContents string, variables map[string]interface{}, opts *options.BoilerplateOptions) (string, error)

Render the template at templatePath, with contents templateContents, using the Go template engine, passing in the given variables as data.

func RenderTemplateWithPartials ¶ added in v0.3.1

func RenderTemplateWithPartials(templatePath string, partials []string, variables map[string]interface{}, opts *options.BoilerplateOptions) (string, error)

RenderTemplateWithPartials renders the template at templatePath with the contents of the root template (the template named by the user on the command line) as well as all of the partials matched by the provided globs using the Go template engine, passing in the given variables as data.

func RenderVariables ¶

func RenderVariables(
	opts *options.BoilerplateOptions,
	variablesToRender map[string]interface{},
	alreadyRenderedVariables map[string]interface{},
) (map[string]interface{}, error)

RenderVariables will render each of the variables that need to be rendered by running it through the go templating syntax. Variable values are allowed to use Go templating syntax (e.g. to reference other variables), so this function loops over each variable value, renders each one, and returns a new map of rendered variables.

This function supports nested variables references, but uses a heuristic based approach. Ideally, we can parse the Go template and build up a graph of variable dependencies to assist with the rendering process, but this takes a lot of effort to get right and maintain.

Instead, we opt for a simpler approach of rendering with multiple trials. In this approach, we continuously attempt to render the template on the variable until all of them render without errors, or we reach the maximum trials. To support this, we ignore the missing key configuration during this evaluation pass and always rely on the template erroring for missing variables. Otherwise, all the variables will render on the first pass.

Note that this is NOT a multi pass algorithm - that is, we do NOT attempt to render the template multiple times. Instead, we do a single template render on each run and reject any that return with an error.