feat(codegen): Insert comments in interfaces (#1458)

* feat(codegen): Insert comments in interfaces - Add docstring to interfaces to improve IDE method documentation * test: Update generated test code Co-authored-by: Stephane Bres <stephanejrbres@gmail.com>
sqlc-dev · Feb 28, 2022 · 72041b9 · 72041b9
1 parent 5842e84
commit 72041b9
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 0 deletions.
diff --git a/examples/ondeck/postgresql/querier.go b/examples/ondeck/postgresql/querier.go
diff --git a/internal/codegen/golang/templates/pgx/interfaceCode.tmpl b/internal/codegen/golang/templates/pgx/interfaceCode.tmpl
@@ -3,38 +3,66 @@
     {{- $dbtxParam := .EmitMethodsWithDBArgument -}}
     {{- range .GoQueries}}
         {{- if and (eq .Cmd ":one") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error)
         {{- else if eq .Cmd ":one" }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error)
         {{- end}}
         {{- if and (eq .Cmd ":many") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error)
         {{- else if eq .Cmd ":many" }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error)
         {{- end}}
         {{- if and (eq .Cmd ":exec") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) error
         {{- else if eq .Cmd ":exec" }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) error
         {{- end}}
         {{- if and (eq .Cmd ":execrows") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) (int64, error)
         {{- else if eq .Cmd ":execrows" }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) (int64, error)
         {{- end}}
         {{- if and (eq .Cmd ":execresult") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) (pgconn.CommandTag, error)
         {{- else if eq .Cmd ":execresult" }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) (pgconn.CommandTag, error)
         {{- end}}
         {{- if and (eq .Cmd ":copyfrom") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.SlicePair}}) (int64, error)
         {{- else if eq .Cmd ":copyfrom" }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.SlicePair}}) (int64, error)
         {{- end}}
         {{- if and (or (eq .Cmd ":batchexec") (eq .Cmd ":batchmany") (eq .Cmd ":batchone")) ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.SlicePair}}) *{{.MethodName}}BatchResults
         {{- else if or (eq .Cmd ":batchexec") (eq .Cmd ":batchmany") (eq .Cmd ":batchone") }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.SlicePair}}) *{{.MethodName}}BatchResults
         {{- end}}
 

diff --git a/internal/codegen/golang/templates/stdlib/interfaceCode.tmpl b/internal/codegen/golang/templates/stdlib/interfaceCode.tmpl
@@ -3,28 +3,48 @@
     {{- $dbtxParam := .EmitMethodsWithDBArgument -}}
     {{- range .GoQueries}}
         {{- if and (eq .Cmd ":one") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error)
         {{- else if eq .Cmd ":one"}}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ({{.Ret.DefineType}}, error)
         {{- end}}
         {{- if and (eq .Cmd ":many") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error)
         {{- else if eq .Cmd ":many"}}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) ([]{{.Ret.DefineType}}, error)
         {{- end}}
         {{- if and (eq .Cmd ":exec") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) error
         {{- else if eq .Cmd ":exec"}}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) error
         {{- end}}
         {{- if and (eq .Cmd ":execrows") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) (int64, error)
         {{- else if eq .Cmd ":execrows"}}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) (int64, error)
         {{- end}}
         {{- if and (eq .Cmd ":execresult") ($dbtxParam) }}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, db DBTX, {{.Arg.Pair}}) (sql.Result, error)
         {{- else if eq .Cmd ":execresult"}}
+            {{range .Comments}}//{{.}}
+            {{end -}}
             {{.MethodName}}(ctx context.Context, {{.Arg.Pair}}) (sql.Result, error)
         {{- end}}
     {{- end}}

diff --git a/internal/endtoend/testdata/copyfrom/postgresql/pgx/go/querier.go b/internal/endtoend/testdata/copyfrom/postgresql/pgx/go/querier.go