generate

Documentation

Index

• Constants
• Variables
• type Generator
  • func NewGenerator(layoutDir *string, layoutName *string, destPath *string, destDir *string, ...) (g Generator)
  • func (g *Generator) Generate() (err error)
  • func (g *Generator) GetTemplateByLayout(layoutName string) (err error)
• type LayoutNameEnum

Constants

const (
	// NOTE: for local testing
	// DefaultLayoutDir = "../../layouts"
	DefaultLayoutDir = "./layouts"
	DefaultDestDir   = "./output"
	DefaultDestPath  = "./output/generated.html"
)

Default values when not provided

const (
	LayoutDirNotFound    = "Layout Directory Not Found"
	LayoutNotFoundError  = "Layout Not Found"
	ParseLayoutError     = "Error Parsing Layout"
	ExecuteTemplateError = "Error Execute Template"
)

Default constants

Variables

var FuncMap = template.FuncMap{
	"Title":      strings.Title,
	"TrimScheme": trimScheme,
	"GetColor":   getRandomColor,
	"CheckSkip":  checkStringNil,
}

FuncMap is the default func map that comes w/ generator

var (
	Layouts = []LayoutNameEnum{
		Receipt,
		FeatureUpdates,
	}
)

Types

type Generator

type Generator struct {
	LayoutDir  string
	LayoutName *string
	DestPath   *string
	DestDir    string
	HTML       *bytes.Buffer
	ArgsPath   *string
	ArgsJSON   *string
	Args       interface{}
}

Generator is the base struct to generate templated email

func NewGenerator

func NewGenerator(layoutDir *string, layoutName *string, destPath *string, destDir *string, argsPath *string, argsJSON *string) (g Generator)

NewGenerator creates new templated email generator

func (*Generator) Generate

func (g *Generator) Generate() (err error)

Generate generates actual templated email html

func (*Generator) GetTemplateByLayout

func (g *Generator) GetTemplateByLayout(layoutName string) (err error)

GetTemplateByLayout reads layout and shared directory to create base template

type LayoutNameEnum

type LayoutNameEnum string

LayoutNameEnum is the layout name enum type

const (
	Receipt        LayoutNameEnum = "receipt"
	FeatureUpdates LayoutNameEnum = "feature-updates"
	Reply          LayoutNameEnum = "reply"
)

Layout Names