template

Documentation

Index

• func Install(opt *Options) (err error)
• func PrintList() error
• type Data
• type Options
• type Template
  • func Templates() ([]Template, error)

Functions

func Install

func Install(opt *Options) (err error)

func PrintList

func PrintList() error

Types

type Data

type Data struct {
	ProjectName        string
	PackageName        string
	AuthorName         string
	AuthorEmail        string
	AuthorNameAndEmail string
	OutputFile         string
}

Data will be embedded into the tmpl files during the installation

type Options

type Options struct {
	Data
	Logger       *clilogger.CLILogger
	TemplateName string
	TargetDir    string
	InitGit      bool
}

Options for installing a template

type Template

type Template struct {
	// Template details
	Name        string `json:"name"`
	ShortName   string `json:"shortname"`
	Author      string `json:"author"`
	Description string `json:"description"`
	HelpURL     string `json:"helpurl"`

	// Other data
	FS gofs.FS `json:"-"`
}

Template holds data relating to a template including the metadata stored in template.json

func Templates

func Templates() ([]Template, error)

Templates returns the list of available templates