yamltmpl

README

YAML Templating Library for Golang

Introduction

yamltmpl uses text/template as internal template engine. Check its document for details.

Installation

go get github.com/Spiderpowa/yamltmpl

Example

package main

import (
    "bytes"
    "fmt"

    "github.com/Spiderpowa/yamltmpl"
)

func main() {
    tmpl := yamltmpl.New("test")
    tmpl, err := tmpl.Parse("host: {{.host}}\nport: {{.port}}\nname: it's a test")
    if err != nil {
        panic(err)
    }
    buf := new(bytes.Buffer)
    if err := tmpl.ApplyYaml([]byte("port: 3000\nhost: http://localhost"), buf); err != nil {
        panic(err)
    }
    fmt.Println(buf.String())
}

The output is

host: http://localhost
port: 3000
name: it's a test

Documentation

Godoc Template

Documentation

Index

• func Funcs(funcs template.FuncMap)
• type Template
  • func New(name string) *Template
  • func (t *Template) Apply(rd io.Reader, wr io.Writer, overrides ...map[string]interface{}) error
  • func (t *Template) ApplyYaml(in []byte, wr io.Writer, overrides ...map[string]interface{}) error
  • func (t *Template) Funcs(funcs template.FuncMap) *Template
  • func (t *Template) Parse(in string) (*Template, error)
  • func (t *Template) ParseFile(file string) (*Template, error)

Functions

func Funcs

func Funcs(funcs template.FuncMap)

Funcs adds the default function.

Types

type Template

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

Template is the parsed template structure.

func New

func New(name string) *Template

New creates a Template instance.

func (*Template) Apply

func (t *Template) Apply(rd io.Reader, wr io.Writer, overrides ...map[string]interface{}) error

Apply applies yaml input from Reader to the template and write its output to writer.

func (*Template) ApplyYaml

func (t *Template) ApplyYaml(in []byte, wr io.Writer, overrides ...map[string]interface{}) error

ApplyYaml applies yaml input to the template and write its output to writer.

func (*Template) Funcs

func (t *Template) Funcs(funcs template.FuncMap) *Template

Funcs adds the function to the template's function map.

func (*Template) Parse

func (t *Template) Parse(in string) (*Template, error)

Parse the template input.

func (*Template) ParseFile

func (t *Template) ParseFile(file string) (*Template, error)

ParseFile parses the file as the template input.