generator

Documentation

Index

• func Generate(template parser.TemplateFile, w io.Writer, opts ...GenerateOpt) (sm *parser.SourceMap, literals string, err error)
• type GenerateOpt
  • func WithExtractStrings() GenerateOpt
  • func WithFileName(name string) GenerateOpt
  • func WithSkipCodeGeneratedComment() GenerateOpt
  • func WithTimestamp(d time.Time) GenerateOpt
  • func WithVersion(v string) GenerateOpt
• type RangeWriter
  • func NewRangeWriter(w io.Writer) *RangeWriter
  • func (rw *RangeWriter) Write(s string) (r parser.Range, err error)
  • func (rw *RangeWriter) WriteIndent(level int, s string) (r parser.Range, err error)
  • func (rw *RangeWriter) WriteStringLiteral(level int, s string) (r parser.Range, err error)

Functions

func Generate

func Generate(template parser.TemplateFile, w io.Writer, opts ...GenerateOpt) (sm *parser.SourceMap, literals string, err error)

Generate generates Go code from the input template file to w, and returns a map of the location of Go expressions in the template to the location of the generated Go code in the output.

Types

type GenerateOpt

type GenerateOpt func(g *generator) error

func WithExtractStrings

func WithExtractStrings() GenerateOpt

func WithFileName

func WithFileName(name string) GenerateOpt

WithFileName sets the filename of the templ file in template rendering error messages.

func WithSkipCodeGeneratedComment

func WithSkipCodeGeneratedComment() GenerateOpt

WithSkipCodeGeneratedComment skips the code generated comment at the top of the file. gopls disables edit related functionality for generated files, so the templ LSP may wish to skip generation of this comment so that gopls provides expected results.

func WithTimestamp

func WithTimestamp(d time.Time) GenerateOpt

WithTimestamp enables the generated date to be included in the generated code.

func WithVersion

func WithVersion(v string) GenerateOpt

WithVersion enables the version to be included in the generated code.

type RangeWriter

type RangeWriter struct {
	Current parser.Position
	// contains filtered or unexported fields
}

func NewRangeWriter

func NewRangeWriter(w io.Writer) *RangeWriter

func (*RangeWriter) Write

func (rw *RangeWriter) Write(s string) (r parser.Range, err error)

func (*RangeWriter) WriteIndent

func (rw *RangeWriter) WriteIndent(level int, s string) (r parser.Range, err error)

func (*RangeWriter) WriteStringLiteral

func (rw *RangeWriter) WriteStringLiteral(level int, s string) (r parser.Range, err error)