render

Documentation

Index

• func Render(sourcePath string, buildPath string, cfg *models.Config) int
• func Watch(sourcePath string, buildPath string, cfg *models.Config, port int32, ...)
• type ConsoleRenderer
  • func (c ConsoleRenderer) Initialise()
  • func (c ConsoleRenderer) Render(route *models.Route, filePath string, data jet.VarMap) (errorCount int)
• type FileRenderer
  • func (c FileRenderer) Initialise()
  • func (c FileRenderer) Render(templatePath string, filePath string, data jet.VarMap) int
• type LiveReload
  • func (live *LiveReload) GetMiddleware(next http.Handler) http.Handler
  • func (live *LiveReload) Handler(w http.ResponseWriter, req *http.Request)
  • func (live *LiveReload) StartLiveReload(port int32, fn func())
• type Prox
  • func NewProxy(target string, patterns []string) *Prox
  • func (p *Prox) GetMiddleware(next http.Handler) http.Handler
• type WrapperResponseWriter
  • func NewWrapperResponseWriter(w http.ResponseWriter) *WrapperResponseWriter
  • func (w *WrapperResponseWriter) Done() (n int, err error)
  • func (w *WrapperResponseWriter) PrefixWithLogs(logs []string)
  • func (w *WrapperResponseWriter) Status() int
  • func (w *WrapperResponseWriter) Write(p []byte) (n int, err error)
  • func (w *WrapperResponseWriter) WriteHeader(code int)

Functions

func Render

func Render(sourcePath string, buildPath string, cfg *models.Config) int

Render - render the files

func Watch

func Watch(sourcePath string, buildPath string, cfg *models.Config, port int32, logReader utils.LogReader, reloadBrowserOnChange bool)

Watch -

Types

type ConsoleRenderer

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

ConsoleRenderer - designed to render to the console for testing

func (ConsoleRenderer) Initialise

func (c ConsoleRenderer) Initialise()

Initialise - start the rendering process

func (ConsoleRenderer) Render

func (c ConsoleRenderer) Render(route *models.Route, filePath string, data jet.VarMap) (errorCount int)

Render - render to the console

type FileRenderer

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

FileRenderer - designed to render to the file system for testing

func (FileRenderer) Initialise

func (c FileRenderer) Initialise()

Initialise - start the rendering process

func (FileRenderer) Render

func (c FileRenderer) Render(templatePath string, filePath string, data jet.VarMap) int

Render - render to a file

type LiveReload

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

LiveReload -

func (*LiveReload) GetMiddleware

func (live *LiveReload) GetMiddleware(next http.Handler) http.Handler

GetMiddleware - return a handler

func (*LiveReload) Handler

func (live *LiveReload) Handler(w http.ResponseWriter, req *http.Request)

Handler - handle the live reload

func (*LiveReload) StartLiveReload

func (live *LiveReload) StartLiveReload(port int32, fn func())

StartLiveReload - start the process to watch the files and wait for a reload

type Prox

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

Prox - RerverseProxy object

func NewProxy

func NewProxy(target string, patterns []string) *Prox

NewProxy - create a proxy that will rewrite the scheme and host

func (*Prox) GetMiddleware

func (p *Prox) GetMiddleware(next http.Handler) http.Handler

GetMiddleware - add the proxuy middleware

type WrapperResponseWriter

type WrapperResponseWriter struct {
	http.ResponseWriter
	// contains filtered or unexported fields
}

WrapperResponseWriter - wraps request intercepts all write calls so as to append the live reload script

func NewWrapperResponseWriter

func NewWrapperResponseWriter(w http.ResponseWriter) *WrapperResponseWriter

NewWrapperResponseWriter - create a new response writer

func (*WrapperResponseWriter) Done

func (w *WrapperResponseWriter) Done() (n int, err error)

Done - called when are ready to return a result

func (*WrapperResponseWriter) PrefixWithLogs

func (w *WrapperResponseWriter) PrefixWithLogs(logs []string)

PrefixWithLogs - write the logs to the head of the page

func (*WrapperResponseWriter) Status

func (w *WrapperResponseWriter) Status() int

Status - get the status

func (*WrapperResponseWriter) Write

func (w *WrapperResponseWriter) Write(p []byte) (n int, err error)

Write - wrap the write

func (*WrapperResponseWriter) WriteHeader

func (w *WrapperResponseWriter) WriteHeader(code int)

WriteHeader - wrap the write header