generator

type Generator interface {

	// GetTemplates gets a map of the templates currently
	// available to the generator.
	//
	// Returns a map of the template properties and an error object
	GetTemplates() (map[string]*tmpl.Properties, error)

	// OverridesPath sets the path to use for template files that can override
	// files in the template being generated.
	//
	// Returns the Generator so it can be chained.
	OverridesPath(string) Generator

	// DestinationPath sets the path that will be used for the output of
	// the generated template.
	//
	// Returns the Generator so it can be chained.
	DestinationPath(string) Generator

	// PathPrefix sets the prefix to use for the path to the
	// embedded template folder
	//
	// Returns the Generator so it can be chained.
	PathPrefix(string) Generator

	// CleanDestination tells the generator whether or not to wipe the destination
	// before generating the template. Default is false.
	//
	// Returns the Generator so it can be chained.
	CleanDestination(bool) Generator

	// Generate processes the template and override files and generates the result
	// to the defined destination path.
	Generate(interface{}, *tmpl.Overrides) error
}