Restore multiline resolver doc comments after #3243 (#3428)

StevenACoffman · web-flow · commit 53e39c6dfd17 · 2024-12-10T10:19:21.000-05:00
Signed-off-by: Steve Coffman &lt;steve@khanacademy.org&gt;
diff --git a/plugin/resolvergen/resolver.go b/plugin/resolvergen/resolver.go
@@ -159,6 +159,7 @@ func (m *Plugin) generatePerSchema(data *codegen.Data) error {
 				continue
 			}
 			structName := templates.LcFirst(o.Name) + templates.UcFirst(data.Config.Resolver.Type)
+			// TODO(steve): Why do we need to trimLeft "\" here? Some bazel thing?
 			comment := strings.TrimSpace(strings.TrimLeft(rewriter.GetMethodComment(structName, f.GoFieldName), `\`))
 			implementation := strings.TrimSpace(rewriter.GetMethodBody(structName, f.GoFieldName))
 			resolver := Resolver{o, f, rewriter.GetPrevDecl(structName, f.GoFieldName), comment, implementation, nil}
diff --git a/plugin/resolvergen/resolver.gotpl b/plugin/resolvergen/resolver.gotpl
@@ -20,7 +20,7 @@
 
 {{ range $resolver := .Resolvers -}}
 	{{ if $resolver.Comment -}}
-		// {{ $resolver.Comment }}
+		{{with $resolver.Comment}}{{.|prefixLines "// "}}{{end}}
 	{{- else if not $.OmitTemplateComment -}}
 		// {{ $resolver.Field.GoFieldName }} is the resolver for the {{ $resolver.Field.Name }} field.
 	{{- end }}
diff --git a/plugin/resolvergen/testdata/followschema/out/schema.resolvers.go b/plugin/resolvergen/testdata/followschema/out/schema.resolvers.go
diff --git a/plugin/resolvergen/testdata/followschema/out/schema.resolvers.go.txt b/plugin/resolvergen/testdata/followschema/out/schema.resolvers.go.txt
@@ -17,6 +17,7 @@ func (r *queryCustomResolverType) Resolver(ctx context.Context) (_ *customresolv
 }
 
 // Name is the resolver for the name field.
+// This comment is multiline method doc
 func (r *resolverCustomResolverType) Name(ctx context.Context, obj *customresolver.Resolver) (string, error) {
 	// CustomerResolverType.Name implementation
 	return "", nil
@@ -26,6 +27,7 @@ func (r *resolverCustomResolverType) Name(ctx context.Context, obj *customresolv
 func (r *CustomResolverType) Query() customresolver.QueryResolver { return &queryCustomResolverType{r} }
 
 // Resolver returns customresolver.ResolverResolver implementation.
+// This comment is multiline method doc
 func (r *CustomResolverType) Resolver() customresolver.ResolverResolver {
 	return &resolverCustomResolverType{r}
 }
diff --git a/plugin/resolvergen/testdata/resolvertemplate/customResolverTemplate.gotpl b/plugin/resolvergen/testdata/resolvertemplate/customResolverTemplate.gotpl
@@ -21,7 +21,7 @@
 
 {{ range $resolver := .Resolvers -}}
 	{{ if $resolver.Comment -}}
-		// {{ $resolver.Comment }}
+		{{with $resolver.Comment}}{{.|prefixLines "// "}}{{end}}
 	{{- else if not $.OmitTemplateComment -}}
 		// {{ $resolver.Field.GoFieldName }} is the resolver for the {{ $resolver.Field.Name }} field.
 	{{- end }}

Original file line number	Diff line number	Diff line change
`@@ -159,6 +159,7 @@ func (m Plugin) generatePerSchema(data codegen.Data) error {`
`159`	`159`	`continue`
`160`	`160`	`}`
`161`	`161`	`structName := templates.LcFirst(o.Name) + templates.UcFirst(data.Config.Resolver.Type)`
	`162`	`+ // TODO(steve): Why do we need to trimLeft "\" here? Some bazel thing?`
`162`	`163`	comment := strings.TrimSpace(strings.TrimLeft(rewriter.GetMethodComment(structName, f.GoFieldName), `\`))
`163`	`164`	`implementation := strings.TrimSpace(rewriter.GetMethodBody(structName, f.GoFieldName))`
`164`	`165`	`resolver := Resolver{o, f, rewriter.GetPrevDecl(structName, f.GoFieldName), comment, implementation, nil}`
Original file line number	Diff line number	Diff line change
`@@ -17,6 +17,7 @@ func (r queryCustomResolverType) Resolver(ctx context.Context) (_ customresolv`
`17`	`17`	`}`
`18`	`18`
`19`	`19`	`// Name is the resolver for the name field.`
	`20`	`+// This comment is multiline method doc`
`20`	`21`	`func (r resolverCustomResolverType) Name(ctx context.Context, obj customresolver.Resolver) (string, error) {`
`21`	`22`	`// CustomerResolverType.Name implementation`
`22`	`23`	`return "", nil`
`@@ -26,6 +27,7 @@ func (r resolverCustomResolverType) Name(ctx context.Context, obj customresolv`
`26`	`27`	`func (r *CustomResolverType) Query() customresolver.QueryResolver { return &queryCustomResolverType{r} }`
`27`	`28`
`28`	`29`	`// Resolver returns customresolver.ResolverResolver implementation.`
	`30`	`+// This comment is multiline method doc`
`29`	`31`	`func (r *CustomResolverType) Resolver() customresolver.ResolverResolver {`
`30`	`32`	`return &resolverCustomResolverType{r}`
`31`	`33`	`}`