Implement rename_enum option (Fix #2129)

heyvito · heyvito · commit 98c952d638d5 · 2025-11-07T14:41:59.000-03:00
diff --git a/internal/codegen/golang/enum.go b/internal/codegen/golang/enum.go
@@ -3,6 +3,8 @@ package golang
 import (
 	"strings"
 	"unicode"
+
+	"github.com/sqlc-dev/sqlc/internal/codegen/golang/opts"
 )
 
 type Constant struct {
@@ -47,16 +49,27 @@ func EnumReplace(value string) string {
 
 // EnumValueName removes all non ident symbols (all but letters, numbers and
 // underscore) and converts snake case ident to camel case.
-func EnumValueName(value string) string {
+func EnumValueName(value string, options *opts.Options) string {
+	if rename := options.RenameEnum[value]; rename != "" {
+		return rename
+	}
 	parts := strings.Split(EnumReplace(value), "_")
 	for i, part := range parts {
+		if _, found := options.InitialismsMap[part]; found {
+			parts[i] = strings.ToUpper(part)
+			continue
+		}
 		parts[i] = titleFirst(part)
 	}
 
 	return strings.Join(parts, "")
 }
 
 func titleFirst(s string) string {
+	if len(s) == 0 {
+		return s
+	}
+
 	r := []rune(s)
 	r[0] = unicode.ToUpper(r[0])
 
diff --git a/internal/codegen/golang/opts/options.go b/internal/codegen/golang/opts/options.go
@@ -30,6 +30,7 @@ type Options struct {
 	Out                         string            `json:"out" yaml:"out"`
 	Overrides                   []Override        `json:"overrides,omitempty" yaml:"overrides"`
 	Rename                      map[string]string `json:"rename,omitempty" yaml:"rename"`
+	RenameEnum                  map[string]string `json:"rename_enum,omitempty" yaml:"rename_enum"`
 	SqlPackage                  string            `json:"sql_package" yaml:"sql_package"`
 	SqlDriver                   string            `json:"sql_driver" yaml:"sql_driver"`
 	OutputBatchFileName         string            `json:"output_batch_file_name,omitempty" yaml:"output_batch_file_name"`
@@ -50,8 +51,9 @@ type Options struct {
 }
 
 type GlobalOptions struct {
-	Overrides []Override        `json:"overrides,omitempty" yaml:"overrides"`
-	Rename    map[string]string `json:"rename,omitempty" yaml:"rename"`
+	Overrides  []Override        `json:"overrides,omitempty" yaml:"overrides"`
+	Rename     map[string]string `json:"rename,omitempty" yaml:"rename"`
+	RenameEnum map[string]string `json:"rename_enum,omitempty" yaml:"rename_enum"`
 }
 
 func Parse(req *plugin.GenerateRequest) (*Options, error) {
@@ -72,6 +74,12 @@ func Parse(req *plugin.GenerateRequest) (*Options, error) {
 		}
 		maps.Copy(options.Rename, global.Rename)
 	}
+	if len(global.RenameEnum) > 0 {
+		if options.RenameEnum == nil {
+			options.RenameEnum = map[string]string{}
+		}
+		maps.Copy(options.RenameEnum, global.RenameEnum)
+	}
 	return options, nil
 }
 
diff --git a/internal/codegen/golang/result.go b/internal/codegen/golang/result.go
@@ -45,7 +45,7 @@ func buildEnums(req *plugin.GenerateRequest, options *opts.Options) []Enum {
 					value = fmt.Sprintf("value_%d", i)
 				}
 				e.Constants = append(e.Constants, Constant{
-					Name:  StructName(enumName+"_"+value, options),
+					Name:  EnumValueName(enumName+"_"+value, options),
 					Value: v,
 					Type:  e.Name,
 				})
diff --git a/internal/config/v_one.go b/internal/config/v_one.go
@@ -11,12 +11,13 @@ import (
 )
 
 type V1GenerateSettings struct {
-	Version   string              `json:"version" yaml:"version"`
-	Cloud     Cloud               `json:"cloud" yaml:"cloud"`
-	Packages  []v1PackageSettings `json:"packages" yaml:"packages"`
-	Overrides []golang.Override   `json:"overrides,omitempty" yaml:"overrides,omitempty"`
-	Rename    map[string]string   `json:"rename,omitempty" yaml:"rename,omitempty"`
-	Rules     []Rule              `json:"rules" yaml:"rules"`
+	Version    string              `json:"version" yaml:"version"`
+	Cloud      Cloud               `json:"cloud" yaml:"cloud"`
+	Packages   []v1PackageSettings `json:"packages" yaml:"packages"`
+	Overrides  []golang.Override   `json:"overrides,omitempty" yaml:"overrides,omitempty"`
+	Rename     map[string]string   `json:"rename,omitempty" yaml:"rename,omitempty"`
+	RenameEnum map[string]string   `json:"rename_enum,omitempty" yaml:"rename_enum,omitempty"`
+	Rules      []Rule              `json:"rules" yaml:"rules"`
 }
 
 type v1PackageSettings struct {
@@ -175,10 +176,11 @@ func (c *V1GenerateSettings) Translate() Config {
 		})
 	}
 
-	if len(c.Overrides) > 0 || len(c.Rename) > 0 {
+	if len(c.Overrides) > 0 || len(c.Rename) > 0 || len(c.RenameEnum) > 0 {
 		conf.Overrides.Go = &golang.GlobalOptions{
-			Overrides: c.Overrides,
-			Rename:    c.Rename,
+			Overrides:  c.Overrides,
+			Rename:     c.Rename,
+			RenameEnum: c.RenameEnum,
 		}
 	}
 
diff --git a/internal/config/v_two.json b/internal/config/v_two.json
@@ -227,6 +227,14 @@
                                         }
                                     }
                                 },
+                                "rename_enum": {
+                                  "type": "object",
+                                  "patternProperties": {
+                                    ".*": {
+                                      "type": "string"
+                                    }
+                                  }
+                                },
                                 "sql_package": {
                                     "type": "string"
                                 },
diff --git a/internal/endtoend/testdata/emit_enum_valid_and_values/sqlc.json b/internal/endtoend/testdata/emit_enum_valid_and_values/sqlc.json
@@ -16,7 +16,9 @@
     "id_old": "IDNew",
     "bar_old": "BarNew",
     "foo_old": "FooNew",
-    "ip_protocol": "IPProtocol",
+    "ip_protocol": "IPProtocol"
+  },
+  "rename_enum": {
     "ip_protocol_tcp": "IPProtocolTCP"
   }
 }
diff --git a/internal/endtoend/testdata/rename/v1/pgx/v4/sqlc.json b/internal/endtoend/testdata/rename/v1/pgx/v4/sqlc.json
@@ -14,7 +14,9 @@
     "id_old": "IDNew",
     "bar_old": "BarNew",
     "foo_old": "FooNew",
-    "ip_protocol": "IPProtocol",
+    "ip_protocol": "IPProtocol"
+  },
+  "rename_enum": {
     "ip_protocol_tcp": "IPProtocolTCP"
   }
 }
diff --git a/internal/endtoend/testdata/rename/v1/pgx/v5/sqlc.json b/internal/endtoend/testdata/rename/v1/pgx/v5/sqlc.json
@@ -14,7 +14,9 @@
     "id_old": "IDNew",
     "bar_old": "BarNew",
     "foo_old": "FooNew",
-    "ip_protocol": "IPProtocol",
+    "ip_protocol": "IPProtocol"
+  },
+  "rename_enum": {
     "ip_protocol_tcp": "IPProtocolTCP"
   }
 }
diff --git a/internal/endtoend/testdata/rename/v1/stdlib/sqlc.json b/internal/endtoend/testdata/rename/v1/stdlib/sqlc.json
@@ -12,7 +12,9 @@
     "id_old": "IDNew",
     "bar_old": "BarNew",
     "foo_old": "FooNew",
-    "ip_protocol": "IPProtocol",
+    "ip_protocol": "IPProtocol"
+  },
+  "rename_enum": {
     "ip_protocol_tcp": "IPProtocolTCP"
   }
 }
diff --git a/internal/endtoend/testdata/rename/v2/pgx/v4/sqlc.json b/internal/endtoend/testdata/rename/v2/pgx/v4/sqlc.json
@@ -14,7 +14,9 @@
             "id_old": "IDNew",
             "bar_old": "BarNew",
             "foo_old": "FooNew",
-            "ip_protocol": "IPProtocol",
+            "ip_protocol": "IPProtocol"
+          },
+          "rename_enum": {
             "ip_protocol_tcp": "IPProtocolTCP"
           }
         }
diff --git a/internal/endtoend/testdata/rename/v2/pgx/v5/sqlc.json b/internal/endtoend/testdata/rename/v2/pgx/v5/sqlc.json
@@ -14,7 +14,9 @@
             "id_old": "IDNew",
             "bar_old": "BarNew",
             "foo_old": "FooNew",
-            "ip_protocol": "IPProtocol",
+            "ip_protocol": "IPProtocol"
+          },
+          "rename_enum": {
             "ip_protocol_tcp": "IPProtocolTCP"
           }
         }
diff --git a/internal/endtoend/testdata/rename/v2/stdlib/sqlc.json b/internal/endtoend/testdata/rename/v2/stdlib/sqlc.json
@@ -13,7 +13,9 @@
             "id_old": "IDNew",
             "bar_old": "BarNew",
             "foo_old": "FooNew",
-            "ip_protocol": "IPProtocol",
+            "ip_protocol": "IPProtocol"
+          },
+          "rename_enum": {
             "ip_protocol_tcp": "IPProtocolTCP"
           }
         }

Original file line number	Diff line number	Diff line change
`@@ -30,6 +30,7 @@ type Options struct {`
`30`	`30`	Out string `json:"out" yaml:"out"`
`31`	`31`	Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
`32`	`32`	Rename map[string]string `json:"rename,omitempty" yaml:"rename"`
	`33`	+ RenameEnum map[string]string `json:"rename_enum,omitempty" yaml:"rename_enum"`
`33`	`34`	SqlPackage string `json:"sql_package" yaml:"sql_package"`
`34`	`35`	SqlDriver string `json:"sql_driver" yaml:"sql_driver"`
`35`	`36`	OutputBatchFileName string `json:"output_batch_file_name,omitempty" yaml:"output_batch_file_name"`
`@@ -50,8 +51,9 @@ type Options struct {`
`50`	`51`	`}`
`51`	`52`
`52`	`53`	`type GlobalOptions struct {`
`53`		- Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
`54`		- Rename map[string]string `json:"rename,omitempty" yaml:"rename"`
	`54`	+ Overrides []Override `json:"overrides,omitempty" yaml:"overrides"`
	`55`	+ Rename map[string]string `json:"rename,omitempty" yaml:"rename"`
	`56`	+ RenameEnum map[string]string `json:"rename_enum,omitempty" yaml:"rename_enum"`
`55`	`57`	`}`
`56`	`58`
`57`	`59`	`func Parse(req plugin.GenerateRequest) (Options, error) {`
`@@ -72,6 +74,12 @@ func Parse(req plugin.GenerateRequest) (Options, error) {`
`72`	`74`	`}`
`73`	`75`	`maps.Copy(options.Rename, global.Rename)`
`74`	`76`	`}`
	`77`	`+ if len(global.RenameEnum) > 0 {`
	`78`	`+ if options.RenameEnum == nil {`
	`79`	`+ options.RenameEnum = map[string]string{}`
	`80`	`+ }`
	`81`	`+ maps.Copy(options.RenameEnum, global.RenameEnum)`
	`82`	`+ }`
`75`	`83`	`return options, nil`
`76`	`84`	`}`
`77`	`85`
Original file line number	Diff line number	Diff line change
`@@ -45,7 +45,7 @@ func buildEnums(req plugin.GenerateRequest, options opts.Options) []Enum {`
`45`	`45`	`value = fmt.Sprintf("value_%d", i)`
`46`	`46`	`}`
`47`	`47`	`e.Constants = append(e.Constants, Constant{`
`48`		`- Name: StructName(enumName+"_"+value, options),`
	`48`	`+ Name: EnumValueName(enumName+"_"+value, options),`
`49`	`49`	`Value: v,`
`50`	`50`	`Type: e.Name,`
`51`	`51`	`})`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,9 @@`
`16`	`16`	`"id_old": "IDNew",`
`17`	`17`	`"bar_old": "BarNew",`
`18`	`18`	`"foo_old": "FooNew",`
`19`		`- "ip_protocol": "IPProtocol",`
	`19`	`+ "ip_protocol": "IPProtocol"`
	`20`	`+ },`
	`21`	`+ "rename_enum": {`
`20`	`22`	`"ip_protocol_tcp": "IPProtocolTCP"`
`21`	`23`	`}`
`22`	`24`	`}`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,9 @@`
`14`	`14`	`"id_old": "IDNew",`
`15`	`15`	`"bar_old": "BarNew",`
`16`	`16`	`"foo_old": "FooNew",`
`17`		`- "ip_protocol": "IPProtocol",`
	`17`	`+ "ip_protocol": "IPProtocol"`
	`18`	`+ },`
	`19`	`+ "rename_enum": {`
`18`	`20`	`"ip_protocol_tcp": "IPProtocolTCP"`
`19`	`21`	`}`
`20`	`22`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,9 @@`
`12`	`12`	`"id_old": "IDNew",`
`13`	`13`	`"bar_old": "BarNew",`
`14`	`14`	`"foo_old": "FooNew",`
`15`		`- "ip_protocol": "IPProtocol",`
	`15`	`+ "ip_protocol": "IPProtocol"`
	`16`	`+ },`
	`17`	`+ "rename_enum": {`
`16`	`18`	`"ip_protocol_tcp": "IPProtocolTCP"`
`17`	`19`	`}`
`18`	`20`	`}`