render

Documentation

Overview

Package render generates Go source files from an IR document using embedded templates.

Index

• func RenderTemplate(tmplName, tmplContent string, doc *ir.Document) ([]byte, error)
• type File
  • func Files(doc *ir.Document, g config.Generate) ([]File, error)
  • func FilesFromFS(fsys fs.FS, doc *ir.Document, g config.Generate) ([]File, error)

Functions

func RenderTemplate

func RenderTemplate(tmplName, tmplContent string, doc *ir.Document) ([]byte, error)

RenderTemplate executes a template string against the IR document and post-processes the result with goimports and gofumpt.

Types

type File

type File struct {
	Name    string
	Content []byte
}

File represents a single rendered output file.

func Files

func Files(doc *ir.Document, g config.Generate) ([]File, error)

Files renders all embedded templates against the IR document.

func FilesFromFS

func FilesFromFS(fsys fs.FS, doc *ir.Document, g config.Generate) ([]File, error)

FilesFromFS renders all *.tmpl files found in fsys against the IR document. The output file name is the template name minus the ".tmpl" suffix.