templates

Documentation

Index

• func Install(options *flags.Init) error
• func ValidTemplateName(name string) bool
• type Template
• type TemplateData
  • func GetDefaultTemplates() []TemplateData
• type TemplateOptions

Functions

func Install

func Install(options *flags.Init) error

func ValidTemplateName

func ValidTemplateName(name string) bool

Types

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"`
	Version     int8   `json:"version"`

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

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

type TemplateData

type TemplateData struct {
	Name        string
	Description string
	FS          fs.FS
}

func GetDefaultTemplates

func GetDefaultTemplates() []TemplateData

type TemplateOptions

type TemplateOptions struct {
	*flags.Init
	LocalModulePath string
	UseTypescript   bool
}