engine

Documentation

Index

• Constants
• type Asset
• type Assets
  • func LoadAssets(location, outputFolder string) (Assets, error)
• type ContentGenerator
• type Engine
  • func NewEngine(templates Templates, scripts Scripts, assets Assets) *Engine
  • func (engine *Engine) AssetURL(asset string) (string, error)
  • func (engine *Engine) Generate(output string) error
  • func (engine *Engine) HandlePath(newPath string, loader ContentGenerator) error
  • func (engine *Engine) MinifyHTML(content []byte) ([]byte, error)
  • func (engine *Engine) MinifyJS(content []byte) ([]byte, error)
  • func (engine *Engine) MinifyJson(content []byte) ([]byte, error)
  • func (engine *Engine) RenderTemplate(template_ string, symbolMap map[string]string) ([]byte, error)
  • func (engine *Engine) ScriptURL(script string) (string, error)
• type Script
• type Scripts
  • func LoadScripts(location, output string) (Scripts, error)
• type Templates
  • func LoadTemplates(location string) (Templates, error)

Constants

const (
	JSExtension   = "js"
	JsonExtension = "json"
	HTMLExtension = "html"
)

const (
	PathAlreadyInUse      = "Path %s is already being in use"
	TemplateNotFound      = "Template %s not found"
	AssetNotFound         = "Asset %s not found"
	ScriptNotFound        = "Script %s not found"
	ScriptIsNotAGoPackage = "Script %s is not a go package"
)

Types

type Asset

type Asset struct {
	WebPagePath    string
	FileSystemPath string
}

type Assets

type Assets map[string]Asset

func LoadAssets

func LoadAssets(location, outputFolder string) (Assets, error)

type ContentGenerator

type ContentGenerator func(engine *Engine) ([]byte, error)

type Engine

type Engine struct {
	Templates Templates
	Scripts   Scripts
	Assets    Assets
	// contains filtered or unexported fields
}

func NewEngine

func NewEngine(templates Templates, scripts Scripts, assets Assets) *Engine

func (*Engine) AssetURL

func (engine *Engine) AssetURL(asset string) (string, error)

func (*Engine) Generate

func (engine *Engine) Generate(output string) error

func (*Engine) HandlePath

func (engine *Engine) HandlePath(newPath string, loader ContentGenerator) error

func (*Engine) MinifyHTML

func (engine *Engine) MinifyHTML(content []byte) ([]byte, error)

func (*Engine) MinifyJS

func (engine *Engine) MinifyJS(content []byte) ([]byte, error)

func (*Engine) MinifyJson

func (engine *Engine) MinifyJson(content []byte) ([]byte, error)

func (*Engine) RenderTemplate

func (engine *Engine) RenderTemplate(template_ string, symbolMap map[string]string) ([]byte, error)

func (*Engine) ScriptURL

func (engine *Engine) ScriptURL(script string) (string, error)

type Script

type Script struct {
	WebPagePath string
	PackagePath string
}

type Scripts

type Scripts map[string]Script

func LoadScripts

func LoadScripts(location, output string) (Scripts, error)

type Templates

type Templates map[string]string

func LoadTemplates

func LoadTemplates(location string) (Templates, error)