This repository was archived by the owner on Jan 21, 2020. It is now read-only.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR introduces an interface called
template.Context
that the context for the template can optionally implement. If a struct value is used as the template context and this struct also implements this interface, the template engine will expose template functions of the formfunc(ctx template.Context, arg string) string
as a regular template function of the formfunc(arg string) string
. It does this by dynamically creating a new function which omits the first argument.This allows the template developer to expose functions that can carry state that are not visible to the users of the template and still keep the template function easy to use (no context parameter in the template function arguments).
In essence, this PR allows a template to be viewed as a complex, user-programmable function whose evaluation/application not only produces a string (the output of the template) but also a complex value where its state can be updated via template function calls as they appear in the template text. An example of this is in
pkg/template/integration_test.go
where a simplecontext
struct exports template functions to print and mutate some state and keeping track of invocation count. At the end of the evaluation of the template, a string view is rendered and the state of the struct reflects the function invocations in the text template.