feat(codegen): Support setting Go build tags (#2012) (#2807)

* feat(codegen): add support for build tags (#2012)

* Update docs/reference/config.md

* Update internal/codegen/golang/gen.go

---------

Co-authored-by: Kyle Gray <kyle@conroy.org>

Author: Hyuga-Tsukui

docs/reference/config.md

@@ -146,6 +146,8 @@ The `gen` mapping supports the following keys:
 - `emit_all_enum_values`:
   - If true, emit a function per enum type
     that returns all valid enum values.
+- `build_tags`:
+  - If set, add a `//go:build <build_tags>` directive at the beginning of each generated Go file.
 - `json_tags_id_uppercase`:
   - If true, "Id" in json tags will be uppercase. If false, will be camelcase. Defaults to `false`
 - `json_tags_case_style`:
@@ -389,6 +391,7 @@ packages:
     emit_pointers_for_null_types: false
     emit_enum_valid_method: false
     emit_all_enum_values: false
+    build_tags: "some_tag"
     json_tags_case_style: "camel"
     omit_unused_structs: false
     output_batch_file_name: "batch.go"
@@ -443,6 +446,8 @@ Each mapping in the `packages` collection has the following keys:
 - `emit_all_enum_values`:
   - If true, emit a function per enum type
     that returns all valid enum values.
+- `build_tags`:
+  - If set, add a `//go:build <build_tags>` directive at the beginning of each generated Go file.
 - `json_tags_case_style`:
   - `camel` for camelCase, `pascal` for PascalCase, `snake` for snake_case or `none` to use the column name in the DB. Defaults to `none`.
 - `omit_unused_structs`:

internal/cmd/shim.go

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

internal/codegen/golang/gen.go

@@ -38,6 +38,7 @@ type tmplCtx struct {
 	EmitAllEnumValues         bool
 	UsesCopyFrom              bool
 	UsesBatch                 bool
+	BuildTags                 string
 }
 
 func (t *tmplCtx) OutputQuery(sourceName string) bool {
@@ -143,6 +144,7 @@ func generate(req *plugin.CodeGenRequest, enums []Enum, structs []Struct, querie
 		Enums:                     enums,
 		Structs:                   structs,
 		SqlcVersion:               req.SqlcVersion,
+		BuildTags:                 golang.BuildTags,
 	}
 
 	if tctx.UsesCopyFrom && !tctx.SQLDriver.IsPGX() && golang.SqlDriver != SQLDriverGoSQLDriverMySQL {

internal/codegen/golang/templates/template.tmpl

@@ -1,4 +1,8 @@
-{{define "dbFile"}}// Code generated by sqlc. DO NOT EDIT.
+{{define "dbFile"}}
+{{if .BuildTags}}
+//go:build {{.BuildTags}}
+
+{{end}}// Code generated by sqlc. DO NOT EDIT.
 // versions:
 //   sqlc {{.SqlcVersion}}
 
@@ -24,7 +28,11 @@ import (
 
 {{end}}
 
-{{define "interfaceFile"}}// Code generated by sqlc. DO NOT EDIT.
+{{define "interfaceFile"}}
+{{if .BuildTags}}
+//go:build {{.BuildTags}}
+
+{{end}}// Code generated by sqlc. DO NOT EDIT.
 // versions:
 //   sqlc {{.SqlcVersion}}
 
@@ -48,7 +56,11 @@ import (
 	{{end}}
 {{end}}
 
-{{define "modelsFile"}}// Code generated by sqlc. DO NOT EDIT.
+{{define "modelsFile"}}
+{{if .BuildTags}}
+//go:build {{.BuildTags}}
+
+{{end}}// Code generated by sqlc. DO NOT EDIT.
 // versions:
 //   sqlc {{.SqlcVersion}}
 
@@ -141,7 +153,11 @@ type {{.Name}} struct { {{- range .Fields}}
 {{end}}
 {{end}}
 
-{{define "queryFile"}}// Code generated by sqlc. DO NOT EDIT.
+{{define "queryFile"}}
+{{if .BuildTags}}
+//go:build {{.BuildTags}}
+
+{{end}}// Code generated by sqlc. DO NOT EDIT.
 // versions:
 //   sqlc {{.SqlcVersion}}
 // source: {{.SourceName}}
@@ -166,7 +182,11 @@ import (
 {{end}}
 {{end}}
 
-{{define "copyfromFile"}}// Code generated by sqlc. DO NOT EDIT.
+{{define "copyfromFile"}}
+{{if .BuildTags}}
+//go:build {{.BuildTags}}
+
+{{end}}// Code generated by sqlc. DO NOT EDIT.
 // versions:
 //   sqlc {{.SqlcVersion}}
 // source: {{.SourceName}}
@@ -191,7 +211,11 @@ import (
 {{end}}
 {{end}}
 
-{{define "batchFile"}}// Code generated by sqlc. DO NOT EDIT.
+{{define "batchFile"}}
+{{if .BuildTags}}
+//go:build {{.BuildTags}}
+
+{{end}}// Code generated by sqlc. DO NOT EDIT.
 // versions:
 //   sqlc {{.SqlcVersion}}
 // source: {{.SourceName}}

internal/config/config.go

@@ -156,6 +156,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"`
+	BuildTags                   string            `json:"build_tags,omitempty" yaml:"build_tags"`
 }
 
 type SQLJSON struct {

internal/config/v_one.go

@@ -53,6 +53,7 @@ type v1PackageSettings struct {
 	QueryParameterLimit       *int32     `json:"query_parameter_limit,omitempty" yaml:"query_parameter_limit"`
 	OmitUnusedStructs         bool       `json:"omit_unused_structs,omitempty" yaml:"omit_unused_structs"`
 	Rules                     []string   `json:"rules" yaml:"rules"`
+	BuildTags                 string     `json:"build_tags,omitempty" yaml:"build_tags"`
 }
 
 func v1ParseConfig(rd io.Reader) (Config, error) {
@@ -176,6 +177,7 @@ func (c *V1GenerateSettings) Translate() Config {
 					OutputFilesSuffix:         pkg.OutputFilesSuffix,
 					QueryParameterLimit:       pkg.QueryParameterLimit,
 					OmitUnusedStructs:         pkg.OmitUnusedStructs,
+					BuildTags:                 pkg.BuildTags,
 				},
 			},
 			StrictFunctionChecks: pkg.StrictFunctionChecks,

internal/config/v_one.json

@@ -123,6 +123,9 @@
                     "emit_all_enum_values": {
                         "type": "boolean"
                     },
+                    "build_tags": {
+                        "type": "string"
+                    },
                     "json_tags_case_style": {
                         "type": "string"
                     },

internal/config/v_two.json

@@ -129,6 +129,9 @@
                                     "emit_all_enum_values": {
                                         "type": "boolean"
                                     },
+                                    "build_tags": {
+                                        "type": "string"
+                                    },
                                     "json_tags_case_style": {
                                         "type": "string"
                                     },