Always end template files in a newline (#3687)

MichaelUrman · raphael · web-flow · commit 7444b7ac02d4 · 2025-04-01T17:04:03.000-04:00
* End all grpc templates in newlines

- Remove spurious newline in parse_endpoint
- Update test (leave trailing whitespace alone)

* End all http templates in newlines

- request_init.go.tpl needs to strip it
- Most partials need to strip, but handle once inside templates.go

* End all services and example templates in newlines

- codegen/service/templates/return_type_init.go.tpl removes this with a
  trailing dash, as the say it's consumed through validations is hard to
  follow and fix
- example now spaces out before var(){} blocks including after flag.Parse()

---------

Co-authored-by: Raphael Simon &lt;simon.raphael@gmail.com&gt;
diff --git a/codegen/example/templates/client_end.go.tpl b/codegen/example/templates/client_end.go.tpl
@@ -10,4 +10,4 @@
 		m, _ := json.MarshalIndent(data, "", "    ")
 		fmt.Println(string(m))
 	}
-}
+}
diff --git a/codegen/example/templates/client_endpoint_init.go.tpl b/codegen/example/templates/client_endpoint_init.go.tpl
@@ -1,5 +1,5 @@
 
-var(
+	var(
 		endpoint goa.Endpoint
 		payload any
 		err error
@@ -22,4 +22,4 @@ var(
 		fmt.Fprintln(os.Stderr, err.Error())
 		fmt.Fprintln(os.Stderr, "run '"+os.Args[0]+" --help' for detailed usage.")
 		os.Exit(1)
-}	
+	}
diff --git a/codegen/example/templates/client_start.go.tpl b/codegen/example/templates/client_start.go.tpl
@@ -11,4 +11,4 @@ func main() {
 		timeoutF = flag.Int("timeout", 30, "Maximum number of seconds to wait for response")
 	)
 	flag.Usage = usage
-	flag.Parse()
+	flag.Parse()
diff --git a/codegen/example/templates/client_var_init.go.tpl b/codegen/example/templates/client_var_init.go.tpl
@@ -51,4 +51,4 @@ var (
 		}
 		scheme = u.Scheme
 		host = u.Host
-	}	
+	}
diff --git a/codegen/example/templates/server_end.go.tpl b/codegen/example/templates/server_end.go.tpl
@@ -8,4 +8,4 @@
 
 	wg.Wait()
 	log.Printf(ctx, "exited")
-}
+}
diff --git a/codegen/example/templates/server_endpoints.go.tpl b/codegen/example/templates/server_endpoints.go.tpl
@@ -17,4 +17,4 @@
 		{{- end }}
 	{{- end }}
 	}
-{{- end }}
+{{- end }}
diff --git a/codegen/example/templates/server_handler.go.tpl b/codegen/example/templates/server_handler.go.tpl
@@ -51,4 +51,4 @@
 {{- end }}
 	default:
 		log.Fatal(ctx, fmt.Errorf("invalid host argument: %q (valid hosts: {{ join .Server.AvailableHosts "|" }})", *hostF))
-	}	
+	}
diff --git a/codegen/example/templates/server_interceptors.go.tpl b/codegen/example/templates/server_interceptors.go.tpl
@@ -16,4 +16,4 @@
 	{{- end }}
 	}
 	{{- end }}
-{{- end }}
+{{- end }}
diff --git a/codegen/example/templates/server_interrupts.go.tpl b/codegen/example/templates/server_interrupts.go.tpl
@@ -13,4 +13,4 @@
 	}()
 
 	var wg sync.WaitGroup
-	ctx, cancel := context.WithCancel(ctx)
+	ctx, cancel := context.WithCancel(ctx)
diff --git a/codegen/example/templates/server_logger.go.tpl b/codegen/example/templates/server_logger.go.tpl
@@ -10,4 +10,4 @@
 		ctx = log.Context(ctx, log.WithDebug())
 		log.Debugf(ctx, "debug logs enabled")
 	}
-	log.Print(ctx, log.KV{K: "http-port", V: *httpPortF})
+	log.Print(ctx, log.KV{K: "http-port", V: *httpPortF})
diff --git a/codegen/example/templates/server_services.go.tpl b/codegen/example/templates/server_services.go.tpl
@@ -15,4 +15,4 @@
 		{{- end }}
 	{{- end }}
 	}
-{{- end }}
+{{- end }}
diff --git a/codegen/example/templates/server_start.go.tpl b/codegen/example/templates/server_start.go.tpl
@@ -13,4 +13,4 @@ func main() {
 		secureF = flag.Bool("secure", false, "Use secure scheme (https or grpcs)")
 		dbgF  = flag.Bool("debug", false, "Log request and response bodies")
 	)
-	flag.Parse()
+	flag.Parse()
diff --git a/codegen/example/testdata/client-no-server.golden b/codegen/example/testdata/client-no-server.golden
@@ -9,6 +9,7 @@ func main() {
 	)
 	flag.Usage = usage
 	flag.Parse()
+
 	var (
 		addr    string
 		timeout int
@@ -42,6 +43,7 @@ func main() {
 		scheme = u.Scheme
 		host = u.Host
 	}
+
 	var (
 		endpoint goa.Endpoint
 		payload  any
diff --git a/codegen/example/testdata/client-single-server-multiple-hosts-with-variables.golden b/codegen/example/testdata/client-single-server-multiple-hosts-with-variables.golden
@@ -12,6 +12,7 @@ func main() {
 	)
 	flag.Usage = usage
 	flag.Parse()
+
 	var (
 		addr    string
 		timeout int
@@ -63,6 +64,7 @@ func main() {
 		scheme = u.Scheme
 		host = u.Host
 	}
+
 	var (
 		endpoint goa.Endpoint
 		payload  any
diff --git a/codegen/example/testdata/client-single-server-multiple-hosts.golden b/codegen/example/testdata/client-single-server-multiple-hosts.golden
@@ -9,6 +9,7 @@ func main() {
 	)
 	flag.Usage = usage
 	flag.Parse()
+
 	var (
 		addr    string
 		timeout int
@@ -44,6 +45,7 @@ func main() {
 		scheme = u.Scheme
 		host = u.Host
 	}
+
 	var (
 		endpoint goa.Endpoint
 		payload  any
diff --git a/codegen/example/testdata/client-single-server-single-host-with-variables.golden b/codegen/example/testdata/client-single-server-single-host-with-variables.golden
@@ -18,6 +18,7 @@ func main() {
 	)
 	flag.Usage = usage
 	flag.Parse()
+
 	var (
 		addr    string
 		timeout int
@@ -60,6 +61,7 @@ func main() {
 		scheme = u.Scheme
 		host = u.Host
 	}
+
 	var (
 		endpoint goa.Endpoint
 		payload  any
diff --git a/codegen/example/testdata/client-single-server-single-host.golden b/codegen/example/testdata/client-single-server-single-host.golden
@@ -9,6 +9,7 @@ func main() {
 	)
 	flag.Usage = usage
 	flag.Parse()
+
 	var (
 		addr    string
 		timeout int
@@ -42,6 +43,7 @@ func main() {
 		scheme = u.Scheme
 		host = u.Host
 	}
+
 	var (
 		endpoint goa.Endpoint
 		payload  any
diff --git a/codegen/service/templates/return_type_init.go.tpl b/codegen/service/templates/return_type_init.go.tpl
@@ -37,4 +37,4 @@
 		}
 	{{- end }}
 	return {{ .ReturnVar }}
-{{- end }}
+{{- end -}}
diff --git a/codegen/service/templates/service_endpoint_stream_struct.go.tpl b/codegen/service/templates/service_endpoint_stream_struct.go.tpl
@@ -8,4 +8,4 @@ type {{ .ServerStream.EndpointStruct }} struct {
 {{- end }}
 	{{ printf "Stream is the server stream used by the %q method to send data." .Name | comment }}
 	Stream {{ .ServerStream.Interface }}
-}
+}
diff --git a/codegen/service/templates/service_endpoints_init.go.tpl b/codegen/service/templates/service_endpoints_init.go.tpl
@@ -22,4 +22,4 @@ func New{{ .VarName }}(s {{ .ServiceVarName }}{{ if .HasServerInterceptors }}, s
 	{{- end }}
 	return endpoints
 {{- end }}
-}
+}
diff --git a/codegen/service/templates/service_endpoints_use.go.tpl b/codegen/service/templates/service_endpoints_use.go.tpl
@@ -5,4 +5,4 @@ func (e *{{ .VarName }}) Use(m func(goa.Endpoint) goa.Endpoint) {
 {{- range .Methods }}
 	e.{{ .VarName }} = m(e.{{ .VarName }})
 {{- end }}
-}
+}
diff --git a/grpc/codegen/templates/client_init.go.tpl b/grpc/codegen/templates/client_init.go.tpl
@@ -4,4 +4,4 @@ func New{{ .ClientStruct }}(cc *grpc.ClientConn, opts ...grpc.CallOption) *{{ .C
 		grpccli: {{ .ClientInterfaceInit }}(cc),
 		opts: opts,
 	}
-}
+}
diff --git a/grpc/codegen/templates/client_struct.go.tpl b/grpc/codegen/templates/client_struct.go.tpl
@@ -2,4 +2,4 @@
 type {{ .ClientStruct }} struct {
 	grpccli {{ .PkgName }}.{{ .ClientInterface }}
 	opts []grpc.CallOption
-}
+}
diff --git a/grpc/codegen/templates/do_grpc_cli.go.tpl b/grpc/codegen/templates/do_grpc_cli.go.tpl
@@ -26,4 +26,4 @@ func grpcUsageCommands() string {
 func grpcUsageExamples() string {
 	return cli.UsageExamples()
 }
-{{- end }}
+{{- end }}
diff --git a/grpc/codegen/templates/parse_endpoint.go.tpl b/grpc/codegen/templates/parse_endpoint.go.tpl
@@ -22,7 +22,7 @@ func ParseEndpoint(
 			c := {{ .PkgName }}.NewClient(cc, opts...)
 			switch epn {
 		{{- $pkgName := .PkgName }}
-		{{ range .Subcommands }}
+		{{- range .Subcommands }}
 			case "{{ .Name }}":
 				endpoint = c.{{ .MethodVarName }}()
 			{{- if .Interceptors }}
diff --git a/grpc/codegen/templates/partial/convert_string_to_type.go.tpl b/grpc/codegen/templates/partial/convert_string_to_type.go.tpl
@@ -156,4 +156,4 @@
 	{{- else }}
 		// unsupported type {{ .Type.Name }} for var {{ .VarName }}
 	{{- end }}
-{{- end }}
+{{- end }}
diff --git a/grpc/codegen/templates/partial/convert_type_to_string.go.tpl b/grpc/codegen/templates/partial/convert_type_to_string.go.tpl
@@ -26,4 +26,4 @@
 	{{- else }}
 		// unsupported type {{ .Type.Name }} for field {{ .FieldName }}
 	{{- end }}
-{{- end }}
+{{- end }}
diff --git a/grpc/codegen/templates/remote_method_builder.go.tpl b/grpc/codegen/templates/remote_method_builder.go.tpl
@@ -9,4 +9,4 @@ func Build{{ .Method.VarName }}Func(grpccli {{ .PkgName }}.{{ .ClientInterface }
 		}
 		return grpccli.{{ .ClientMethodName }}(ctx{{ if not .Method.StreamingPayload }}, &{{ .Request.ClientConvert.TgtName }}{}{{ end }}, opts...)
 	}
-}
+}
diff --git a/grpc/codegen/templates/request_encoder.go.tpl b/grpc/codegen/templates/request_encoder.go.tpl
@@ -43,4 +43,4 @@ func Encode{{ .Method.VarName }}Request(ctx context.Context, v any, md *metadata
 {{- else }}
 	return nil, nil
 {{- end }}
-}
+}
diff --git a/grpc/codegen/templates/response_decoder.go.tpl b/grpc/codegen/templates/response_decoder.go.tpl
@@ -116,4 +116,4 @@ func Decode{{ .Method.VarName }}Response(ctx context.Context, v any, hdr, trlr m
 			}
 		{{- end }}
 	{{- end }}
-{{- end }}
+{{- end }}
diff --git a/grpc/codegen/testdata/endpoint-endpoint-with-interceptors.golden b/grpc/codegen/testdata/endpoint-endpoint-with-interceptors.golden
@@ -117,7 +117,6 @@ func ParseEndpoint(
 		case "service-with-interceptors":
 			c := servicewithinterceptorsc.NewClient(cc, opts...)
 			switch epn {
-
 			case "method-a":
 				endpoint = c.MethodA()
 				endpoint = servicewithinterceptors.WrapMethodAClientEndpoint(endpoint, inter)
diff --git a/http/codegen/templates.go b/http/codegen/templates.go
@@ -21,7 +21,7 @@ func readTemplate(name string, partials ...string) string {
 				panic("failed to read partial template " + partial + ": " + err.Error()) // Should never happen, bug if it does
 			}
 			partialDefs = append(partialDefs,
-				fmt.Sprintf("{{ define \"partial_%s\" }}\n%s{{ end }}", partial, string(tmpl)))
+				fmt.Sprintf("{{- define \"partial_%s\" }}\n%s{{- end }}", partial, string(tmpl)))
 		}
 		prefix = strings.Join(partialDefs, "\n")
 	}
diff --git a/http/codegen/templates/append_fs.go.tpl b/http/codegen/templates/append_fs.go.tpl
@@ -21,4 +21,4 @@ func (s appendFS) Open(name string) (http.File, error) {
 // before delegating to the provided embed.FS.
 func appendPrefix(fsys http.FileSystem, prefix string) http.FileSystem {
 	return appendFS{prefix: prefix, fs: fsys}
-}
+}
diff --git a/http/codegen/templates/cli_end.go.tpl b/http/codegen/templates/cli_end.go.tpl
@@ -26,4 +26,4 @@ return cli.ParseEndpoint(
 	{{- end }}
 {{- end }}
 	)
-}
+}
diff --git a/http/codegen/templates/partial/client_map_conversion.go.tpl b/http/codegen/templates/partial/client_map_conversion.go.tpl
@@ -20,4 +20,4 @@ for k{{ if not (eq .Type.KeyType.Type.Name "string") }}Raw{{ end }}, value := ra
 			{{ template "partial_client_type_conversion" (typeConversionData .Type.ElemType.Type .FieldType.ElemType.Type "valueStr" "value") }}
 			values.Add(key, valueStr)
 		{{- end }}
-	}
+	}
diff --git a/http/codegen/templates/partial/client_type_conversion.go.tpl b/http/codegen/templates/partial/client_type_conversion.go.tpl
@@ -24,4 +24,4 @@
     {{ .VarName }} := fmt.Sprintf("%v", {{ .Target }})
   {{- else }}
     // unsupported type {{ .Type.Name }} for field {{ .FieldName }}
-  {{- end }}
+  {{- end }}
diff --git a/http/codegen/templates/partial/element_slice_conversion.go.tpl b/http/codegen/templates/partial/element_slice_conversion.go.tpl
@@ -1,4 +1,4 @@
 	{{ .VarName }} = make({{ goTypeRef .Type }}, len({{ .VarName }}Raw))
 	for i, rv := range {{ .VarName }}Raw {
 		{{- template "partial_slice_item_conversion" . }}
-	}
+	}
diff --git a/http/codegen/templates/partial/header_conversion.go.tpl b/http/codegen/templates/partial/header_conversion.go.tpl
@@ -35,4 +35,4 @@
 		{{- end }}
 	{{- else }}
 		// unsupported type {{ .Type.Name }} for header field {{ .FieldName }}
-	{{- end }}
+	{{- end }}
diff --git a/http/codegen/templates/partial/path_conversion.go.tpl b/http/codegen/templates/partial/path_conversion.go.tpl
@@ -6,4 +6,4 @@
 		}
 	{{- else }}
 		{{- template "partial_query_type_conversion" . }}
-	{{- end }}
+	{{- end }}
diff --git a/http/codegen/templates/partial/query_map_conversion.go.tpl b/http/codegen/templates/partial/query_map_conversion.go.tpl
@@ -40,4 +40,4 @@
 			{{- template "partial_query_type_conversion" (conversionData (printf "val%s" .Loop) "query" .Type.ElemType.Type) }}
 		}
 		{{ .VarName }}[key{{ .Loop }}] = val{{ .Loop }}
-	{{- end }}
+	{{- end }}
diff --git a/http/codegen/templates/partial/query_slice_conversion.go.tpl b/http/codegen/templates/partial/query_slice_conversion.go.tpl
@@ -8,4 +8,4 @@
 	{{- else if eq . "boolean" }} strconv.FormatBool(v)
 	{{- else if eq . "bytes" }} url.QueryEscape(string(v))
 	{{- else }} url.QueryEscape(fmt.Sprintf("%v", v))
-	{{- end }}
+	{{- end }}
diff --git a/http/codegen/templates/partial/query_type_conversion.go.tpl b/http/codegen/templates/partial/query_type_conversion.go.tpl
@@ -81,4 +81,4 @@
 		{{ if and (ne .TypeRef nil) (and (ne .TypeRef "bool") (ne .TypeRef "*bool")) }}{{ .VarName }} = ({{.TypeRef}})({{ if .Pointer }}&{{ end }}v){{ else }}{{ .VarName }} = {{ if .Pointer }}&{{ end }}v{{ end }}
 	{{- else }}
 		// unsupported type {{ .Type.Name }} for var {{ .VarName }}
-	{{- end }}
+	{{- end }}
diff --git a/http/codegen/templates/partial/request_elements.go.tpl b/http/codegen/templates/partial/request_elements.go.tpl
@@ -345,4 +345,4 @@ qp := r.URL.Query()
 		{{ .Validate }}
 	{{- end }}
 {{- end }}
-{{- end -}}
+{{- end }}
diff --git a/http/codegen/templates/partial/response.go.tpl b/http/codegen/templates/partial/response.go.tpl
@@ -116,4 +116,4 @@
 	{{- if .ErrorHeader }}
 	w.Header().Set("goa-error", res.GoaErrorName())
 	{{- end }}
-	w.WriteHeader({{ .StatusCode }})
+	w.WriteHeader({{ .StatusCode }})
diff --git a/http/codegen/templates/partial/single_response.go.tpl b/http/codegen/templates/partial/single_response.go.tpl
@@ -184,4 +184,4 @@
 				return nil, goahttp.ErrValidationError("{{ $.ServiceName }}", "{{ $.Method.Name }}", err)
 			}
 	{{- end }}
-{{- end }}
+{{- end }}
diff --git a/http/codegen/templates/partial/slice_item_conversion.go.tpl b/http/codegen/templates/partial/slice_item_conversion.go.tpl
@@ -60,4 +60,4 @@
 			{{ .VarName }}[i] = rv
 		{{- else }}
 			// unsupported slice type {{ .Type.ElemType.Type.Name }} for var {{ .VarName }}
-		{{- end }}
+		{{- end }}
diff --git a/http/codegen/templates/partial/websocket_upgrade.go.tpl b/http/codegen/templates/partial/websocket_upgrade.go.tpl
@@ -30,4 +30,4 @@
 	})
 	if err != nil {
 		return {{ if eq .Function "Recv" }}rv, {{ end }}err
-	}
+	}
diff --git a/http/codegen/templates/path.go.tpl b/http/codegen/templates/path.go.tpl
@@ -2,4 +2,4 @@
 func {{ .PathInit.Name }}({{ range .PathInit.ServerArgs }}{{ .VarName }} {{ .TypeRef }}, {{ end }}) {{ .PathInit.ReturnTypeRef }} {
 {{- .PathInit.ServerCode }}
 }
-{{ end }}
+{{ end }}
diff --git a/http/codegen/templates/path_init.go.tpl b/http/codegen/templates/path_init.go.tpl
@@ -15,4 +15,4 @@
 	{{- end }}, {{ end }})
 {{- else }}
 	return "{{ .PathFormat }}"
-{{- end }}
+{{- end -}}
diff --git a/http/codegen/templates/request_init.go.tpl b/http/codegen/templates/request_init.go.tpl
diff --git a/http/codegen/templates/response_decoder.go.tpl b/http/codegen/templates/response_decoder.go.tpl
diff --git a/http/codegen/templates/server_start.go.tpl b/http/codegen/templates/server_start.go.tpl

Original file line number	Diff line number	Diff line change
`@@ -10,4 +10,4 @@`
`10`	`10`	`m, _ := json.MarshalIndent(data, "", " ")`
`11`	`11`	`fmt.Println(string(m))`
`12`	`12`	`}`
`13`		`-}`
	`13`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -11,4 +11,4 @@ func main() {`
`11`	`11`	`timeoutF = flag.Int("timeout", 30, "Maximum number of seconds to wait for response")`
`12`	`12`	`)`
`13`	`13`	`flag.Usage = usage`
`14`		`- flag.Parse()`
	`14`	`+ flag.Parse()`
Original file line number	Diff line number	Diff line change
`@@ -51,4 +51,4 @@ var (`
`51`	`51`	`}`
`52`	`52`	`scheme = u.Scheme`
`53`	`53`	`host = u.Host`
`54`		`- }`
	`54`	`+ }`
Original file line number	Diff line number	Diff line change
`@@ -17,4 +17,4 @@`
`17`	`17`	`{{- end }}`
`18`	`18`	`{{- end }}`
`19`	`19`	`}`
`20`		`-{{- end }}`
	`20`	`+{{- end }}`
Original file line number	Diff line number	Diff line change
`@@ -16,4 +16,4 @@`
`16`	`16`	`{{- end }}`
`17`	`17`	`}`
`18`	`18`	`{{- end }}`
`19`		`-{{- end }}`
	`19`	`+{{- end }}`