Use in Go

Mugo's internal template runner and functions are available as a Go package.

templatex

templatex is a package that provides a template runner with options.

go get github.com/rytsh/mugo

import "github.com/rytsh/mugo/templatex"

Usage

Check details in go document: https://pkg.go.dev/github.com/rytsh/mugo/templatex

tpl := templatex.New()

tpl.AddFunc("add", func(a, b int) int {
    return a + b
})

tpl.AddFunc("sub", func(a, b int) int {
    return a - b
})

var output bytes.Buffer
if err := tpl.Execute(
    templatex.WithIO(&output),
    templatex.WithData(map[string]any{
        "a": 1,
        "b": 2,
    }),
    templatex.WithContent(`a + b = {{ add .a .b }}`+"\n"+`a - b = {{ sub .a .b }}`),
); err != nil {
    log.Fatal(err)
}

fmt.Printf("%s", output.String())
// Output:
// a + b = 3
// a - b = -1

fstore

fstore is a package that provides bunch of functions with options.

go get github.com/rytsh/mugo

import (
	_ "github.com/rytsh/mugo/fstore/registry"

    "github.com/rytsh/mugo/fstore"
)

Usage

Check details in go document: https://pkg.go.dev/github.com/rytsh/mugo/fstore

fstore's functions not enabled by default and you need to import the registry package or you can import some packages under fstore/registry.

import _ "github.com/rytsh/mugo/fstore/registry"

// import (
// 	_ "github.com/rytsh/mugo/fstore/registry/cast"
// 	_ "github.com/rytsh/mugo/fstore/registry/codec"
// 	_ "github.com/rytsh/mugo/fstore/registry/crypto"
// 	_ "github.com/rytsh/mugo/fstore/registry/exec"
// 	_ "github.com/rytsh/mugo/fstore/registry/faker"
// 	_ "github.com/rytsh/mugo/fstore/registry/file"
// 	_ "github.com/rytsh/mugo/fstore/registry/html2"
// 	_ "github.com/rytsh/mugo/fstore/registry/humanize"
// 	_ "github.com/rytsh/mugo/fstore/registry/log"
// 	_ "github.com/rytsh/mugo/fstore/registry/maps"
// 	_ "github.com/rytsh/mugo/fstore/registry/math"
// 	_ "github.com/rytsh/mugo/fstore/registry/minify"
// 	_ "github.com/rytsh/mugo/fstore/registry/os"
// 	_ "github.com/rytsh/mugo/fstore/registry/random"
// 	_ "github.com/rytsh/mugo/fstore/registry/sprig"
// 	_ "github.com/rytsh/mugo/fstore/registry/template"
// 	_ "github.com/rytsh/mugo/fstore/registry/time"
// 	_ "github.com/rytsh/mugo/fstore/registry/ungroup"
// )

tpl := template.New("test").Funcs(fstore.FuncMap())

output := &bytes.Buffer{}
tplParsed, err := tpl.Parse(`{{ $v := codec.JsonDecode (codec.StringToByte .) }}{{ $v.data.name }}`)
if err != nil {
    log.Fatal(err)
}

if err := tplParsed.Execute(output, `{"data": {"name": "Hatay"}}`); err != nil {
    log.Fatal(err)
}

fmt.Printf("%s", output)
// Output:
// Hatay

Use fstore with templatex

fstore and templatex can be used together. Use the tpl to execute templates.

tpl := templatex.New(templatex.WithAddFuncMapWithOpts(func(o templatex.Option) map[string]any {
    return fstore.FuncMap(
        // fstore.WithLog(logz.AdapterKV{Log: log.Logger}),
        fstore.WithTrust(true),
        fstore.WithWorkDir("."),
        fstore.WithExecuteTemplate(o.T),
    )
}))

var buf bytes.Buffer
err := tpl.Execute(
    templatex.WithContent("{{.Count}} items are made of {{.Material}}"),
    templatex.WithData(map[string]any{
        "Count":    3,
        "Material": "wood",
    }),
    templatex.WithIO(&buf),
)
if err != nil {
    log.Fatal().Err(err).Msg("failed to execute template")
}

fmt.Println(buf.String())
// Output:
// 3 items are made of wood