feat(golang): Add intialisms configuration

sqlc-dev · kyleconroy · Apr 2, 2024 · Apr 1, 2024 · Apr 1, 2024 · Apr 1, 2024
commit 96af586fc76ac9c4a012f237a32f01bd4ed6b5ca
diff --git a/internal/codegen/golang/opts/options.go b/internal/codegen/golang/opts/options.go
@@ -43,6 +43,9 @@ type Options struct {
 	OmitSqlcVersion             bool              `json:"omit_sqlc_version,omitempty" yaml:"omit_sqlc_version"`
 	OmitUnusedStructs           bool              `json:"omit_unused_structs,omitempty" yaml:"omit_unused_structs"`
 	BuildTags                   string            `json:"build_tags,omitempty" yaml:"build_tags"`
+	Initialisms                 *[]string         `json:"initialisms,omitempty" yaml:"initialisms"`
+
+	InitialismsMap map[string]struct{} `json:"-" yaml:"-"`
 }
 
 type GlobalOptions struct {
@@ -111,6 +114,16 @@ func parseOpts(req *plugin.GenerateRequest) (*Options, error) {
 		*options.QueryParameterLimit = 1
 	}
 
+	if options.Initialisms == nil {
+		options.Initialisms = new([]string)
+		*options.Initialisms = []string{"id"}
+	}
+
+	options.InitialismsMap = map[string]struct{}{}
+	for _, initial := range *options.Initialisms {
+		options.InitialismsMap[initial] = struct{}{}
+	}
+
 	return &options, nil
 }
 

diff --git a/internal/codegen/golang/struct.go b/internal/codegen/golang/struct.go
@@ -32,8 +32,8 @@ func StructName(name string, options *opts.Options) string {
 	}, name)
 
 	for _, p := range strings.Split(name, "_") {
-		if p == "id" {
-			out += "ID"
+		if _, found := options.InitialismsMap[p]; found {
+			out += strings.ToUpper(p)
 		} else {
 			out += strings.Title(p)
 		}

diff --git a/internal/endtoend/testdata/golang_intialisms_empty/db/db.go b/internal/endtoend/testdata/golang_intialisms_empty/db/db.go
diff --git a/internal/endtoend/testdata/golang_intialisms_empty/db/models.go b/internal/endtoend/testdata/golang_intialisms_empty/db/models.go
diff --git a/internal/endtoend/testdata/golang_intialisms_empty/db/query.sql.go b/internal/endtoend/testdata/golang_intialisms_empty/db/query.sql.go
diff --git a/internal/endtoend/testdata/golang_intialisms_empty/query.sql b/internal/endtoend/testdata/golang_intialisms_empty/query.sql
@@ -0,0 +1,2 @@
+-- name: SelectFoo :many
+SELECT * FROM foo;
diff --git a/internal/endtoend/testdata/golang_intialisms_empty/schema.sql b/internal/endtoend/testdata/golang_intialisms_empty/schema.sql
@@ -0,0 +1,3 @@
+CREATE TABLE foo(
+        bar_id text
+);
diff --git a/internal/endtoend/testdata/golang_intialisms_empty/sqlc.json b/internal/endtoend/testdata/golang_intialisms_empty/sqlc.json
@@ -0,0 +1,16 @@
+{
+    "version": "2",
+    "sql": [
+        {
+            "schema": "schema.sql",
+            "queries": "query.sql",
+            "engine": "postgresql",
+            "gen": {
+                "go": {
+                    "out": "db",
+                    "initialisms": []
+                }
+            }
+        }
+    ]
+}
diff --git a/internal/endtoend/testdata/golang_intialisms_url/db/db.go b/internal/endtoend/testdata/golang_intialisms_url/db/db.go
diff --git a/internal/endtoend/testdata/golang_intialisms_url/db/models.go b/internal/endtoend/testdata/golang_intialisms_url/db/models.go
diff --git a/internal/endtoend/testdata/golang_intialisms_url/db/query.sql.go b/internal/endtoend/testdata/golang_intialisms_url/db/query.sql.go
diff --git a/internal/endtoend/testdata/golang_intialisms_url/query.sql b/internal/endtoend/testdata/golang_intialisms_url/query.sql
@@ -0,0 +1,2 @@
+-- name: SelectFoo :many
+SELECT * FROM foo;
diff --git a/internal/endtoend/testdata/golang_intialisms_url/schema.sql b/internal/endtoend/testdata/golang_intialisms_url/schema.sql
@@ -0,0 +1,4 @@
+CREATE TABLE foo(
+        bar_id text,
+        site_url text
+);
diff --git a/internal/endtoend/testdata/golang_intialisms_url/sqlc.json b/internal/endtoend/testdata/golang_intialisms_url/sqlc.json
@@ -0,0 +1,16 @@
+{
+    "version": "2",
+    "sql": [
+        {
+            "schema": "schema.sql",
+            "queries": "query.sql",
+            "engine": "postgresql",
+            "gen": {
+                "go": {
+                    "out": "db",
+                    "initialisms": ["id", "url"]
+                }
+            }
+        }
+    ]
+}