Add emit_sql_as_comment option to Go code plugin

This option adds the raw SQL query as a comment to the generated query function

This is useful when working in an IDE that displays comments over functions, you are able to glance at the actual SQL query that will be executed without having to lose context of where you are in the current file you are working on.

Author: jasoncabot

internal/cmd/shim.go

@@ -109,6 +109,7 @@ func pluginGoCode(s config.SQLGo) *plugin.GoCode {
 		InflectionExcludeTableNames: s.InflectionExcludeTableNames,
 		QueryParameterLimit:         s.QueryParameterLimit,
 		OmitUnusedStructs:           s.OmitUnusedStructs,
+		EmitSqlAsComment:            s.EmitSqlAsComment,
 	}
 }
 

internal/codegen/golang/result.go

@@ -198,14 +198,25 @@ func buildQueries(req *plugin.CodeGenRequest, structs []Struct) ([]Query, error)
 			constantName = sdk.LowerTitle(query.Name)
 		}
 
+		comments := query.Comments
+		if req.Settings.Go.EmitSqlAsComment {
+			if len(comments) == 0 {
+				comments = append(comments, query.Name)
+			}
+			comments = append(comments, " ")
+			for _, line := range strings.Split(query.Text, "\n") {
+				comments = append(comments, "  "+line)
+			}
+		}
+
 		gq := Query{
 			Cmd:          query.Cmd,
 			ConstantName: constantName,
 			FieldName:    sdk.LowerTitle(query.Name) + "Stmt",
 			MethodName:   query.Name,
 			SourceName:   query.Filename,
 			SQL:          query.Text,
-			Comments:     query.Comments,
+			Comments:     comments,
 			Table:        query.InsertIntoTable,
 		}
 		sqlpkg := parseDriver(req.Settings.Go.SqlPackage)

internal/config/config.go

@@ -159,6 +159,7 @@ type SQLGo struct {
 	InflectionExcludeTableNames []string          `json:"inflection_exclude_table_names,omitempty" yaml:"inflection_exclude_table_names"`
 	QueryParameterLimit         *int32            `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
 	OmitUnusedStructs           bool              `json:"omit_unused_structs,omitempty" yaml:"omit_unused_structs"`
+	EmitSqlAsComment            bool              `json:"emit_sql_as_comment,omitempty" yaml:"emit_sql_as_comment"`
 }
 
 type SQLJSON struct {

internal/config/v_one.go

@@ -52,6 +52,7 @@ type v1PackageSettings struct {
 	StrictOrderBy             *bool      `json:"strict_order_by" yaml:"strict_order_by"`
 	QueryParameterLimit       *int32     `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
 	OmitUnusedStructs         bool       `json:"omit_unused_structs,omitempty" yaml:"omit_unused_structs"`
+	EmitSqlAsComment          bool       `json:"emit_sql_as_comment,omitempty" yaml:"emit_sql_as_comment"`
 	Rules                     []string   `json:"rules" yaml:"rules"`
 }
 
@@ -176,6 +177,7 @@ func (c *V1GenerateSettings) Translate() Config {
 					OutputFilesSuffix:         pkg.OutputFilesSuffix,
 					QueryParameterLimit:       pkg.QueryParameterLimit,
 					OmitUnusedStructs:         pkg.OmitUnusedStructs,
+					EmitSqlAsComment:          pkg.EmitSqlAsComment,
 				},
 			},
 			StrictFunctionChecks: pkg.StrictFunctionChecks,

internal/endtoend/testdata/codegen_json/gen/codegen.json

@@ -42,7 +42,8 @@
       "query_parameter_limit": 1,
       "output_batch_file_name": "",
       "json_tags_id_uppercase": false,
-      "omit_unused_structs": false
+      "omit_unused_structs": false,
+      "emit_sql_as_comment": false
     },
     "json": {
       "out": "gen",

internal/endtoend/testdata/emit_sql_as_comment/stdlib/go/db.go

@@ -0,0 +1,10 @@
+CREATE TABLE bar (id serial not null);
+
+-- name: ListBar :many
+-- Lists all bars
+SELECT id FROM (
+  SELECT * FROM bar
+) bar;
+
+-- name: RemoveBar :exec
+DELETE FROM bar WHERE id = $1;

internal/endtoend/testdata/emit_sql_as_comment/stdlib/go/models.go

@@ -0,0 +1,12 @@
+{
+  "version": "1",
+  "packages": [
+    {
+      "path": "go",
+      "name": "querytest",
+      "schema": "query.sql",
+      "queries": "query.sql",
+      "emit_sql_as_comment": true
+    }
+  ]
+}