encode version used to generate template (#34)

a-h · Jan 19, 2022 · af7fe71 · af7fe71
1 parent 220fc80
commit af7fe71
Show file tree

Hide file tree

Showing 20 changed files with 41 additions and 20 deletions.
diff --git a/example/posts_templ.go b/example/posts_templ.go
diff --git a/generator/generator.go b/generator/generator.go
@@ -7,6 +7,7 @@ import (
 	"html"
 	"io"
 	"reflect"
+	"runtime/debug"
 	"strings"
 
 	"github.com/a-h/templ"
@@ -90,8 +91,28 @@ func (g *generator) generate() (err error) {
 	return err
 }
 
+// Binary builds set this version string. goreleaser sets the value using Go build ldflags.
+var version string
+
+// Source builds use this value. When installed using `go install github.com/a-h/templ/cmd/templ@latest` the `version` variable is empty, but
+// the debug.ReadBuildInfo return value provides the package version number installed by `go install`
+func goInstallVersion() string {
+	info, ok := debug.ReadBuildInfo()
+	if !ok {
+		return "unknown"
+	}
+	return info.Main.Version
+}
+
+func getVersion() string {
+	if version != "" {
+		return version
+	}
+	return goInstallVersion()
+}
+
 func (g *generator) writeCodeGeneratedComment() error {
-	_, err := g.w.Write("// Code generated by templ DO NOT EDIT.\n\n")
+	_, err := g.w.Write(fmt.Sprintf("// Code generated by templ@%s DO NOT EDIT.\n\n", getVersion()))
 	return err
 }
 

diff --git a/generator/test-a-href/template_templ.go b/generator/test-a-href/template_templ.go
diff --git a/generator/test-attribute-escaping/template_templ.go b/generator/test-attribute-escaping/template_templ.go
diff --git a/generator/test-call/template_templ.go b/generator/test-call/template_templ.go
diff --git a/generator/test-css-expression/template_templ.go b/generator/test-css-expression/template_templ.go
diff --git a/generator/test-css-usage/template_templ.go b/generator/test-css-usage/template_templ.go
diff --git a/generator/test-doctype/template_templ.go b/generator/test-doctype/template_templ.go
diff --git a/generator/test-for/template_templ.go b/generator/test-for/template_templ.go
diff --git a/generator/test-html/template_templ.go b/generator/test-html/template_templ.go
diff --git a/generator/test-if/template_templ.go b/generator/test-if/template_templ.go
diff --git a/generator/test-ifelse/template_templ.go b/generator/test-ifelse/template_templ.go
diff --git a/generator/test-script-usage/template_templ.go b/generator/test-script-usage/template_templ.go
diff --git a/generator/test-string/template_templ.go b/generator/test-string/template_templ.go
diff --git a/generator/test-switch/template_templ.go b/generator/test-switch/template_templ.go
diff --git a/generator/test-switchdefault/template_templ.go b/generator/test-switchdefault/template_templ.go
diff --git a/generator/test-text/template_templ.go b/generator/test-text/template_templ.go
diff --git a/generator/test-void/template_templ.go b/generator/test-void/template_templ.go
diff --git a/storybook/example/templates_templ.go b/storybook/example/templates_templ.go
diff --git a/turbo/stream_templ.go b/turbo/stream_templ.go