Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func HasChanged ¶ added in v0.3.819
func HasChanged(previous, updated GeneratorOutput) bool
HasChanged returns true if the generated file should be written to disk, and therefore, also requires a recompilation.
Types ¶
type GenerateOpt ¶ added in v0.2.428
type GenerateOpt func(g *generator) error
func WithFileName ¶ added in v0.2.501
func WithFileName(name string) GenerateOpt
WithFileName sets the filename of the templ file in template rendering error messages.
func WithSkipCodeGeneratedComment ¶ added in v0.2.742
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 ¶ added in v0.2.428
func WithTimestamp(d time.Time) GenerateOpt
WithTimestamp enables the generated date to be included in the generated code.
func WithVersion ¶ added in v0.2.428
func WithVersion(v string) GenerateOpt
WithVersion enables the version to be included in the generated code.
type GeneratorOptions ¶ added in v0.3.819
type GeneratorOptions struct {
// Version of templ.
Version string
// FileName to include in error messages if string expressions return an error.
FileName string
// SkipCodeGeneratedComment skips the code generated comment at the top of the file.
SkipCodeGeneratedComment bool
// GeneratedDate to include as a comment.
GeneratedDate string
}
type GeneratorOutput ¶ added in v0.3.819
type GeneratorOutput struct {
Options GeneratorOptions `json:"meta"`
SourceMap *parser.SourceMap `json:"sourceMap"`
Literals []string `json:"literals"`
}
func Generate ¶
func Generate(template parser.TemplateFile, w io.Writer, opts ...GenerateOpt) (op GeneratorOutput, 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.
type RangeWriter ¶
type RangeWriter struct {
Current parser.Position
Literals []string
// 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 ¶ added in v0.2.315
func (rw *RangeWriter) WriteStringLiteral(level int, s string) (r parser.Range, err error)
Source Files
Directories