Skip to content

Commit c84379f

Browse files
andrewmbentonandrewmbenton
authored
refactor(codegen/golang): Pull opts into its own package (#2920)
1 parent 8e06874 commit c84379f

File tree

7 files changed

+24
-18
lines changed

7 files changed

+24
-18
lines changed

‎internal/codegen/golang/field.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@ import (
66
"sort"
77
"strings"
88

9+
"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
910
"github.com/sqlc-dev/sqlc/internal/plugin"
1011
)
1112

@@ -40,7 +41,7 @@ func TagsToString(tags map[string]string) string {
4041
return strings.Join(tagParts, " ")
4142
}
4243

43-
func JSONTagName(name string, options *opts) string {
44+
func JSONTagName(name string, options *opts.Options) string {
4445
style := options.JsonTagsCaseStyle
4546
idUppercase := options.JsonTagsIdUppercase
4647
if style == "" || style == "none" {

‎internal/codegen/golang/gen.go

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,7 @@ import (
1010
"strings"
1111
"text/template"
1212

13+
"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
1314
"github.com/sqlc-dev/sqlc/internal/codegen/sdk"
1415
"github.com/sqlc-dev/sqlc/internal/metadata"
1516
"github.com/sqlc-dev/sqlc/internal/plugin"
@@ -103,12 +104,12 @@ func (t *tmplCtx) codegenQueryRetval(q Query) (string, error) {
103104
}
104105

105106
func Generate(ctx context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenResponse, error) {
106-
options, err := parseOpts(req)
107+
options, err := opts.ParseOpts(req)
107108
if err != nil {
108109
return nil, err
109110
}
110111

111-
if err := validateOpts(options); err != nil {
112+
if err := opts.ValidateOpts(options); err != nil {
112113
return nil, err
113114
}
114115

@@ -126,7 +127,7 @@ func Generate(ctx context.Context, req *plugin.CodeGenRequest) (*plugin.CodeGenR
126127
return generate(req, options, enums, structs, queries)
127128
}
128129

129-
func generate(req *plugin.CodeGenRequest, options *opts, enums []Enum, structs []Struct, queries []Query) (*plugin.CodeGenResponse, error) {
130+
func generate(req *plugin.CodeGenRequest, options *opts.Options, enums []Enum, structs []Struct, queries []Query) (*plugin.CodeGenResponse, error) {
130131
i := &importer{
131132
Settings: req.Settings,
132133
Options: options,

‎internal/codegen/golang/go_type.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@ package golang
33
import (
44
"strings"
55

6+
"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
67
"github.com/sqlc-dev/sqlc/internal/codegen/sdk"
78
"github.com/sqlc-dev/sqlc/internal/plugin"
89
)
@@ -31,7 +32,7 @@ func addExtraGoStructTags(tags map[string]string, req *plugin.CodeGenRequest, co
3132
}
3233
}
3334

34-
func goType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) string {
35+
func goType(req *plugin.CodeGenRequest, options *opts.Options, col *plugin.Column) string {
3536
// Check if the column's type has been overridden
3637
for _, oride := range req.Settings.Overrides {
3738
if oride.GoType.TypeName == "" {
@@ -59,7 +60,7 @@ func goType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) strin
5960
return typ
6061
}
6162

62-
func goInnerType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) string {
63+
func goInnerType(req *plugin.CodeGenRequest, options *opts.Options, col *plugin.Column) string {
6364
columnType := sdk.DataType(col.Type)
6465
notNull := col.NotNull || col.IsArray
6566

‎internal/codegen/golang/imports.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55
"sort"
66
"strings"
77

8+
"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
89
"github.com/sqlc-dev/sqlc/internal/metadata"
910
"github.com/sqlc-dev/sqlc/internal/plugin"
1011
)
@@ -59,7 +60,7 @@ func mergeImports(imps ...fileImports) [][]ImportSpec {
5960

6061
type importer struct {
6162
Settings *plugin.Settings
62-
Options *opts
63+
Options *opts.Options
6364
Queries []Query
6465
Enums []Enum
6566
Structs []Struct
@@ -156,7 +157,7 @@ var pqtypeTypes = map[string]struct{}{
156157
"pqtype.NullRawMessage": {},
157158
}
158159

159-
func buildImports(settings *plugin.Settings, options *opts, queries []Query, uses func(string) bool) (map[string]struct{}, map[ImportSpec]struct{}) {
160+
func buildImports(settings *plugin.Settings, options *opts.Options, queries []Query, uses func(string) bool) (map[string]struct{}, map[ImportSpec]struct{}) {
160161
pkg := make(map[ImportSpec]struct{})
161162
std := make(map[string]struct{})
162163

‎internal/codegen/golang/opts.go renamed to ‎internal/codegen/golang/opts/options.go

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package golang
1+
package opts
22

33
import (
44
"bytes"
@@ -8,7 +8,7 @@ import (
88
"github.com/sqlc-dev/sqlc/internal/plugin"
99
)
1010

11-
type opts struct {
11+
type Options struct {
1212
EmitInterface bool `json:"emit_interface"`
1313
EmitJsonTags bool `json:"emit_json_tags"`
1414
JsonTagsIdUppercase bool `json:"json_tags_id_uppercase"`
@@ -44,8 +44,8 @@ type opts struct {
4444
Rename json.RawMessage `json:"rename,omitempty"`
4545
}
4646

47-
func parseOpts(req *plugin.CodeGenRequest) (*opts, error) {
48-
var options *opts
47+
func ParseOpts(req *plugin.CodeGenRequest) (*Options, error) {
48+
var options *Options
4949
dec := json.NewDecoder(bytes.NewReader(req.PluginOptions))
5050
dec.DisallowUnknownFields()
5151
if err := dec.Decode(&options); err != nil {
@@ -60,7 +60,7 @@ func parseOpts(req *plugin.CodeGenRequest) (*opts, error) {
6060
return options, nil
6161
}
6262

63-
func validateOpts(opts *opts) error {
63+
func ValidateOpts(opts *Options) error {
6464
if opts.EmitMethodsWithDbArgument && opts.EmitPreparedQueries {
6565
return fmt.Errorf("invalid options: emit_methods_with_db_argument and emit_prepared_queries options are mutually exclusive")
6666
}

‎internal/codegen/golang/postgresql_type.go

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@ import (
55
"log"
66
"strings"
77

8+
"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
89
"github.com/sqlc-dev/sqlc/internal/codegen/sdk"
910
"github.com/sqlc-dev/sqlc/internal/debug"
1011
"github.com/sqlc-dev/sqlc/internal/plugin"
@@ -33,7 +34,7 @@ func parseIdentifierString(name string) (*plugin.Identifier, error) {
3334
}
3435
}
3536

36-
func postgresType(req *plugin.CodeGenRequest, options *opts, col *plugin.Column) string {
37+
func postgresType(req *plugin.CodeGenRequest, options *opts.Options, col *plugin.Column) string {
3738
columnType := sdk.DataType(col.Type)
3839
notNull := col.NotNull || col.IsArray
3940
driver := parseDriver(options.SqlPackage)

‎internal/codegen/golang/result.go

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,13 +5,14 @@ import (
55
"sort"
66
"strings"
77

8+
"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
89
"github.com/sqlc-dev/sqlc/internal/codegen/sdk"
910
"github.com/sqlc-dev/sqlc/internal/inflection"
1011
"github.com/sqlc-dev/sqlc/internal/metadata"
1112
"github.com/sqlc-dev/sqlc/internal/plugin"
1213
)
1314

14-
func buildEnums(req *plugin.CodeGenRequest, options *opts) []Enum {
15+
func buildEnums(req *plugin.CodeGenRequest, options *opts.Options) []Enum {
1516
var enums []Enum
1617
for _, schema := range req.Catalog.Schemas {
1718
if schema.Name == "pg_catalog" || schema.Name == "information_schema" {
@@ -58,7 +59,7 @@ func buildEnums(req *plugin.CodeGenRequest, options *opts) []Enum {
5859
return enums
5960
}
6061

61-
func buildStructs(req *plugin.CodeGenRequest, options *opts) []Struct {
62+
func buildStructs(req *plugin.CodeGenRequest, options *opts.Options) []Struct {
6263
var structs []Struct
6364
for _, schema := range req.Catalog.Schemas {
6465
if schema.Name == "pg_catalog" || schema.Name == "information_schema" {
@@ -181,7 +182,7 @@ func argName(name string) string {
181182
return out
182183
}
183184

184-
func buildQueries(req *plugin.CodeGenRequest, options *opts, structs []Struct) ([]Query, error) {
185+
func buildQueries(req *plugin.CodeGenRequest, options *opts.Options, structs []Struct) ([]Query, error) {
185186
qs := make([]Query, 0, len(req.Queries))
186187
for _, query := range req.Queries {
187188
if query.Name == "" {
@@ -331,7 +332,7 @@ func putOutColumns(query *plugin.Query) bool {
331332
// JSON tags: count, count_2, count_2
332333
//
333334
// This is unlikely to happen, so don't fix it yet
334-
func columnsToStruct(req *plugin.CodeGenRequest, options *opts, name string, columns []goColumn, useID bool) (*Struct, error) {
335+
func columnsToStruct(req *plugin.CodeGenRequest, options *opts.Options, name string, columns []goColumn, useID bool) (*Struct, error) {
335336
gs := Struct{
336337
Name: name,
337338
}

0 commit comments

Comments
 (0)