Render templates from `embed.FS` - Githubissues

unrolled / render

Go package for easily rendering JSON, XML, binary data, and HTML templates responses.

MIT License

1.94k stars 146 forks source link

Render templates from `embed.FS` #88

Closed dominik-lekse closed 3 years ago

dominik-lekse commented 3 years ago

Render templates from an embedded filesystem provides as an embed.FS.

Description

Introduced in the stdlib with go version 1.16, the package embed provides access to files embedded in the running Go program
As embed is now the standard approach to embed files, render should be able to use templates from embed.FS out of the box.

Proposed changes

Add EmbedFileSystem which implements render.FileSystem and acts as an adapter to embed.FS
Requires upgrade of go version to 1.16
Avoids breaking changes in the API of the render

Example usage

// ...

//go:embed templates/*.html templates/*.tmpl
var embeddedTemplates embed.FS

// ...

r := render.New(render.Options{
    Directory: "templates",
    FileSystem: &EmbedFileSystem{
        FS: embeddedTemplates,
    },
    Extensions: []string{".html", ".tmpl"},
})
// ...

References

Package embed: https://golang.org/pkg/embed/