Use exact capitalization from field names overridden in config (#2237)

99designs · Jun 11, 2022 · d07ec12 · YogeshLele · Oct 24, 2022 · ianling
1 parent 3a64078
commit d07ec12
Show file tree

Hide file tree

Showing 7 changed files with 33 additions and 6 deletions.
diff --git a/plugin/modelgen/models.go b/plugin/modelgen/models.go
@@ -48,9 +48,12 @@ type Object struct {
 
 type Field struct {
 	Description string
-	Name        string
-	Type        types.Type
-	Tag         string
+	// Name is the field's name as it appears in the schema
+	Name string
+	// GoName is the field's name as it appears in the generated Go code
+	GoName string
+	Type   types.Type
+	Tag    string
 }
 
 type Enum struct {
@@ -178,7 +181,7 @@ func (m *Plugin) MutateConfig(cfg *config.Config) error {
 					}
 				}
 
-				name := field.Name
+				name := templates.ToGo(field.Name)
 				if nameOveride := cfg.Models[schemaType.Name].Fields[field.Name].FieldName; nameOveride != "" {
 					name = nameOveride
 				}
@@ -192,7 +195,8 @@ func (m *Plugin) MutateConfig(cfg *config.Config) error {
 				}
 
 				f := &Field{
-					Name:        name,
+					Name:        field.Name,
+					GoName:      name,
 					Type:        typ,
 					Description: field.Description,
 					Tag:         `json:"` + field.Name + `"`,

diff --git a/plugin/modelgen/models.gotpl b/plugin/modelgen/models.gotpl
@@ -29,7 +29,7 @@
 			{{- with .Description }}
 				{{.|prefixLines "// "}}
 			{{- end}}
-			{{ $field.Name|go }} {{$field.Type | ref}} `{{$field.Tag}}`
+			{{ $field.GoName }} {{$field.Type | ref}} `{{$field.Tag}}`
 		{{- end }}
 	}
 

diff --git a/plugin/modelgen/models_test.go b/plugin/modelgen/models_test.go
@@ -236,6 +236,10 @@ func TestModelGeneration(t *testing.T) {
 		require.Nil(t, out.Recursive{}.FieldThree)
 		require.NotNil(t, out.Recursive{}.FieldFour)
 	})
+
+	t.Run("overridden struct field names use same capitalization as config", func(t *testing.T) {
+		require.NotNil(t, out.RenameFieldTest{}.GOODnaME)
+	})
 }
 
 func TestModelGenerationStructFieldPointers(t *testing.T) {

diff --git a/plugin/modelgen/out/generated.go b/plugin/modelgen/out/generated.go
diff --git a/plugin/modelgen/out_struct_pointers/generated.go b/plugin/modelgen/out_struct_pointers/generated.go
diff --git a/plugin/modelgen/testdata/gqlgen.yml b/plugin/modelgen/testdata/gqlgen.yml
@@ -19,4 +19,8 @@ models:
     model: github.com/99designs/gqlgen/plugin/modelgen/out.ExistingUnion
   ExistingType:
     model: github.com/99designs/gqlgen/plugin/modelgen/out.ExistingType
+  RenameFieldTest:
+    fields:
+      badName:
+        fieldName: GOODnaME
 
diff --git a/plugin/modelgen/testdata/schema.graphql b/plugin/modelgen/testdata/schema.graphql
@@ -164,3 +164,8 @@ type Recursive {
     FieldThree: Recursive!
     FieldFour: String!
 }
+
+type RenameFieldTest {
+    badName: String!
+    otherField: String!
+}