Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func New ¶
func New(options ao.TemplateOptions) (templateManager, error)
New constructs new instances of our template manager, which allows the caller to interact with a template in various ways
Types ¶
type ArgData ¶
type ArgData struct {
// Name of the argument, exactly as will be used in the template contents
Name string `yaml:"name"`
// Description descriptive text explaining the purpose of the argument
Description string `yaml:"description"`
}
ArgData metadata describing the input args supported by the template. Values for these args must be provided by the user to customize the content produced by the template
type ManifestData ¶
type ManifestData struct {
// Versions version identifiers for various aspects of the template
Versions VersionData `yaml:"versions"`
// Template metadata describing the template
Template TemplateData `yaml:"template"`
// MiscParams all unparsed values in the manifest will be dumped into a simple map structure
MiscParams map[string]interface{} `yaml:"-,flow"`
}
ManifestData parsed content of the manifest file associated with a template
func (*ManifestData) UnmarshalYAML ¶
func (m *ManifestData) UnmarshalYAML(value *yaml.Node) error
UnmarshalYAML custom YAML decoding method compatible with the YAML parsing library
type TemplateData ¶
type TemplateData struct {
// Args list of input parameters supported by the template. These provide user configurable
// options that customize the content produced by the template
Args []ArgData `yaml:"args"`
}
TemplateData metadata describing the template being processed
type VersionData ¶
type VersionData struct {
// Schema version describing the format of the manifest file and its contents
Schema version.Version `yaml:"schema"`
// Jigger the minimum version of the Rejigger app needed to process to the template
Jigger version.Version `yaml:"rejigger"`
// Template the version number associated with the current template
Template version.Version `yaml:"template"`
}
VersionData stores version information about the template
Click to show internal directories.
Click to hide internal directories.