+
+ @templ.JSFuncCall(
+ "barChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ )
+
+}
+
+templ barLineChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) {
+
+
+
+ @templ.JSFuncCall(
+ "barLineChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ )
+
+}
+
+templ pieChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) {
+
+
+ @templ.JSFuncCall(
+ "pieChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ )
+
+}
+
+templ doughnutChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) {
+
+
+ @templ.JSFuncCall(
+ "doughnutChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ )
+
+}
+
+templ polarChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) {
+
+
+ @templ.JSFuncCall(
+ "polarChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ )
+
+}
diff --git a/components/charts_templ.go b/components/charts_templ.go
new file mode 100644
index 0000000..af54ab3
--- /dev/null
+++ b/components/charts_templ.go
@@ -0,0 +1,306 @@
+// Code generated by templ - DO NOT EDIT.
+
+// templ: version: v0.3.833
+package components
+
+//lint:file-ignore SA4006 This context is only used if a nested component is present.
+
+import "github.com/a-h/templ"
+import templruntime "github.com/a-h/templ/runtime"
+
+func barChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var1 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var1 == nil {
+ templ_7745c5c3_Var1 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 1, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templ.JSFuncCall(
+ "barChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 3, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func barLineChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var3 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var3 == nil {
+ templ_7745c5c3_Var3 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 4, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templ.JSFuncCall(
+ "barLineChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 6, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func pieChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var5 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var5 == nil {
+ templ_7745c5c3_Var5 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 7, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templ.JSFuncCall(
+ "pieChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 9, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func doughnutChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var7 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var7 == nil {
+ templ_7745c5c3_Var7 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 10, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templ.JSFuncCall(
+ "doughnutChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 12, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func polarChart(id string, data []float64, labels []string, tooltip string, title string, scaleLabelX string, scaleLabelY string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var9 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var9 == nil {
+ templ_7745c5c3_Var9 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 13, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templ.JSFuncCall(
+ "polarChart",
+ id,
+ data,
+ labels,
+ tooltip,
+ title,
+ scaleLabelX,
+ scaleLabelY,
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 15, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+var _ = templruntime.GeneratedTemplate
diff --git a/components/components.templ b/components/components.templ
new file mode 100644
index 0000000..cbfac29
--- /dev/null
+++ b/components/components.templ
@@ -0,0 +1,240 @@
+package components
+
+import (
+ "time"
+ "strconv"
+ "math/rand/v2"
+)
+
+func getCurrentTime() string {
+ loc, err := time.LoadLocation("Europe/Berlin")
+
+ if err != nil {
+
+ }
+
+ t := time.Now().In(loc)
+ layout := "02.01.2006 15:04"
+ return t.Format(layout)
+}
+
+func genRandomData(count int) []float64 {
+ data := make([]float64, count)
+ for i := 0; i < count; i++ {
+ data[i] = rand.NormFloat64() * 30 + 50
+ }
+ return data
+}
+
+templ base(title string) {
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ { children... }
+
+
+
+}
+
+templ footer() {
+
+}
+
+templ navbar() {
+
+}
+
+templ selectList(labels []string) {
+
+
+
+}
+
+templ usercard(username string) {
+
+ 
+
+}
+
+templ NotFound() {
+ @base("Error") {
+
+ { username }
+
+
+
+
+ Insitution:
+
+
+
+ IFN @ TU BS
+
+
+ Mail:
+
+
+
+ p.keier@beyerstedt-it.de
+
+
+ Created:
+
+
+ { getCurrentTime() }
+
+
+ }
+}
+
+templ Test() {
+ @base("Test") {
+ 404 - Not Found
+
+ 
+ 
+
+
+
+ This Page Didn't Pass the Exam
+It tried, but it didn’t make the cut.
+Better check the Dashboard instead!
+
+
+ }
+}
+
+templ Dashboard(username string) {
+ @base("Dashboard") {
+
+ Test
+
+
+ @polarChart(
+ "1",
+ genRandomData(6),
+ []string{"Klasse 8a", "Klasse 5b", "Klasse 6c", "Klasse 10d", "Englisch LK 12", "Geschickte GK 11"},
+ "Points scored",
+ "Classes",
+ "Classes",
+ "",
+ )
+
+
+ Test
+
+
+ @doughnutChart(
+ "1",
+ genRandomData(6),
+ []string{"Klasse 8a", "Klasse 5b", "Klasse 6c", "Klasse 10d", "Englisch LK 12", "Geschickte GK 11"},
+ "Points scored",
+ "Classes",
+ "Classes",
+ "",
+ )
+
+
+
+ }
+}
+
+templ Login() {
+ @base("Login") {
+
+ @usercard(username)
+
+
+ @barChart(
+ "2",
+ genRandomData(6),
+ []string{"Klasse 8a", "Klasse 5b", "Klasse 6c", "Klasse 10d", "Englisch LK 12", "Geschickte GK 11"},
+ "Points scored",
+ "Classes",
+ "Classes",
+ "",
+ )
+
+
+
+ @selectList([]string{"Phil Keier", "Calvin Brandt", "Nova Eib"})
+
+
+
+ @barLineChart(
+ "1",
+ []float64{31, 15, 18, 35, 20, 20, 22, 27, 24, 30},
+ []string{"Tutorial 1", "Tutorial 2", "Extended Applications", "Numpy & MatPlotLib", "SciPy", "MonteCarlo", "Pandas & Seaborn", "Folium", "Statistical Test Methods", "Data Analysis"},
+ "Points scored",
+ "Lectures",
+ "Lectures",
+ "Points",
+ )
+
+
+ 
+
+ }
+}
diff --git a/components/components_templ.go b/components/components_templ.go
new file mode 100644
index 0000000..64e04ff
--- /dev/null
+++ b/components/components_templ.go
@@ -0,0 +1,554 @@
+// Code generated by templ - DO NOT EDIT.
+
+// templ: version: v0.3.833
+package components
+
+//lint:file-ignore SA4006 This context is only used if a nested component is present.
+
+import "github.com/a-h/templ"
+import templruntime "github.com/a-h/templ/runtime"
+
+import (
+ "math/rand/v2"
+ "strconv"
+ "time"
+)
+
+func getCurrentTime() string {
+ loc, err := time.LoadLocation("Europe/Berlin")
+
+ if err != nil {
+
+ }
+
+ t := time.Now().In(loc)
+ layout := "02.01.2006 15:04"
+ return t.Format(layout)
+}
+
+func genRandomData(count int) []float64 {
+ data := make([]float64, count)
+ for i := 0; i < count; i++ {
+ data[i] = rand.NormFloat64()*30 + 50
+ }
+ return data
+}
+
+func base(title string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var1 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var1 == nil {
+ templ_7745c5c3_Var1 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 1, "
+ Learnlytics
+ +")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templ_7745c5c3_Var1.Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 4, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func footer() templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var3 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var3 == nil {
+ templ_7745c5c3_Var3 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 5, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func navbar() templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var4 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var4 == nil {
+ templ_7745c5c3_Var4 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 6, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func selectList(labels []string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var5 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var5 == nil {
+ templ_7745c5c3_Var5 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 7, "")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ return nil
+ })
+}
+
+func usercard(username string) templ.Component {
+ return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) {
+ templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context
+ if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil {
+ return templ_7745c5c3_CtxErr
+ }
+ templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W)
+ if !templ_7745c5c3_IsBuffer {
+ defer func() {
+ templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err == nil {
+ templ_7745c5c3_Err = templ_7745c5c3_BufErr
+ }
+ }()
+ }
+ ctx = templ.InitializeContext(ctx)
+ templ_7745c5c3_Var9 := templ.GetChildren(ctx)
+ if templ_7745c5c3_Var9 == nil {
+ templ_7745c5c3_Var9 = templ.NopComponent
+ }
+ ctx = templ.ClearChildren(ctx)
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 13, "![\"Avatar\"](\"assets/img/user.jpeg\")
") + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + var templ_7745c5c3_Var10 string + templ_7745c5c3_Var10, templ_7745c5c3_Err = templ.JoinStringErrs(username) + if templ_7745c5c3_Err != nil { + return templ.Error{Err: templ_7745c5c3_Err, FileName: `components/components.templ`, Line: 113, Col: 22} + } + _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString(templ.EscapeString(templ_7745c5c3_Var10)) + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 14, "
Insitution:
IFN @ TU BS
Mail:
p.keier@beyerstedt-it.de
Created:
") + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + var templ_7745c5c3_Var11 string + templ_7745c5c3_Var11, templ_7745c5c3_Err = templ.JoinStringErrs(getCurrentTime()) + if templ_7745c5c3_Err != nil { + return templ.Error{Err: templ_7745c5c3_Err, FileName: `components/components.templ`, Line: 133, Col: 37} + } + _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString(templ.EscapeString(templ_7745c5c3_Var11)) + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 15, "
404 - Not Found
![\"Dead](\"assets/img/smiley-x.svg\")
![\"Failed](\"assets/img/failed-exam.svg\")
This Page Didn't Pass the Exam
It tried, but it didn’t make the cut.
Better check the Dashboard instead!
Test
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = polarChart(
+ "1",
+ genRandomData(6),
+ []string{"Klasse 8a", "Klasse 5b", "Klasse 6c", "Klasse 10d", "Englisch LK 12", "Geschickte GK 11"},
+ "Points scored",
+ "Classes",
+ "Classes",
+ "",
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 18, "
Test
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = doughnutChart(
+ "1",
+ genRandomData(6),
+ []string{"Klasse 8a", "Klasse 5b", "Klasse 6c", "Klasse 10d", "Englisch LK 12", "Geschickte GK 11"},
+ "Points scored",
+ "Classes",
+ "Classes",
+ "",
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 19, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = usercard(username).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 21, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = barChart(
+ "2",
+ genRandomData(6),
+ []string{"Klasse 8a", "Klasse 5b", "Klasse 6c", "Klasse 10d", "Englisch LK 12", "Geschickte GK 11"},
+ "Points scored",
+ "Classes",
+ "Classes",
+ "",
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 22, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = selectList([]string{"Phil Keier", "Calvin Brandt", "Nova Eib"}).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 23, "
")
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = barLineChart(
+ "1",
+ []float64{31, 15, 18, 35, 20, 20, 22, 27, 24, 30},
+ []string{"Tutorial 1", "Tutorial 2", "Extended Applications", "Numpy & MatPlotLib", "SciPy", "MonteCarlo", "Pandas & Seaborn", "Folium", "Statistical Test Methods", "Data Analysis"},
+ "Points scored",
+ "Lectures",
+ "Lectures",
+ "Points",
+ ).Render(ctx, templ_7745c5c3_Buffer)
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 24, "
![\"Learnlytics](\"assets/img/learnlytics.svg\")
Learnlytics
tag
`, + }, + }, + { + name: "comments can contain tags", + input: ``, + expected: HTMLComment{ + Contents: ` hello world
`,
+ },
+ },
+ }
+ for _, tt := range tests {
+ tt := tt
+ t.Run(tt.name, func(t *testing.T) {
+ input := parse.NewInput(tt.input)
+ result, ok, err := htmlComment.Parse(input)
+ if err != nil {
+ t.Fatalf("parser error: %v", err)
+ }
+ if !ok {
+ t.Fatalf("failed to parse at %d", input.Index())
+ }
+ if diff := cmp.Diff(tt.expected, result); diff != "" {
+ t.Errorf(diff)
+ }
+ })
+ }
+}
+```
+
+Alongside each success test, is a similar test to check that invalid syntax is detected.
+
+```go
+func TestHTMLCommentParserErrors(t *testing.T) {
+ var tests = []struct {
+ name string
+ input string
+ expected error
+ }{
+ {
+ name: "unclosed HTML comment",
+ input: `' not found",
+ parse.Position{
+ Index: 26,
+ Line: 0,
+ Col: 26,
+ }),
+ },
+ {
+ name: "comment in comment",
+ input: ` -->`,
+ expected: parse.Error("comment contains invalid sequence '--'", parse.Position{
+ Index: 8,
+ Line: 0,
+ Col: 8,
+ }),
+ },
+ }
+ for _, tt := range tests {
+ tt := tt
+ t.Run(tt.name, func(t *testing.T) {
+ input := parse.NewInput(tt.input)
+ _, _, err := htmlComment.Parse(input)
+ if diff := cmp.Diff(tt.expected, err); diff != "" {
+ t.Error(diff)
+ }
+ })
+ }
+}
+```
+
+### Generator
+
+The generator takes the object model and writes out Go code that produces the expected output. Any changes to Go code output by templ are made in this area.
+
+Testing of the generator is carried out by creating a templ file, and a matching expected output file.
+
+For example, `./generator/test-a-href` contains a templ file of:
+
+```templ
+package testahref
+
+templ render() {
+ Ignored
+ Sanitized
+ Unsanitized
+}
+```
+
+It also contains an expected output file.
+
+```html
+Ignored
+Sanitized
+Unsanitized
+```
+
+These tests contribute towards the code coverage metrics by building an instrumented test CLI program. See the `test-cover` task in the `README.md` file.
+
+### CLI
+
+The command line interface for templ is used to generate Go code from templ files, format templ files, and run the LSP.
+
+The code for this is at `./cmd/templ`.
+
+Testing of the templ command line is done with unit tests to check the argument parsing.
+
+The `templ generate` command is tested by generating templ files in the project, and testing that the expected output HTML is present.
+
+### Runtime
+
+The runtime is used by generated code, and by template authors, to serve template content over HTTP, and to carry out various operations.
+
+It is in the root directory of the project at `./runtime.go`. The runtime is unit tested, as well as being tested as part of the `generate` tests.
+
+### LSP
+
+The LSP is structured within the command line interface, and proxies commands through to the `gopls` LSP.
+
+### Docs
+
+The docs are a Docusaurus project at `./docs`.
+
+## Coding
+
+### Build tasks
+
+templ uses the `xc` task runner - https://github.com/joerdav/xc
+
+If you run `xc` you can get see a list of the development tasks that can be run, or you can read the `README.md` file and see the `Tasks` section.
+
+The most useful tasks for local development are:
+
+* `install-snapshot` - this builds the templ CLI and installs it into `~/bin`. Ensure that this is in your path.
+* `test` - this regenerates all templates, and runs the unit tests.
+* `fmt` - run the `gofmt` tool to format all Go code.
+* `lint` - run the same linting as run in the CI process.
+* `docs-run` - run the Docusaurus documentation site.
+
+### Commit messages
+
+The project using https://www.conventionalcommits.org/en/v1.0.0/
+
+Examples:
+
+* `feat: support Go comments in templates, fixes #234"`
+
+### Coding style
+
+* Reduce nesting - i.e. prefer early returns over an `else` block, as per https://danp.net/posts/reducing-go-nesting/ or https://go.dev/doc/effective_go#if
+* Use line breaks to separate "paragraphs" of code - don't use line breaks in between lines, or at the start/end of functions etc.
+* Use the `fmt` and `lint` build tasks to format and lint your code before submitting a PR.
+
diff --git a/templ/LICENSE b/templ/LICENSE
new file mode 100644
index 0000000..15e6fb8
--- /dev/null
+++ b/templ/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 Adrian Hesketh
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/templ/README.md b/templ/README.md
new file mode 100644
index 0000000..60d2f67
--- /dev/null
+++ b/templ/README.md
@@ -0,0 +1,184 @@
+
+
+## An HTML templating language for Go that has great developer tooling.
+
+
+
+
+## Documentation
+
+See user documentation at https://templ.guide
+
+
+
+
+
+
+
+
+ {{.Name}}
+
+
+
+ email:{{.Email}}
+ +
+
+`)) + +func BenchmarkGoTemplateRender(b *testing.B) { + w := new(strings.Builder) + person := Person{ + Name: "Luiz Bonfa", + Email: "luiz@exapmle.com", + } + b.ReportAllocs() + for i := 0; i < b.N; i++ { + err := goTemplate.Execute(w, person) + if err != nil { + b.Errorf("failed to render: %v", err) + } + w.Reset() + } +} + +const html = `
Luiz Bonfa
email:luiz@example.com
` + +func BenchmarkIOWriteString(b *testing.B) { + b.ReportAllocs() + w := new(strings.Builder) + for i := 0; i < b.N; i++ { + _, err := io.WriteString(w, html) + if err != nil { + b.Errorf("failed to render: %v", err) + } + w.Reset() + } +} diff --git a/templ/benchmarks/templ/template.templ b/templ/benchmarks/templ/template.templ new file mode 100644 index 0000000..54ac5f2 --- /dev/null +++ b/templ/benchmarks/templ/template.templ @@ -0,0 +1,13 @@ +package testhtml + +templ Render(p Person) { +
+
+ { p.Name }
+` }>
+
+ email:{ p.Email }
+ +
+
+} diff --git a/templ/benchmarks/templ/template_templ.go b/templ/benchmarks/templ/template_templ.go new file mode 100644 index 0000000..2638d39 --- /dev/null +++ b/templ/benchmarks/templ/template_templ.go @@ -0,0 +1,118 @@ +// Code generated by templ - DO NOT EDIT. + +// templ: version: v0.3.833 +package testhtml + +//lint:file-ignore SA4006 This context is only used if a nested component is present. + +import "github.com/a-h/templ" +import templruntime "github.com/a-h/templ/runtime" + +func Render(p Person) templ.Component { + return templruntime.GeneratedTemplate(func(templ_7745c5c3_Input templruntime.GeneratedComponentInput) (templ_7745c5c3_Err error) { + templ_7745c5c3_W, ctx := templ_7745c5c3_Input.Writer, templ_7745c5c3_Input.Context + if templ_7745c5c3_CtxErr := ctx.Err(); templ_7745c5c3_CtxErr != nil { + return templ_7745c5c3_CtxErr + } + templ_7745c5c3_Buffer, templ_7745c5c3_IsBuffer := templruntime.GetBuffer(templ_7745c5c3_W) + if !templ_7745c5c3_IsBuffer { + defer func() { + templ_7745c5c3_BufErr := templruntime.ReleaseBuffer(templ_7745c5c3_Buffer) + if templ_7745c5c3_Err == nil { + templ_7745c5c3_Err = templ_7745c5c3_BufErr + } + }() + } + ctx = templ.InitializeContext(ctx) + templ_7745c5c3_Var1 := templ.GetChildren(ctx) + if templ_7745c5c3_Var1 == nil { + templ_7745c5c3_Var1 = templ.NopComponent + } + ctx = templ.ClearChildren(ctx) + templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 1, "
") + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + var templ_7745c5c3_Var2 string + templ_7745c5c3_Var2, templ_7745c5c3_Err = templ.JoinStringErrs(p.Name) + if templ_7745c5c3_Err != nil { + return templ.Error{Err: templ_7745c5c3_Err, FileName: `templ/benchmarks/templ/template.templ`, Line: 5, Col: 14} + } + _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString(templ.EscapeString(templ_7745c5c3_Var2)) + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 2, "
`)
+ if templ_7745c5c3_Err != nil {
+ return templ.Error{Err: templ_7745c5c3_Err, FileName: `templ/benchmarks/templ/template.templ`, Line: 6, Col: 104}
+ }
+ _, templ_7745c5c3_Err = templ_7745c5c3_Buffer.WriteString(templ.EscapeString(templ_7745c5c3_Var3))
+ if templ_7745c5c3_Err != nil {
+ return templ_7745c5c3_Err
+ }
+ templ_7745c5c3_Err = templruntime.WriteString(templ_7745c5c3_Buffer, 3, "\">
") + if templ_7745c5c3_Err != nil { + return templ_7745c5c3_Err + } + return nil + }) +} + +var _ = templruntime.GeneratedTemplate diff --git a/templ/cfg/cfg.go b/templ/cfg/cfg.go new file mode 100644 index 0000000..0ea880d --- /dev/null +++ b/templ/cfg/cfg.go @@ -0,0 +1,20 @@ +// This package is inspired by the GOEXPERIMENT approach of allowing feature flags for experimenting with breaking changes. +package cfg + +import ( + "os" + "strings" +) + +type Flags struct{} + +var Experiment = parse() + +func parse() *Flags { + m := map[string]bool{} + for _, f := range strings.Split(os.Getenv("TEMPL_EXPERIMENT"), ",") { + m[strings.ToLower(f)] = true + } + + return &Flags{} +} diff --git a/templ/cmd/templ/fmtcmd/main.go b/templ/cmd/templ/fmtcmd/main.go new file mode 100644 index 0000000..2f2b7fc --- /dev/null +++ b/templ/cmd/templ/fmtcmd/main.go @@ -0,0 +1,166 @@ +package fmtcmd + +import ( + "bytes" + "fmt" + "io" + "log/slog" + "os" + "runtime" + "sync" + "time" + + "github.com/a-h/templ/cmd/templ/imports" + "github.com/a-h/templ/cmd/templ/processor" + parser "github.com/a-h/templ/parser/v2" + "github.com/natefinch/atomic" +) + +type Arguments struct { + FailIfChanged bool + ToStdout bool + StdinFilepath string + Files []string + WorkerCount int +} + +func Run(log *slog.Logger, stdin io.Reader, stdout io.Writer, args Arguments) (err error) { + // If no files are provided, read from stdin and write to stdout. + if len(args.Files) == 0 { + out, _ := format(writeToWriter(stdout), readFromReader(stdin, args.StdinFilepath), true) + return out + } + process := func(fileName string) (error, bool) { + read := readFromFile(fileName) + write := writeToFile + if args.ToStdout { + write = writeToWriter(stdout) + } + writeIfUnchanged := args.ToStdout + return format(write, read, writeIfUnchanged) + } + dir := args.Files[0] + return NewFormatter(log, dir, process, args.WorkerCount, args.FailIfChanged).Run() +} + +type Formatter struct { + Log *slog.Logger + Dir string + Process func(fileName string) (error, bool) + WorkerCount int + FailIfChange bool +} + +func NewFormatter(log *slog.Logger, dir string, process func(fileName string) (error, bool), workerCount int, failIfChange bool) *Formatter { + f := &Formatter{ + Log: log, + Dir: dir, + Process: process, + WorkerCount: workerCount, + FailIfChange: failIfChange, + } + if f.WorkerCount == 0 { + f.WorkerCount = runtime.NumCPU() + } + return f +} + +func (f *Formatter) Run() (err error) { + changesMade := 0 + start := time.Now() + results := make(chan processor.Result) + f.Log.Debug("Walking directory", slog.String("path", f.Dir)) + go processor.Process(f.Dir, f.Process, f.WorkerCount, results) + var successCount, errorCount int + for r := range results { + if r.ChangesMade { + changesMade += 1 + } + if r.Error != nil { + f.Log.Error(r.FileName, slog.Any("error", r.Error)) + errorCount++ + continue + } + f.Log.Debug(r.FileName, slog.Duration("duration", r.Duration)) + successCount++ + } + + if f.FailIfChange && changesMade > 0 { + f.Log.Error("Templates were valid but not properly formatted", slog.Int("count", successCount+errorCount), slog.Int("changed", changesMade), slog.Int("errors", errorCount), slog.Duration("duration", time.Since(start))) + return fmt.Errorf("templates were not formatted properly") + } + + f.Log.Info("Format Complete", slog.Int("count", successCount+errorCount), slog.Int("errors", errorCount), slog.Int("changed", changesMade), slog.Duration("duration", time.Since(start))) + + if errorCount > 0 { + return fmt.Errorf("formatting failed") + } + + return +} + +type reader func() (fileName, src string, err error) + +func readFromReader(r io.Reader, stdinFilepath string) func() (fileName, src string, err error) { + return func() (fileName, src string, err error) { + b, err := io.ReadAll(r) + if err != nil { + return "", "", fmt.Errorf("failed to read stdin: %w", err) + } + return stdinFilepath, string(b), nil + } +} + +func readFromFile(name string) reader { + return func() (fileName, src string, err error) { + b, err := os.ReadFile(name) + if err != nil { + return "", "", fmt.Errorf("failed to read file %q: %w", fileName, err) + } + return name, string(b), nil + } +} + +type writer func(fileName, tgt string) error + +var mu sync.Mutex + +func writeToWriter(w io.Writer) func(fileName, tgt string) error { + return func(fileName, tgt string) error { + mu.Lock() + defer mu.Unlock() + _, err := w.Write([]byte(tgt)) + return err + } +} + +func writeToFile(fileName, tgt string) error { + return atomic.WriteFile(fileName, bytes.NewBufferString(tgt)) +} + +func format(write writer, read reader, writeIfUnchanged bool) (err error, fileChanged bool) { + fileName, src, err := read() + if err != nil { + return err, false + } + t, err := parser.ParseString(src) + if err != nil { + return err, false + } + t.Filepath = fileName + t, err = imports.Process(t) + if err != nil { + return err, false + } + w := new(bytes.Buffer) + if err = t.Write(w); err != nil { + return fmt.Errorf("formatting error: %w", err), false + } + + fileChanged = (src != w.String()) + + if !writeIfUnchanged && !fileChanged { + return nil, fileChanged + } + return write(fileName, w.String()), fileChanged +} diff --git a/templ/cmd/templ/fmtcmd/main_test.go b/templ/cmd/templ/fmtcmd/main_test.go new file mode 100644 index 0000000..9a70f36 --- /dev/null +++ b/templ/cmd/templ/fmtcmd/main_test.go @@ -0,0 +1,163 @@ +package fmtcmd + +import ( + _ "embed" + "fmt" + "io" + "log/slog" + "os" + "path/filepath" + "strings" + "testing" + + "github.com/google/go-cmp/cmp" + "golang.org/x/tools/txtar" +) + +//go:embed testdata.txtar +var testDataTxTar []byte + +type testProject struct { + dir string + cleanup func() + testFiles map[string]testFile +} + +type testFile struct { + name string + input, expected string +} + +func setupProjectDir() (tp testProject, err error) { + tp.dir, err = os.MkdirTemp("", "fmtcmd_test_*") + if err != nil { + return tp, fmt.Errorf("failed to make test dir: %w", err) + } + tp.testFiles = make(map[string]testFile) + testData := txtar.Parse(testDataTxTar) + for i := 0; i < len(testData.Files); i += 2 { + file := testData.Files[i] + err = os.WriteFile(filepath.Join(tp.dir, file.Name), file.Data, 0660) + if err != nil { + return tp, fmt.Errorf("failed to write file: %w", err) + } + tp.testFiles[file.Name] = testFile{ + name: filepath.Join(tp.dir, file.Name), + input: string(file.Data), + expected: string(testData.Files[i+1].Data), + } + } + tp.cleanup = func() { + os.RemoveAll(tp.dir) + } + return tp, nil +} + +func TestFormat(t *testing.T) { + log := slog.New(slog.NewJSONHandler(io.Discard, nil)) + t.Run("can format a single file from stdin to stdout", func(t *testing.T) { + tp, err := setupProjectDir() + if err != nil { + t.Fatalf("failed to setup project dir: %v", err) + } + defer tp.cleanup() + stdin := strings.NewReader(tp.testFiles["a.templ"].input) + stdout := new(strings.Builder) + if err = Run(log, stdin, stdout, Arguments{ + ToStdout: true, + }); err != nil { + t.Fatalf("failed to run format command: %v", err) + } + if diff := cmp.Diff(tp.testFiles["a.templ"].expected, stdout.String()); diff != "" { + t.Error(diff) + } + }) + t.Run("can process a single file to stdout", func(t *testing.T) { + tp, err := setupProjectDir() + if err != nil { + t.Fatalf("failed to setup project dir: %v", err) + } + defer tp.cleanup() + stdout := new(strings.Builder) + if err = Run(log, nil, stdout, Arguments{ + ToStdout: true, + Files: []string{ + tp.testFiles["a.templ"].name, + }, + FailIfChanged: false, + }); err != nil { + t.Fatalf("failed to run format command: %v", err) + } + if diff := cmp.Diff(tp.testFiles["a.templ"].expected, stdout.String()); diff != "" { + t.Error(diff) + } + }) + t.Run("can process a single file in place", func(t *testing.T) { + tp, err := setupProjectDir() + if err != nil { + t.Fatalf("failed to setup project dir: %v", err) + } + defer tp.cleanup() + if err = Run(log, nil, nil, Arguments{ + Files: []string{ + tp.testFiles["a.templ"].name, + }, + FailIfChanged: false, + }); err != nil { + t.Fatalf("failed to run format command: %v", err) + } + data, err := os.ReadFile(tp.testFiles["a.templ"].name) + if err != nil { + t.Fatalf("failed to read file: %v", err) + } + if diff := cmp.Diff(tp.testFiles["a.templ"].expected, string(data)); diff != "" { + t.Error(diff) + } + }) + + t.Run("fails when fail flag used and change occurs", func(t *testing.T) { + tp, err := setupProjectDir() + if err != nil { + t.Fatalf("failed to setup project dir: %v", err) + } + defer tp.cleanup() + if err = Run(log, nil, nil, Arguments{ + Files: []string{ + tp.testFiles["a.templ"].name, + }, + FailIfChanged: true, + }); err == nil { + t.Fatal("command should have exited with an error and did not") + } + data, err := os.ReadFile(tp.testFiles["a.templ"].name) + if err != nil { + t.Fatalf("failed to read file: %v", err) + } + if diff := cmp.Diff(tp.testFiles["a.templ"].expected, string(data)); diff != "" { + t.Error(diff) + } + }) + + t.Run("passes when fail flag used and no change occurs", func(t *testing.T) { + tp, err := setupProjectDir() + if err != nil { + t.Fatalf("failed to setup project dir: %v", err) + } + defer tp.cleanup() + if err = Run(log, nil, nil, Arguments{ + Files: []string{ + tp.testFiles["c.templ"].name, + }, + FailIfChanged: true, + }); err != nil { + t.Fatalf("failed to run format command: %v", err) + } + data, err := os.ReadFile(tp.testFiles["c.templ"].name) + if err != nil { + t.Fatalf("failed to read file: %v", err) + } + if diff := cmp.Diff(tp.testFiles["c.templ"].expected, string(data)); diff != "" { + t.Error(diff) + } + }) +} diff --git a/templ/cmd/templ/fmtcmd/testdata.txtar b/templ/cmd/templ/fmtcmd/testdata.txtar new file mode 100644 index 0000000..8041fce --- /dev/null +++ b/templ/cmd/templ/fmtcmd/testdata.txtar @@ -0,0 +1,54 @@ +-- a.templ -- +package test + +templ a() { +
A +
+
+}
+-- b.templ --
+package test
+
+templ b() {
+ + A +
+B +
+
+}
+-- c.templ --
+package test
+
+templ c() {
+ + B +
+
+
+}
+-- c.templ --
+package test
+
+templ c() {
+ + C +
+
+
+}
diff --git a/templ/cmd/templ/generatecmd/cmd.go b/templ/cmd/templ/generatecmd/cmd.go
new file mode 100644
index 0000000..169cc06
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/cmd.go
@@ -0,0 +1,403 @@
+package generatecmd
+
+import (
+ "context"
+ "errors"
+ "fmt"
+ "log/slog"
+ "net/http"
+ "net/url"
+ "os"
+ "path"
+ "path/filepath"
+ "regexp"
+ "runtime"
+ "strings"
+ "sync"
+ "sync/atomic"
+ "time"
+
+ "github.com/a-h/templ"
+ "github.com/a-h/templ/cmd/templ/generatecmd/modcheck"
+ "github.com/a-h/templ/cmd/templ/generatecmd/proxy"
+ "github.com/a-h/templ/cmd/templ/generatecmd/run"
+ "github.com/a-h/templ/cmd/templ/generatecmd/watcher"
+ "github.com/a-h/templ/generator"
+ "github.com/cenkalti/backoff/v4"
+ "github.com/cli/browser"
+ "github.com/fsnotify/fsnotify"
+)
+
+const defaultWatchPattern = `(.+\.go$)|(.+\.templ$)|(.+_templ\.txt$)`
+
+func NewGenerate(log *slog.Logger, args Arguments) (g *Generate, err error) {
+ g = &Generate{
+ Log: log,
+ Args: &args,
+ }
+ if g.Args.WorkerCount == 0 {
+ g.Args.WorkerCount = runtime.NumCPU()
+ }
+ if g.Args.WatchPattern == "" {
+ g.Args.WatchPattern = defaultWatchPattern
+ }
+ g.WatchPattern, err = regexp.Compile(g.Args.WatchPattern)
+ if err != nil {
+ return nil, fmt.Errorf("failed to compile watch pattern %q: %w", g.Args.WatchPattern, err)
+ }
+ return g, nil
+}
+
+type Generate struct {
+ Log *slog.Logger
+ Args *Arguments
+ WatchPattern *regexp.Regexp
+}
+
+type GenerationEvent struct {
+ Event fsnotify.Event
+ Updated bool
+ GoUpdated bool
+ TextUpdated bool
+}
+
+func (cmd Generate) Run(ctx context.Context) (err error) {
+ if cmd.Args.NotifyProxy {
+ return proxy.NotifyProxy(cmd.Args.ProxyBind, cmd.Args.ProxyPort)
+ }
+ if cmd.Args.Watch && cmd.Args.FileName != "" {
+ return fmt.Errorf("cannot watch a single file, remove the -f or -watch flag")
+ }
+ writingToWriter := cmd.Args.FileWriter != nil
+ if cmd.Args.FileName == "" && writingToWriter {
+ return fmt.Errorf("only a single file can be output to stdout, add the -f flag to specify the file to generate code for")
+ }
+ // Default to writing to files.
+ if cmd.Args.FileWriter == nil {
+ cmd.Args.FileWriter = FileWriter
+ }
+ if cmd.Args.PPROFPort > 0 {
+ go func() {
+ _ = http.ListenAndServe(fmt.Sprintf("localhost:%d", cmd.Args.PPROFPort), nil)
+ }()
+ }
+
+ // Use absolute path.
+ if !path.IsAbs(cmd.Args.Path) {
+ cmd.Args.Path, err = filepath.Abs(cmd.Args.Path)
+ if err != nil {
+ return fmt.Errorf("failed to get absolute path: %w", err)
+ }
+ }
+
+ // Configure generator.
+ var opts []generator.GenerateOpt
+ if cmd.Args.IncludeVersion {
+ opts = append(opts, generator.WithVersion(templ.Version()))
+ }
+ if cmd.Args.IncludeTimestamp {
+ opts = append(opts, generator.WithTimestamp(time.Now()))
+ }
+
+ // Check the version of the templ module.
+ if err := modcheck.Check(cmd.Args.Path); err != nil {
+ cmd.Log.Warn("templ version check: " + err.Error())
+ }
+
+ fseh := NewFSEventHandler(
+ cmd.Log,
+ cmd.Args.Path,
+ cmd.Args.Watch,
+ opts,
+ cmd.Args.GenerateSourceMapVisualisations,
+ cmd.Args.KeepOrphanedFiles,
+ cmd.Args.FileWriter,
+ cmd.Args.Lazy,
+ )
+
+ // If we're processing a single file, don't bother setting up the channels/multithreaing.
+ if cmd.Args.FileName != "" {
+ _, err = fseh.HandleEvent(ctx, fsnotify.Event{
+ Name: cmd.Args.FileName,
+ Op: fsnotify.Create,
+ })
+ return err
+ }
+
+ // Start timer.
+ start := time.Now()
+
+ // Create channels:
+ // For the initial filesystem walk and subsequent (optional) fsnotify events.
+ events := make(chan fsnotify.Event)
+ // Count of events currently being processed by the event handler.
+ var eventsWG sync.WaitGroup
+ // Used to check that the event handler has completed.
+ var eventHandlerWG sync.WaitGroup
+ // For errs from the watcher.
+ errs := make(chan error)
+ // Tracks whether errors occurred during the generation process.
+ var errorCount atomic.Int64
+ // For triggering actions after generation has completed.
+ postGeneration := make(chan *GenerationEvent, 256)
+ // Used to check that the post-generation handler has completed.
+ var postGenerationWG sync.WaitGroup
+ var postGenerationEventsWG sync.WaitGroup
+
+ // Waitgroup for the push process.
+ var pushHandlerWG sync.WaitGroup
+
+ // Start process to push events into the channel.
+ pushHandlerWG.Add(1)
+ go func() {
+ defer pushHandlerWG.Done()
+ defer close(events)
+ cmd.Log.Debug(
+ "Walking directory",
+ slog.String("path", cmd.Args.Path),
+ slog.Bool("devMode", cmd.Args.Watch),
+ )
+ if err := watcher.WalkFiles(ctx, cmd.Args.Path, cmd.WatchPattern, events); err != nil {
+ cmd.Log.Error("WalkFiles failed, exiting", slog.Any("error", err))
+ errs <- FatalError{Err: fmt.Errorf("failed to walk files: %w", err)}
+ return
+ }
+ if !cmd.Args.Watch {
+ cmd.Log.Debug("Dev mode not enabled, process can finish early")
+ return
+ }
+ cmd.Log.Info("Watching files")
+ rw, err := watcher.Recursive(ctx, cmd.Args.Path, cmd.WatchPattern, events, errs)
+ if err != nil {
+ cmd.Log.Error("Recursive watcher setup failed, exiting", slog.Any("error", err))
+ errs <- FatalError{Err: fmt.Errorf("failed to setup recursive watcher: %w", err)}
+ return
+ }
+ cmd.Log.Debug("Waiting for context to be cancelled to stop watching files")
+ <-ctx.Done()
+ cmd.Log.Debug("Context cancelled, closing watcher")
+ if err := rw.Close(); err != nil {
+ cmd.Log.Error("Failed to close watcher", slog.Any("error", err))
+ }
+ cmd.Log.Debug("Waiting for events to be processed")
+ eventsWG.Wait()
+ cmd.Log.Debug(
+ "All pending events processed, waiting for pending post-generation events to complete",
+ )
+ postGenerationEventsWG.Wait()
+ cmd.Log.Debug(
+ "All post-generation events processed, deleting watch mode text files",
+ slog.Int64("errorCount", errorCount.Load()),
+ )
+
+ fileEvents := make(chan fsnotify.Event)
+ go func() {
+ if err := watcher.WalkFiles(ctx, cmd.Args.Path, cmd.WatchPattern, fileEvents); err != nil {
+ cmd.Log.Error("Post dev mode WalkFiles failed", slog.Any("error", err))
+ errs <- FatalError{Err: fmt.Errorf("failed to walk files: %w", err)}
+ return
+ }
+ close(fileEvents)
+ }()
+ for event := range fileEvents {
+ if strings.HasSuffix(event.Name, "_templ.txt") {
+ if err = os.Remove(event.Name); err != nil {
+ cmd.Log.Warn("Failed to remove watch mode text file", slog.Any("error", err))
+ }
+ }
+ }
+ }()
+
+ // Start process to handle events.
+ eventHandlerWG.Add(1)
+ sem := make(chan struct{}, cmd.Args.WorkerCount)
+ go func() {
+ defer eventHandlerWG.Done()
+ defer close(postGeneration)
+ cmd.Log.Debug("Starting event handler")
+ for event := range events {
+ eventsWG.Add(1)
+ sem <- struct{}{}
+ go func(event fsnotify.Event) {
+ cmd.Log.Debug("Processing file", slog.String("file", event.Name))
+ defer eventsWG.Done()
+ defer func() { <-sem }()
+ r, err := fseh.HandleEvent(ctx, event)
+ if err != nil {
+ errs <- err
+ }
+ if !(r.GoUpdated || r.TextUpdated) {
+ cmd.Log.Debug("File not updated", slog.String("file", event.Name))
+ return
+ }
+ e := &GenerationEvent{
+ Event: event,
+ Updated: r.Updated,
+ GoUpdated: r.GoUpdated,
+ TextUpdated: r.TextUpdated,
+ }
+ cmd.Log.Debug("File updated", slog.String("file", event.Name))
+ postGeneration <- e
+ }(event)
+ }
+ // Wait for all events to be processed before closing.
+ eventsWG.Wait()
+ }()
+
+ // Start process to handle post-generation events.
+ var updates int
+ postGenerationWG.Add(1)
+ var firstPostGenerationExecuted bool
+ go func() {
+ defer close(errs)
+ defer postGenerationWG.Done()
+ cmd.Log.Debug("Starting post-generation handler")
+ timeout := time.NewTimer(time.Hour * 24 * 365)
+ var goUpdated, textUpdated bool
+ var p *proxy.Handler
+ for {
+ select {
+ case ge := <-postGeneration:
+ if ge == nil {
+ cmd.Log.Debug("Post-generation event channel closed, exiting")
+ return
+ }
+ goUpdated = goUpdated || ge.GoUpdated
+ textUpdated = textUpdated || ge.TextUpdated
+ if goUpdated || textUpdated {
+ updates++
+ }
+ // Reset timer.
+ if !timeout.Stop() {
+ <-timeout.C
+ }
+ timeout.Reset(time.Millisecond * 100)
+ case <-timeout.C:
+ if !goUpdated && !textUpdated {
+ // Nothing to process, reset timer and wait again.
+ timeout.Reset(time.Hour * 24 * 365)
+ break
+ }
+ postGenerationEventsWG.Add(1)
+ if cmd.Args.Command != "" && goUpdated {
+ cmd.Log.Debug("Executing command", slog.String("command", cmd.Args.Command))
+ if cmd.Args.Watch {
+ os.Setenv("TEMPL_DEV_MODE", "true")
+ }
+ if _, err := run.Run(ctx, cmd.Args.Path, cmd.Args.Command); err != nil {
+ cmd.Log.Error("Error executing command", slog.Any("error", err))
+ }
+ }
+ if !firstPostGenerationExecuted {
+ cmd.Log.Debug("First post-generation event received, starting proxy")
+ firstPostGenerationExecuted = true
+ p, err = cmd.StartProxy(ctx)
+ if err != nil {
+ cmd.Log.Error("Failed to start proxy", slog.Any("error", err))
+ }
+ }
+ // Send server-sent event.
+ if p != nil && (textUpdated || goUpdated) {
+ cmd.Log.Debug("Sending reload event")
+ p.SendSSE("message", "reload")
+ }
+ postGenerationEventsWG.Done()
+ // Reset timer.
+ timeout.Reset(time.Millisecond * 100)
+ textUpdated = false
+ goUpdated = false
+ }
+ }
+ }()
+
+ // Read errors.
+ for err := range errs {
+ if err == nil {
+ continue
+ }
+ if errors.Is(err, FatalError{}) {
+ cmd.Log.Debug("Fatal error, exiting")
+ return err
+ }
+ cmd.Log.Error("Error", slog.Any("error", err))
+ errorCount.Add(1)
+ }
+
+ // Wait for everything to complete.
+ cmd.Log.Debug("Waiting for push handler to complete")
+ pushHandlerWG.Wait()
+ cmd.Log.Debug("Waiting for event handler to complete")
+ eventHandlerWG.Wait()
+ cmd.Log.Debug("Waiting for post-generation handler to complete")
+ postGenerationWG.Wait()
+ if cmd.Args.Command != "" {
+ cmd.Log.Debug("Killing command", slog.String("command", cmd.Args.Command))
+ if err := run.KillAll(); err != nil {
+ cmd.Log.Error("Error killing command", slog.Any("error", err))
+ }
+ }
+
+ // Check for errors after everything has completed.
+ if errorCount.Load() > 0 {
+ return fmt.Errorf("generation completed with %d errors", errorCount.Load())
+ }
+
+ cmd.Log.Info(
+ "Complete",
+ slog.Int("updates", updates),
+ slog.Duration("duration", time.Since(start)),
+ )
+ return nil
+}
+
+func (cmd *Generate) StartProxy(ctx context.Context) (p *proxy.Handler, err error) {
+ if cmd.Args.Proxy == "" {
+ cmd.Log.Debug("No proxy URL specified, not starting proxy")
+ return nil, nil
+ }
+ var target *url.URL
+ target, err = url.Parse(cmd.Args.Proxy)
+ if err != nil {
+ return nil, FatalError{Err: fmt.Errorf("failed to parse proxy URL: %w", err)}
+ }
+ if cmd.Args.ProxyPort == 0 {
+ cmd.Args.ProxyPort = 7331
+ }
+ if cmd.Args.ProxyBind == "" {
+ cmd.Args.ProxyBind = "127.0.0.1"
+ }
+ p = proxy.New(cmd.Log, cmd.Args.ProxyBind, cmd.Args.ProxyPort, target)
+ go func() {
+ cmd.Log.Info("Proxying", slog.String("from", p.URL), slog.String("to", p.Target.String()))
+ if err := http.ListenAndServe(fmt.Sprintf("%s:%d", cmd.Args.ProxyBind, cmd.Args.ProxyPort), p); err != nil {
+ cmd.Log.Error("Proxy failed", slog.Any("error", err))
+ }
+ }()
+ if !cmd.Args.OpenBrowser {
+ cmd.Log.Debug("Not opening browser")
+ return p, nil
+ }
+ go func() {
+ cmd.Log.Debug("Waiting for proxy to be ready", slog.String("url", p.URL))
+ backoff := backoff.NewExponentialBackOff()
+ backoff.InitialInterval = time.Second
+ var client http.Client
+ client.Timeout = 1 * time.Second
+ for {
+ if _, err := client.Get(p.URL); err == nil {
+ break
+ }
+ d := backoff.NextBackOff()
+ cmd.Log.Debug(
+ "Proxy not ready, retrying",
+ slog.String("url", p.URL),
+ slog.Any("backoff", d),
+ )
+ time.Sleep(d)
+ }
+ if err := browser.OpenURL(p.URL); err != nil {
+ cmd.Log.Error("Failed to open browser", slog.Any("error", err))
+ }
+ }()
+ return p, nil
+}
diff --git a/templ/cmd/templ/generatecmd/eventhandler.go b/templ/cmd/templ/generatecmd/eventhandler.go
new file mode 100644
index 0000000..93ce332
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/eventhandler.go
@@ -0,0 +1,366 @@
+package generatecmd
+
+import (
+ "bufio"
+ "bytes"
+ "context"
+ "crypto/sha256"
+ "fmt"
+ "go/format"
+ "go/scanner"
+ "go/token"
+ "io"
+ "log/slog"
+ "os"
+ "path"
+ "path/filepath"
+ "strings"
+ "sync"
+ "time"
+
+ "github.com/a-h/templ/cmd/templ/visualize"
+ "github.com/a-h/templ/generator"
+ "github.com/a-h/templ/parser/v2"
+ "github.com/fsnotify/fsnotify"
+)
+
+type FileWriterFunc func(name string, contents []byte) error
+
+func FileWriter(fileName string, contents []byte) error {
+ return os.WriteFile(fileName, contents, 0o644)
+}
+
+func WriterFileWriter(w io.Writer) FileWriterFunc {
+ return func(_ string, contents []byte) error {
+ _, err := w.Write(contents)
+ return err
+ }
+}
+
+func NewFSEventHandler(
+ log *slog.Logger,
+ dir string,
+ devMode bool,
+ genOpts []generator.GenerateOpt,
+ genSourceMapVis bool,
+ keepOrphanedFiles bool,
+ fileWriter FileWriterFunc,
+ lazy bool,
+) *FSEventHandler {
+ if !path.IsAbs(dir) {
+ dir, _ = filepath.Abs(dir)
+ }
+ fseh := &FSEventHandler{
+ Log: log,
+ dir: dir,
+ fileNameToLastModTime: make(map[string]time.Time),
+ fileNameToLastModTimeMutex: &sync.Mutex{},
+ fileNameToError: make(map[string]struct{}),
+ fileNameToErrorMutex: &sync.Mutex{},
+ fileNameToOutput: make(map[string]generator.GeneratorOutput),
+ fileNameToOutputMutex: &sync.Mutex{},
+ devMode: devMode,
+ hashes: make(map[string][sha256.Size]byte),
+ hashesMutex: &sync.Mutex{},
+ genOpts: genOpts,
+ genSourceMapVis: genSourceMapVis,
+ keepOrphanedFiles: keepOrphanedFiles,
+ writer: fileWriter,
+ lazy: lazy,
+ }
+ return fseh
+}
+
+type FSEventHandler struct {
+ Log *slog.Logger
+ // dir is the root directory being processed.
+ dir string
+ fileNameToLastModTime map[string]time.Time
+ fileNameToLastModTimeMutex *sync.Mutex
+ fileNameToError map[string]struct{}
+ fileNameToErrorMutex *sync.Mutex
+ fileNameToOutput map[string]generator.GeneratorOutput
+ fileNameToOutputMutex *sync.Mutex
+ devMode bool
+ hashes map[string][sha256.Size]byte
+ hashesMutex *sync.Mutex
+ genOpts []generator.GenerateOpt
+ genSourceMapVis bool
+ Errors []error
+ keepOrphanedFiles bool
+ writer func(string, []byte) error
+ lazy bool
+}
+
+type GenerateResult struct {
+ // Updated indicates that the file was updated.
+ Updated bool
+ // GoUpdated indicates that Go expressions were updated.
+ GoUpdated bool
+ // TextUpdated indicates that text literals were updated.
+ TextUpdated bool
+}
+
+func (h *FSEventHandler) HandleEvent(ctx context.Context, event fsnotify.Event) (result GenerateResult, err error) {
+ // Handle _templ.go files.
+ if !event.Has(fsnotify.Remove) && strings.HasSuffix(event.Name, "_templ.go") {
+ _, err = os.Stat(strings.TrimSuffix(event.Name, "_templ.go") + ".templ")
+ if !os.IsNotExist(err) {
+ return GenerateResult{}, err
+ }
+ // File is orphaned.
+ if h.keepOrphanedFiles {
+ return GenerateResult{}, nil
+ }
+ h.Log.Debug("Deleting orphaned Go file", slog.String("file", event.Name))
+ if err = os.Remove(event.Name); err != nil {
+ h.Log.Warn("Failed to remove orphaned file", slog.Any("error", err))
+ }
+ return GenerateResult{Updated: true, GoUpdated: true, TextUpdated: false}, nil
+ }
+ // Handle _templ.txt files.
+ if !event.Has(fsnotify.Remove) && strings.HasSuffix(event.Name, "_templ.txt") {
+ if h.devMode {
+ // Don't delete the file in dev mode, ignore changes to it, since the .templ file
+ // must have been updated in order to trigger a change in the _templ.txt file.
+ return GenerateResult{Updated: false, GoUpdated: false, TextUpdated: false}, nil
+ }
+ h.Log.Debug("Deleting watch mode file", slog.String("file", event.Name))
+ if err = os.Remove(event.Name); err != nil {
+ h.Log.Warn("Failed to remove watch mode text file", slog.Any("error", err))
+ return GenerateResult{}, nil
+ }
+ return GenerateResult{}, nil
+ }
+
+ // If the file hasn't been updated since the last time we processed it, ignore it.
+ lastModTime, updatedModTime := h.UpsertLastModTime(event.Name)
+ if !updatedModTime {
+ h.Log.Debug("Skipping file because it wasn't updated", slog.String("file", event.Name))
+ return GenerateResult{}, nil
+ }
+
+ // Process anything that isn't a templ file.
+ if !strings.HasSuffix(event.Name, ".templ") {
+ // If it's a Go file, mark it as updated.
+ if strings.HasSuffix(event.Name, ".go") {
+ result.GoUpdated = true
+ }
+ result.Updated = true
+ return result, nil
+ }
+
+ // Handle templ files.
+
+ // If the go file is newer than the templ file, skip generation, because it's up-to-date.
+ if h.lazy && goFileIsUpToDate(event.Name, lastModTime) {
+ h.Log.Debug("Skipping file because the Go file is up-to-date", slog.String("file", event.Name))
+ return GenerateResult{}, nil
+ }
+
+ // Start a processor.
+ start := time.Now()
+ var diag []parser.Diagnostic
+ result, diag, err = h.generate(ctx, event.Name)
+ if err != nil {
+ h.SetError(event.Name, true)
+ return result, fmt.Errorf("failed to generate code for %q: %w", event.Name, err)
+ }
+ if len(diag) > 0 {
+ for _, d := range diag {
+ h.Log.Warn(d.Message,
+ slog.String("from", fmt.Sprintf("%d:%d", d.Range.From.Line, d.Range.From.Col)),
+ slog.String("to", fmt.Sprintf("%d:%d", d.Range.To.Line, d.Range.To.Col)),
+ )
+ }
+ return result, nil
+ }
+ if errorCleared, errorCount := h.SetError(event.Name, false); errorCleared {
+ h.Log.Info("Error cleared", slog.String("file", event.Name), slog.Int("errors", errorCount))
+ }
+ h.Log.Debug("Generated code", slog.String("file", event.Name), slog.Duration("in", time.Since(start)))
+
+ return result, nil
+}
+
+func goFileIsUpToDate(templFileName string, templFileLastMod time.Time) (upToDate bool) {
+ goFileName := strings.TrimSuffix(templFileName, ".templ") + "_templ.go"
+ goFileInfo, err := os.Stat(goFileName)
+ if err != nil {
+ return false
+ }
+ return goFileInfo.ModTime().After(templFileLastMod)
+}
+
+func (h *FSEventHandler) SetError(fileName string, hasError bool) (previouslyHadError bool, errorCount int) {
+ h.fileNameToErrorMutex.Lock()
+ defer h.fileNameToErrorMutex.Unlock()
+ _, previouslyHadError = h.fileNameToError[fileName]
+ delete(h.fileNameToError, fileName)
+ if hasError {
+ h.fileNameToError[fileName] = struct{}{}
+ }
+ return previouslyHadError, len(h.fileNameToError)
+}
+
+func (h *FSEventHandler) UpsertLastModTime(fileName string) (modTime time.Time, updated bool) {
+ fileInfo, err := os.Stat(fileName)
+ if err != nil {
+ return modTime, false
+ }
+ h.fileNameToLastModTimeMutex.Lock()
+ defer h.fileNameToLastModTimeMutex.Unlock()
+ previousModTime := h.fileNameToLastModTime[fileName]
+ currentModTime := fileInfo.ModTime()
+ if !currentModTime.After(previousModTime) {
+ return currentModTime, false
+ }
+ h.fileNameToLastModTime[fileName] = currentModTime
+ return currentModTime, true
+}
+
+func (h *FSEventHandler) UpsertHash(fileName string, hash [sha256.Size]byte) (updated bool) {
+ h.hashesMutex.Lock()
+ defer h.hashesMutex.Unlock()
+ lastHash := h.hashes[fileName]
+ if lastHash == hash {
+ return false
+ }
+ h.hashes[fileName] = hash
+ return true
+}
+
+// generate Go code for a single template.
+// If a basePath is provided, the filename included in error messages is relative to it.
+func (h *FSEventHandler) generate(ctx context.Context, fileName string) (result GenerateResult, diagnostics []parser.Diagnostic, err error) {
+ t, err := parser.Parse(fileName)
+ if err != nil {
+ return GenerateResult{}, nil, fmt.Errorf("%s parsing error: %w", fileName, err)
+ }
+ targetFileName := strings.TrimSuffix(fileName, ".templ") + "_templ.go"
+
+ // Only use relative filenames to the basepath for filenames in runtime error messages.
+ absFilePath, err := filepath.Abs(fileName)
+ if err != nil {
+ return GenerateResult{}, nil, fmt.Errorf("failed to get absolute path for %q: %w", fileName, err)
+ }
+ relFilePath, err := filepath.Rel(h.dir, absFilePath)
+ if err != nil {
+ return GenerateResult{}, nil, fmt.Errorf("failed to get relative path for %q: %w", fileName, err)
+ }
+ // Convert Windows file paths to Unix-style for consistency.
+ relFilePath = filepath.ToSlash(relFilePath)
+
+ var b bytes.Buffer
+ generatorOutput, err := generator.Generate(t, &b, append(h.genOpts, generator.WithFileName(relFilePath))...)
+ if err != nil {
+ return GenerateResult{}, nil, fmt.Errorf("%s generation error: %w", fileName, err)
+ }
+
+ formattedGoCode, err := format.Source(b.Bytes())
+ if err != nil {
+ err = remapErrorList(err, generatorOutput.SourceMap, fileName)
+ return GenerateResult{}, nil, fmt.Errorf("%s source formatting error %w", fileName, err)
+ }
+
+ // Hash output, and write out the file if the goCodeHash has changed.
+ goCodeHash := sha256.Sum256(formattedGoCode)
+ if h.UpsertHash(targetFileName, goCodeHash) {
+ result.Updated = true
+ if err = h.writer(targetFileName, formattedGoCode); err != nil {
+ return result, nil, fmt.Errorf("failed to write target file %q: %w", targetFileName, err)
+ }
+ }
+
+ // Add the txt file if it has changed.
+ if h.devMode {
+ txtFileName := strings.TrimSuffix(fileName, ".templ") + "_templ.txt"
+ joined := strings.Join(generatorOutput.Literals, "\n")
+ txtHash := sha256.Sum256([]byte(joined))
+ if h.UpsertHash(txtFileName, txtHash) {
+ result.TextUpdated = true
+ if err = os.WriteFile(txtFileName, []byte(joined), 0o644); err != nil {
+ return result, nil, fmt.Errorf("failed to write string literal file %q: %w", txtFileName, err)
+ }
+ }
+
+ // Check whether the change would require a recompilation to take effect.
+ h.fileNameToOutputMutex.Lock()
+ defer h.fileNameToOutputMutex.Unlock()
+ previous := h.fileNameToOutput[fileName]
+ if generator.HasChanged(previous, generatorOutput) {
+ result.GoUpdated = true
+ }
+ h.fileNameToOutput[fileName] = generatorOutput
+ }
+
+ parsedDiagnostics, err := parser.Diagnose(t)
+ if err != nil {
+ return result, nil, fmt.Errorf("%s diagnostics error: %w", fileName, err)
+ }
+
+ if h.genSourceMapVis {
+ err = generateSourceMapVisualisation(ctx, fileName, targetFileName, generatorOutput.SourceMap)
+ }
+
+ return result, parsedDiagnostics, err
+}
+
+// Takes an error from the formatter and attempts to convert the positions reported in the target file to their positions
+// in the source file.
+func remapErrorList(err error, sourceMap *parser.SourceMap, fileName string) error {
+ list, ok := err.(scanner.ErrorList)
+ if !ok || len(list) == 0 {
+ return err
+ }
+ for i, e := range list {
+ // The positions in the source map are off by one line because of the package definition.
+ srcPos, ok := sourceMap.SourcePositionFromTarget(uint32(e.Pos.Line-1), uint32(e.Pos.Column))
+ if !ok {
+ continue
+ }
+ list[i].Pos = token.Position{
+ Filename: fileName,
+ Offset: int(srcPos.Index),
+ Line: int(srcPos.Line) + 1,
+ Column: int(srcPos.Col),
+ }
+ }
+ return list
+}
+
+func generateSourceMapVisualisation(ctx context.Context, templFileName, goFileName string, sourceMap *parser.SourceMap) error {
+ if err := ctx.Err(); err != nil {
+ return err
+ }
+ var templContents, goContents []byte
+ var templErr, goErr error
+ var wg sync.WaitGroup
+ wg.Add(2)
+ go func() {
+ defer wg.Done()
+ templContents, templErr = os.ReadFile(templFileName)
+ }()
+ go func() {
+ defer wg.Done()
+ goContents, goErr = os.ReadFile(goFileName)
+ }()
+ wg.Wait()
+ if templErr != nil {
+ return templErr
+ }
+ if goErr != nil {
+ return templErr
+ }
+
+ targetFileName := strings.TrimSuffix(templFileName, ".templ") + "_templ_sourcemap.html"
+ w, err := os.Create(targetFileName)
+ if err != nil {
+ return fmt.Errorf("%s sourcemap visualisation error: %w", templFileName, err)
+ }
+ defer w.Close()
+ b := bufio.NewWriter(w)
+ defer b.Flush()
+
+ return visualize.HTML(templFileName, string(templContents), string(goContents), sourceMap).Render(ctx, b)
+}
diff --git a/templ/cmd/templ/generatecmd/fatalerror.go b/templ/cmd/templ/generatecmd/fatalerror.go
new file mode 100644
index 0000000..1081659
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/fatalerror.go
@@ -0,0 +1,23 @@
+package generatecmd
+
+type FatalError struct {
+ Err error
+}
+
+func (e FatalError) Error() string {
+ return e.Err.Error()
+}
+
+func (e FatalError) Unwrap() error {
+ return e.Err
+}
+
+func (e FatalError) Is(target error) bool {
+ _, ok := target.(FatalError)
+ return ok
+}
+
+func (e FatalError) As(target any) bool {
+ _, ok := target.(*FatalError)
+ return ok
+}
diff --git a/templ/cmd/templ/generatecmd/main.go b/templ/cmd/templ/generatecmd/main.go
new file mode 100644
index 0000000..4d2cbf5
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/main.go
@@ -0,0 +1,39 @@
+package generatecmd
+
+import (
+ "context"
+ _ "embed"
+ "log/slog"
+
+ _ "net/http/pprof"
+)
+
+type Arguments struct {
+ FileName string
+ FileWriter FileWriterFunc
+ Path string
+ Watch bool
+ WatchPattern string
+ OpenBrowser bool
+ Command string
+ ProxyBind string
+ ProxyPort int
+ Proxy string
+ NotifyProxy bool
+ WorkerCount int
+ GenerateSourceMapVisualisations bool
+ IncludeVersion bool
+ IncludeTimestamp bool
+ // PPROFPort is the port to run the pprof server on.
+ PPROFPort int
+ KeepOrphanedFiles bool
+ Lazy bool
+}
+
+func Run(ctx context.Context, log *slog.Logger, args Arguments) (err error) {
+ g, err := NewGenerate(log, args)
+ if err != nil {
+ return err
+ }
+ return g.Run(ctx)
+}
diff --git a/templ/cmd/templ/generatecmd/main_test.go b/templ/cmd/templ/generatecmd/main_test.go
new file mode 100644
index 0000000..b13c8eb
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/main_test.go
@@ -0,0 +1,170 @@
+package generatecmd
+
+import (
+ "context"
+ "io"
+ "log/slog"
+ "os"
+ "path"
+ "regexp"
+ "testing"
+ "time"
+
+ "github.com/a-h/templ/cmd/templ/testproject"
+ "golang.org/x/sync/errgroup"
+)
+
+func TestGenerate(t *testing.T) {
+ log := slog.New(slog.NewJSONHandler(io.Discard, nil))
+ t.Run("can generate a file in place", func(t *testing.T) {
+ // templ generate -f templates.templ
+ dir, err := testproject.Create("github.com/a-h/templ/cmd/templ/testproject")
+ if err != nil {
+ t.Fatalf("failed to create test project: %v", err)
+ }
+ defer os.RemoveAll(dir)
+
+ // Delete the templates_templ.go file to ensure it is generated.
+ err = os.Remove(path.Join(dir, "templates_templ.go"))
+ if err != nil {
+ t.Fatalf("failed to remove templates_templ.go: %v", err)
+ }
+
+ // Run the generate command.
+ err = Run(context.Background(), log, Arguments{
+ FileName: path.Join(dir, "templates.templ"),
+ })
+ if err != nil {
+ t.Fatalf("failed to run generate command: %v", err)
+ }
+
+ // Check the templates_templ.go file was created.
+ _, err = os.Stat(path.Join(dir, "templates_templ.go"))
+ if err != nil {
+ t.Fatalf("templates_templ.go was not created: %v", err)
+ }
+ })
+ t.Run("can generate a file in watch mode", func(t *testing.T) {
+ // templ generate -f templates.templ
+ dir, err := testproject.Create("github.com/a-h/templ/cmd/templ/testproject")
+ if err != nil {
+ t.Fatalf("failed to create test project: %v", err)
+ }
+ defer os.RemoveAll(dir)
+
+ // Delete the templates_templ.go file to ensure it is generated.
+ err = os.Remove(path.Join(dir, "templates_templ.go"))
+ if err != nil {
+ t.Fatalf("failed to remove templates_templ.go: %v", err)
+ }
+ ctx, cancel := context.WithCancel(context.Background())
+
+ var eg errgroup.Group
+ eg.Go(func() error {
+ // Run the generate command.
+ return Run(ctx, log, Arguments{
+ Path: dir,
+ Watch: true,
+ })
+ })
+
+ // Check the templates_templ.go file was created, with backoff.
+ for i := 0; i < 5; i++ {
+ time.Sleep(time.Second * time.Duration(i))
+ _, err = os.Stat(path.Join(dir, "templates_templ.go"))
+ if err != nil {
+ continue
+ }
+ _, err = os.Stat(path.Join(dir, "templates_templ.txt"))
+ if err != nil {
+ continue
+ }
+ break
+ }
+ if err != nil {
+ t.Fatalf("template files were not created: %v", err)
+ }
+
+ cancel()
+ if err := eg.Wait(); err != nil {
+ t.Fatalf("generate command failed: %v", err)
+ }
+
+ // Check the templates_templ.txt file was removed.
+ _, err = os.Stat(path.Join(dir, "templates_templ.txt"))
+ if err == nil {
+ t.Fatalf("templates_templ.txt was not removed")
+ }
+ })
+}
+
+func TestDefaultWatchPattern(t *testing.T) {
+ tests := []struct {
+ name string
+ input string
+ matches bool
+ }{
+ {
+ name: "empty file names do not match",
+ input: "",
+ matches: false,
+ },
+ {
+ name: "*_templ.txt matches, Windows",
+ input: `C:\Users\adrian\github.com\a-h\templ\cmd\templ\testproject\strings_templ.txt`,
+ matches: true,
+ },
+ {
+ name: "*_templ.txt matches, Unix",
+ input: "/Users/adrian/github.com/a-h/templ/cmd/templ/testproject/strings_templ.txt",
+ matches: true,
+ },
+ {
+ name: "*.templ files match, Windows",
+ input: `C:\Users\adrian\github.com\a-h\templ\cmd\templ\testproject\templates.templ`,
+ matches: true,
+ },
+ {
+ name: "*.templ files match, Unix",
+ input: "/Users/adrian/github.com/a-h/templ/cmd/templ/testproject/templates.templ",
+ matches: true,
+ },
+ {
+ name: "*_templ.go files match, Windows",
+ input: `C:\Users\adrian\github.com\a-h\templ\cmd\templ\testproject\templates_templ.go`,
+ matches: true,
+ },
+ {
+ name: "*_templ.go files match, Unix",
+ input: "/Users/adrian/github.com/a-h/templ/cmd/templ/testproject/templates_templ.go",
+ matches: true,
+ },
+ {
+ name: "*.go files match, Windows",
+ input: `C:\Users\adrian\github.com\a-h\templ\cmd\templ\testproject\templates.go`,
+ matches: true,
+ },
+ {
+ name: "*.go files match, Unix",
+ input: "/Users/adrian/github.com/a-h/templ/cmd/templ/testproject/templates.go",
+ matches: true,
+ },
+ {
+ name: "*.css files do not match",
+ input: "/Users/adrian/github.com/a-h/templ/cmd/templ/testproject/templates.css",
+ matches: false,
+ },
+ }
+ wpRegexp, err := regexp.Compile(defaultWatchPattern)
+ if err != nil {
+ t.Fatalf("failed to compile default watch pattern: %v", err)
+ }
+ for _, test := range tests {
+ t.Run(test.name, func(t *testing.T) {
+ t.Parallel()
+ if wpRegexp.MatchString(test.input) != test.matches {
+ t.Fatalf("expected match of %q to be %v", test.input, test.matches)
+ }
+ })
+ }
+}
diff --git a/templ/cmd/templ/generatecmd/modcheck/modcheck.go b/templ/cmd/templ/generatecmd/modcheck/modcheck.go
new file mode 100644
index 0000000..bc3fc03
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/modcheck/modcheck.go
@@ -0,0 +1,82 @@
+package modcheck
+
+import (
+ "fmt"
+ "os"
+ "path/filepath"
+
+ "github.com/a-h/templ"
+ "golang.org/x/mod/modfile"
+ "golang.org/x/mod/semver"
+)
+
+// WalkUp the directory tree, starting at dir, until we find a directory containing
+// a go.mod file.
+func WalkUp(dir string) (string, error) {
+ dir, err := filepath.Abs(dir)
+ if err != nil {
+ return "", fmt.Errorf("failed to get absolute path: %w", err)
+ }
+
+ var modFile string
+ for {
+ modFile = filepath.Join(dir, "go.mod")
+ _, err := os.Stat(modFile)
+ if err != nil && !os.IsNotExist(err) {
+ return "", fmt.Errorf("failed to stat go.mod file: %w", err)
+ }
+ if os.IsNotExist(err) {
+ // Move up.
+ prev := dir
+ dir = filepath.Dir(dir)
+ if dir == prev {
+ break
+ }
+ continue
+ }
+ break
+ }
+
+ // No file found.
+ if modFile == "" {
+ return dir, fmt.Errorf("could not find go.mod file")
+ }
+ return dir, nil
+}
+
+func Check(dir string) error {
+ dir, err := WalkUp(dir)
+ if err != nil {
+ return err
+ }
+
+ // Found a go.mod file.
+ // Read it and find the templ version.
+ modFile := filepath.Join(dir, "go.mod")
+ m, err := os.ReadFile(modFile)
+ if err != nil {
+ return fmt.Errorf("failed to read go.mod file: %w", err)
+ }
+
+ mf, err := modfile.Parse(modFile, m, nil)
+ if err != nil {
+ return fmt.Errorf("failed to parse go.mod file: %w", err)
+ }
+ if mf.Module.Mod.Path == "github.com/a-h/templ" {
+ // The go.mod file is for templ itself.
+ return nil
+ }
+ for _, r := range mf.Require {
+ if r.Mod.Path == "github.com/a-h/templ" {
+ cmp := semver.Compare(r.Mod.Version, templ.Version())
+ if cmp < 0 {
+ return fmt.Errorf("generator %v is newer than templ version %v found in go.mod file, consider running `go get -u github.com/a-h/templ` to upgrade", templ.Version(), r.Mod.Version)
+ }
+ if cmp > 0 {
+ return fmt.Errorf("generator %v is older than templ version %v found in go.mod file, consider upgrading templ CLI", templ.Version(), r.Mod.Version)
+ }
+ return nil
+ }
+ }
+ return fmt.Errorf("templ not found in go.mod file, run `go get github.com/a-h/templ` to install it")
+}
diff --git a/templ/cmd/templ/generatecmd/modcheck/modcheck_test.go b/templ/cmd/templ/generatecmd/modcheck/modcheck_test.go
new file mode 100644
index 0000000..544642b
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/modcheck/modcheck_test.go
@@ -0,0 +1,47 @@
+package modcheck
+
+import (
+ "testing"
+
+ "golang.org/x/mod/modfile"
+)
+
+func TestPatchGoVersion(t *testing.T) {
+ tests := []struct {
+ input string
+ expected string
+ }{
+ {
+ input: "go 1.20",
+ expected: "1.20",
+ },
+ {
+ input: "go 1.20.123",
+ expected: "1.20.123",
+ },
+ {
+ input: "go 1.20.1",
+ expected: "1.20.1",
+ },
+ {
+ input: "go 1.20rc1",
+ expected: "1.20rc1",
+ },
+ {
+ input: "go 1.15",
+ expected: "1.15",
+ },
+ }
+ for _, test := range tests {
+ t.Run(test.input, func(t *testing.T) {
+ input := "module github.com/a-h/templ\n\n" + string(test.input) + "\n" + "toolchain go1.27.9\n"
+ mf, err := modfile.Parse("go.mod", []byte(input), nil)
+ if err != nil {
+ t.Fatalf("failed to parse go.mod: %v", err)
+ }
+ if test.expected != mf.Go.Version {
+ t.Errorf("expected %q, got %q", test.expected, mf.Go.Version)
+ }
+ })
+ }
+}
diff --git a/templ/cmd/templ/generatecmd/proxy/proxy.go b/templ/cmd/templ/generatecmd/proxy/proxy.go
new file mode 100644
index 0000000..f8d4ccd
--- /dev/null
+++ b/templ/cmd/templ/generatecmd/proxy/proxy.go
@@ -0,0 +1,284 @@
+package proxy
+
+import (
+ "bytes"
+ "compress/gzip"
+ "fmt"
+ "html"
+ "io"
+ stdlog "log"
+ "log/slog"
+ "math"
+ "net/http"
+ "net/http/httputil"
+ "net/url"
+ "os"
+ "strconv"
+ "strings"
+ "time"
+
+ "github.com/PuerkitoBio/goquery"
+ "github.com/a-h/templ/cmd/templ/generatecmd/sse"
+ "github.com/andybalholm/brotli"
+
+ _ "embed"
+)
+
+//go:embed script.js
+var script string
+
+type Handler struct {
+ log *slog.Logger
+ URL string
+ Target *url.URL
+ p *httputil.ReverseProxy
+ sse *sse.Handler
+}
+
+func getScriptTag(nonce string) string {
+ if nonce != "" {
+ var sb strings.Builder
+ sb.WriteString(``)
+ return sb.String()
+ }
+ return ``
+}
+
+func insertScriptTagIntoBody(nonce, body string) (updated string) {
+ doc, err := goquery.NewDocumentFromReader(strings.NewReader(body))
+ if err != nil {
+ return strings.Replace(body, "+ C +
+