templates

Documentation

Index

• func ProcessTemplate(options, rootOpts *options.BoilerplateOptions, thisDep variables.Dependency) error
• type ProcessedEngine
• type ProcessedSkipFile

Functions

func ProcessTemplate

func ProcessTemplate(options, rootOpts *options.BoilerplateOptions, thisDep variables.Dependency) error

Process the boilerplate template specified in the given options and use the existing variables. This function will download remote templates to a temporary working directory, which is cleaned up at the end of the function. This function will load any missing variables (either from command line options or by prompting the user), execute all the dependent boilerplate templates, and then execute this template. Note that we pass in rootOptions so that template dependencies can inspect properties of the root template.

Types

type ProcessedEngine

type ProcessedEngine struct {
	// List of paths relative to template folder that should be skipped
	EvaluatedPaths []string

	// The template engine to use.
	TemplateEngine variables.TemplateEngineType
}

type ProcessedSkipFile

type ProcessedSkipFile struct {
	// List of paths relative to template folder that should be skipped
	EvaluatedPaths []string

	// List of paths relative to template folder that should not be skipped
	EvaluatedNotPaths []string

	// Whether or not to skip the files if the paths match. This is the boilerplate rendered value of the if attribute
	// of a given skip file.
	RenderedSkipIf bool
}