mirror of
https://github.com/danog/liquid.git
synced 2024-11-27 01:24:40 +01:00
55 lines
1.9 KiB
Go
55 lines
1.9 KiB
Go
/*
|
|
Package liquid is a pure Go implementation of Shopify Liquid templates, for use in https://github.com/osteele/gojekyll.
|
|
|
|
See the project README https://github.com/osteele/liquid for additional information and implementation status.
|
|
*/
|
|
package liquid
|
|
|
|
import (
|
|
"github.com/osteele/liquid/chunks"
|
|
)
|
|
|
|
// Engine parses template source into renderable text.
|
|
//
|
|
// An engine can be configured with additional filters and tags.
|
|
//
|
|
// Filters
|
|
//
|
|
// RegisterFilter defines a Liquid filter.
|
|
//
|
|
// A filter is any function that takes at least one input, and returns one or two outputs.
|
|
// If it returns two outputs, the second must be an error.
|
|
type Engine interface {
|
|
// RegisterFilter defines a filter function e.g. {{ value | filter: arg }}.
|
|
RegisterFilter(name string, fn interface{})
|
|
// RegisterTag defines a tag function e.g. {% tag %}.
|
|
RegisterTag(string, Renderer)
|
|
RegisterBlock(string, Renderer)
|
|
|
|
ParseTemplate([]byte) (Template, error)
|
|
// ParseAndRender parses and then renders the template.
|
|
ParseAndRender([]byte, Bindings) ([]byte, error)
|
|
// ParseAndRenderString is a convenience wrapper for ParseAndRender, that has string input and output.
|
|
ParseAndRenderString(string, Bindings) (string, error)
|
|
}
|
|
|
|
// Template renders a template according to scope.
|
|
//
|
|
// Bindings is a map of liquid variable names to objects.
|
|
type Template interface {
|
|
// Render executes the template with the specified bindings.
|
|
Render(Bindings) ([]byte, error)
|
|
// RenderString is a convenience wrapper for Render, that has string input and output.
|
|
RenderString(Bindings) (string, error)
|
|
}
|
|
|
|
// Bindings is a map of variable names to values.
|
|
type Bindings map[string]interface{}
|
|
|
|
// TagParser parses the argument string "args" from a tag "{% tagname args %}",
|
|
// and returns a renderer.
|
|
// type TagParser func(chunks.RenderContext) (string, error)
|
|
|
|
// Renderer returns the rendered string for a block.
|
|
type Renderer func(chunks.RenderContext) (string, error)
|