templatedir

Documentation

Index

• type TemplateDir
  • func New(fs fs.FS) *TemplateDir
  • func (t *TemplateDir) Extract(targetDirectory string, data interface{}) error
  • func (t *TemplateDir) IgnoreFile(filename string)
  • func (t *TemplateDir) RenameFiles(renameFiles map[string]string)
  • func (t *TemplateDir) SetTemplateFilters(filters []string)

Types

type TemplateDir

type TemplateDir struct {
	// contains filtered or unexported fields
}

TemplateDir defines a directory containing directories and files, including template files

func New

func New(fs fs.FS) *TemplateDir

New attempts to create a new TemplateDir from the given FS

func (*TemplateDir) Extract

func (t *TemplateDir) Extract(targetDirectory string, data interface{}) error

Extract the templates to the given directory, using data as input

func (*TemplateDir) IgnoreFile

func (t *TemplateDir) IgnoreFile(filename string)

IgnoreFile will add the given filename to the list of files to ignore during extraction

func (*TemplateDir) RenameFiles

func (t *TemplateDir) RenameFiles(renameFiles map[string]string)

func (*TemplateDir) SetTemplateFilters

func (t *TemplateDir) SetTemplateFilters(filters []string)

SetTemplateFilters sets the template filter. Each filename is checked to see if it contains this string and if so, it is deemed to be a template file