textwire

README

Textwire. A templating language for Go

Textwire is a simple yet powerful templating language for Go. It is designed to easily inject variables from Go code into a template file or just a regular string. It is inspired by Go's syntax and has a similar syntax to make it easier for Go developers to learn and use it.

Read Official Documentation

Installation

go get github.com/textwire/textwire

VSCode Extension

If you use VSCode as your primary editor, you can install the Textwire extension to get syntax highlighting and other features for Textwire.

License

The Textwire project is licensed under the MIT License

Documentation

Index

• func EvaluateFile(absPath string, data map[string]interface{}) (string, error)
• func EvaluateString(inp string, data map[string]interface{}) (string, error)
• type Config
• type Template
  • func NewTemplate(c *Config) (*Template, error)
  • func (t *Template) Response(w http.ResponseWriter, filename string, data map[string]interface{}) error
  • func (t *Template) String(filename string, data map[string]interface{}) (string, *fail.Error)

Functions

func EvaluateFile

func EvaluateFile(absPath string, data map[string]interface{}) (string, error)

func EvaluateString

func EvaluateString(inp string, data map[string]interface{}) (string, error)

Types

type Config

type Config struct {
	// TemplateDir is the directory where the Textwire
	// templates are located. Default is "templates"
	TemplateDir string

	// TemplateExt is the extension of the Textwire
	// template files. Default is ".tw.html"
	// If you use a different extension other then ".tw.html",
	// you will loose syntax highlighting in VSCode editor
	// if you use the Textwire extension
	TemplateExt string
	// contains filtered or unexported fields
}

Config is the main configuration for Textwire

type Template

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

func NewTemplate

func NewTemplate(c *Config) (*Template, error)

func (*Template) Response

func (t *Template) Response(w http.ResponseWriter, filename string, data map[string]interface{}) error

func (*Template) String

func (t *Template) String(filename string, data map[string]interface{}) (string, *fail.Error)