Simplifies work with template conversion. Just a wrapper for html/template and text/template. Works with HTML and TXT (any) files directly through the io/fs (to access files after compilation, it is recommended to use embed from standart library).
go get github.com/tikhomirovv/go-template-filesPlace the *.html and *.txt template files in the same directory. File names of the same template (except extensions) must match. To get a template, you must specify the path to the directory and the name of the files relative to the selected directory with templates.
Additionally, we can specify in the configuration the path to the common template files that will be available for reuse by file name. It's easier to understand with an example.
Consider an example. Let's say there is a templates directory at the root of the project that contains a welcome email template. There is also a directory that contains common templates:
.
|-- templates
| |-- common
| | |-- header.html
| | |-- footer.html
| | |-- contacts.txt
| |-- greetings
| | |-- content.html
| | |-- content.txt
File templates/common/header.html:
<html>
<head><title>{{title .Title}}</title></head>
<body>File templates/common/footer.html:
</body>
</html>File templates/common/contacts.txt:
Email: {{ .ContactEmail }}File templates/greetings/content.html:
{{template "header.html" .}}
<h1>Thanks for registration, {{.Username}}!</h1>
{{template "footer.html" .}}File templates/greetings/content.txt:
# {{title .Title}}
Thanks for registration, {{.Username}}!
{{ template "contacts.txt" .}}Using the //go:embed directive, set the templates directory to search for templates. To get the greetings template, we will use the name templates/greetings/content. By default, the configuration states that a file with *.html extenstion is required, but *.txt is not required.
import (
ts "github.com/tikhomirovv/go-template-files"
)
//go:embed templates
var templatesDir embed.FS
func main() {
fsys := fs.FS(templatesDir)
// create default configuration
cfg := ts.NewConfiguration(&fsys)
// set path to common templates
cfg.SetCommonTemplatesPath("templates/common")
tmpls := ts.NewTemplates(*cfg)
// set funcMap & data variables
funcMap := ts.FuncMap{"title": strings.Title}
vars := map[string]interface{}{"Title": "greetings!", "Username": "Valerii", "ContactEmail": "[email protected]"}
// get template by path to template files
tmpl := ts.Must(tmpls.Get("templates/greetings/content")).Funcs(funcMap)
// apply a parsed template and write the output to wr
var html, text bytes.Buffer
if err := tmpl.Execute(&html, &text, vars); err != nil {
panic(err)
}
fmt.Println(html.String())
fmt.Println(text.String())
}Output:
<html>
<head><title>Greetings!</title></head>
<body>
<h1>Hello, Valerii!</h1>
</body>
</html># Greetings!
Hello, Valerii!
Email: [email protected]There are some configuration options available. For each of the html and txt formats, you can specify:
FormatOptions.FileExtension - what file extension to look for
FormatOptions.IsReguired - whether an error will be thrown if a file with the specified extension is not found
For example, we want to process only the template markdown file:
File templates/greetings/content.md:
# {{title .Title}}
Hello, *{{.Username}}*!Set configuration:
fsys := fs.FS(templatesDir)
cfg := ts.NewConfiguration(&fsys)
cfg.Formats[ts.Html].IsRequired = false
cfg.Formats[ts.Text].IsRequired = true
cfg.Formats[ts.Text].FileExtension = "md"
// or
cfg := &ts.Configuration{
TemplatesFS: &fsys,
Formats: ts.Formats{
ts.Text: &ts.FormatOptions{
FileExtension: "md",
IsRequired: true,
},
},
}- Parse template files and generate output
- Use FuncMap for template engine
- Parse and reusing nested template files
- Automaticly parse and inject inline CSS
- Minimize output