Documentation
¶
Overview ¶
Package gomplate is a template renderer which supports a number of datasources, and includes hundreds of built-in functions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
var Stdout io.WriteCloser = os.Stdout
Stdout allows overriding the writer to use when templates are written to stdout ("-").
Functions ¶
func RunTemplates ¶
RunTemplates - run all gomplate templates specified by the given configuration
Types ¶
type Config ¶
type Config struct {
Input string
InputFiles []string
InputDir string
ExcludeGlob []string
OutputFiles []string
OutputDir string
OutputMap string
OutMode string
DataSources []string
DataSourceHeaders []string
Contexts []string
LDelim string
RDelim string
Templates []string
}
Config - values necessary for rendering templates with gomplate. Mainly for use by the CLI
type MetricsType ¶
type MetricsType struct {
TemplatesGathered int
TemplatesProcessed int
Errors int
GatherDuration time.Duration // time it took to gather templates
TotalRenderDuration time.Duration // time it took to render all templates
RenderDuration map[string]time.Duration // times for rendering each template
}
MetricsType - Warning: experimental! This may change in breaking ways without warning. This is not subject to any semantic versioning guarantees!
var Metrics *MetricsType
Metrics tracks interesting basic metrics around gomplate executions. Warning: experimental! This may change in breaking ways without warning. This is not subject to any semantic versioning guarantees!
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
Package aws contains functions which wrap various Amazon Web Services APIs
|
Package aws contains functions which wrap various Amazon Web Services APIs |
|
Package base64 contains Base64 encoding/decoding functions
|
Package base64 contains Base64 encoding/decoding functions |
|
cmd
|
|
|
gomplate
command
The gomplate command
|
The gomplate command |
|
Package coll contains functions to help manipulate and query collections of data, like slices/arrays and maps.
|
Package coll contains functions to help manipulate and query collections of data, like slices/arrays and maps. |
|
Package conv contains functions that help converting data between different types
|
Package conv contains functions that help converting data between different types |
|
Package crypto contains functions to help perform hashing and simple encryption operations
|
Package crypto contains functions to help perform hashing and simple encryption operations |
|
Package data contains functions that parse and produce data structures in different formats.
|
Package data contains functions that parse and produce data structures in different formats. |
|
Package env contains functions that retrieve data from the environment
|
Package env contains functions that retrieve data from the environment |
|
Package file contains functions for working with files and directories on the local filesystem
|
Package file contains functions for working with files and directories on the local filesystem |
|
Package funcs is an internal package that provides gomplate namespaces and functions to be used in 'text/template' templates.
|
Package funcs is an internal package that provides gomplate namespaces and functions to be used in 'text/template' templates. |
|
Package math contains set of basic math functions to be able to perform simple arithmetic operations
|
Package math contains set of basic math functions to be able to perform simple arithmetic operations |
|
Package net contains functions to help with network-oriented lookups
|
Package net contains functions to help with network-oriented lookups |
|
Package random contains functions for generating random values
|
Package random contains functions for generating random values |
|
Package regexp contains functions for dealing with regular expressions
|
Package regexp contains functions for dealing with regular expressions |
|
Package strings contains functions to manipulate strings
|
Package strings contains functions to manipulate strings |
|
Package test contains functions to help validate assumptions and can cause template generation to fail in specific cases
|
Package test contains functions to help validate assumptions and can cause template generation to fail in specific cases |
|
tests
|
|
|
integration
Package integration contains integration tests.
|
Package integration contains integration tests. |
|
Package time contains functions to help work with date and time
|
Package time contains functions to help work with date and time |
|
Package tmpl contains functions for defining or executing in-line templates.
|
Package tmpl contains functions for defining or executing in-line templates. |