Socks is a templating library for Go. It is made to be simple and easy to use. It provides easy ways to extend and include templates, it comes with a custom bytecode expression evaluator, static evaluation and more nice-to-haves.
go get github.com/terawatthour/socks<!-- templates/index.html -->
<html>
<head>
<title>Hello from {{ server }}</title>
{! scripts !}
</head>
<body>
<h1>Hello {{ name }}</h1>
<p>The current time is {{ currentTime() }}</p>
</body>
</html>package main
import (
"fmt"
"time"
"github.com/terawatthour/socks"
)
func main() {
s := socks.NewSocks(&socks.Options{
Sanitizer: func(s string) string {
// Sanitize your output here, everything that
// goes through the {{ ... }} tag is going to be sanitized
return s
},
})
if err := s.LoadTemplates("templates/*.html"); err != nil {
panic(err)
}
if err := s.Compile(map[string]any{
"Server": "localhost",
}); err != nil {
panic(err)
}
s.AddGlobal("now", "2019-01-01")
s.AddGlobal("currentTime", func() string {
return time.Now().Format("2006-01-02 15:04:05")
})
result, err := s.ExecuteToString("templates/index.html", map[string]any{
"name": "World",
"currentTime": func() string {
return time.Now().Format("01-02-2006 15:04:05")
},
})
if err != nil {
panic(err)
}
fmt.Println(result)
}Caution
Nothing is escaped by default, so make sure to set the
Sanitizer option to a function that escapes your output.
Expression tag, the result of the expression will be printed to the template. It will be sanitized if a sanitizer function is provided.
{{ Users[0].CreatedAt.Format("2006-01-02") }}Raw tag, the content of this tag will be printed to the template without any modification.
{! client.scripts !}Preprocessor tags, the result of the expression will be printed to the template.
@extend("base.html") <!-- extends the base.html template -->@template("header.html") <!-- includes the header.html template -->
@define("content")
<!-- defines a block named content,
if omitted – template will fallback to default slot value
-->
<h1>Hello World</h1>
@enddefine
@endtemplateComment tag, the content of this tag will be ignored.
{# This is a comment #}
<!-- this is an HTML comment, but it won't be removed -->Execution tag, used for executing statements like for or if at runtime.
@for(user, i in Users)
<p>{{ i }}: {{ user.Name }}</p>
@endfor@if(len(Users) > 0)
<p>{{ Users[0].Name }}</p>
@endif- Runtime error handling
- Static type checking
- Inline functions like
map,filter,reduce, etc. - Constant folding
- Add more tests