do4way / go-xlsx-templater

Simple xlsx template based document generator

go-xlsx-templater

Simple .xlsx (Excel XML document) template based document generator using handlebars.

Takes input .xlsx documents with mustache sippets in it and renders new document with snippets replaced by provided context.

Thanks to github.com/tealeg/xlsx and github.com/aymerick/raymond for useful libs.

About package in russian

Godoc

Installation

    go get -u "github.com/ivahaev/go-xlsx-templater"

Usage

Import to your project

    import "github.com/ivahaev/go-xlsx-templater"

Prepare template.xlsx template.

Filename may be any of course. For slices use dot notation {{items.name}}. When parser meets dot notation it will repeats contains row.

Prepare context data

    ctx := map[string]interface{}{
        "name": "Github User",
        "nameHeader": "Item name",
        "quantityHeader": "Quantity",
        "items": []map[string]interface{}{
            {
                "name": "Pen",
                "quantity": 2,
            },
            {
                "name": "Pencil",
                "quantity": 1,
            },
            {
                "name": "Condom",
                "quantity": 12,
            },
            {
                "name": "Beer",
                "quantity": 24,
            },
        },
    }

Read template, render with context and save to disk.

Error processing omited in example.

    doc := xlst.New()
	doc.ReadTemplate("./template.xlsx")
	doc.Render(ctx)
	doc.Save("./report.xlsx")

Enjoy created report

Documentation

type Xlst

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

Xlst Represents template struct

func New

func New() *Xlst

New() creates new Xlst struct and returns pointer to it

func (*Xlst) ReadTemplate

func (m *Xlst) ReadTemplate(path string) error

ReadTemplate() reads template from disk and stores it in a struct

func (*Xlst) Render

func (m *Xlst) Render(ctx map[string]interface{}) error

Render() renders report and stores it in a struct

func (*Xlst) Save

func (m *Xlst) Save(path string) error

Save() saves generated report to disk

func (*Xlst) Write

func (m *Xlst) Write(writer io.Writer) error

Write() writes generated report to provided writer