Merge pull request #320 from andrioid/master

Description added to generated Model code
99designs · Aug 28, 2018 · 8c17eea · 8c17eea
2 parents 988b367 + 7c04004
commit 8c17eea
Show file tree

Hide file tree

Showing 14 changed files with 34 additions and 10 deletions.
diff --git a/codegen/enum.go b/codegen/enum.go
@@ -2,8 +2,8 @@ package codegen
 
 type Enum struct {
 	*NamedType
-
-	Values []EnumValue
+	Description string
+	Values      []EnumValue
 }
 
 type EnumValue struct {

diff --git a/codegen/enum_build.go b/codegen/enum_build.go
@@ -23,8 +23,9 @@ func (cfg *Config) buildEnums(types NamedTypes) []Enum {
 		}
 
 		enum := Enum{
-			NamedType: namedType,
-			Values:    values,
+			NamedType:   namedType,
+			Values:      values,
+			Description: typ.Description,
 		}
 		enum.GoType = templates.ToCamel(enum.GQLType)
 		enums = append(enums, enum)

diff --git a/codegen/model.go b/codegen/model.go
@@ -2,8 +2,8 @@ package codegen
 
 type Model struct {
 	*NamedType
-
-	Fields []ModelField
+	Description string
+	Fields      []ModelField
 }
 
 type ModelField struct {
@@ -12,4 +12,5 @@ type ModelField struct {
 	GoFieldName string
 	GoFKName    string
 	GoFKType    string
+	Description string
 }
diff --git a/codegen/models_build.go b/codegen/models_build.go
@@ -41,6 +41,7 @@ func (cfg *Config) buildModels(types NamedTypes, prog *loader.Program, imports *
 		default:
 			continue
 		}
+		model.Description = typ.Description // It's this or change both obj2Model and buildObject
 
 		models = append(models, model)
 	}

diff --git a/codegen/object.go b/codegen/object.go
@@ -32,7 +32,7 @@ type Object struct {
 
 type Field struct {
 	*Type
-
+	Description    string          // Description of a field
 	GQLName        string          // The name of the field in graphql
 	GoFieldType    GoFieldType     // The field type in go, if any
 	GoReceiverName string          // The name of method & var receiver in go, if any

diff --git a/codegen/object_build.go b/codegen/object_build.go
@@ -115,6 +115,7 @@ func (cfg *Config) buildObject(types NamedTypes, typ *ast.Definition, imports *I
 				GoReceiverName: "ec",
 				GoFieldName:    "introspectSchema",
 				Object:         obj,
+				Description:    field.Description,
 			})
 			continue
 		}

diff --git a/codegen/templates/data.go b/codegen/templates/data.go
diff --git a/codegen/templates/models.gotpl b/codegen/templates/models.gotpl
@@ -9,11 +9,15 @@ import (
 )
 
 {{ range $model := .Models }}
+	{{with .Description}} {{.|prefixLines "// "}} {{end}}
 	{{- if .IsInterface }}
 		type {{.GoType}} interface {}
 	{{- else }}
 		type {{.GoType}} struct {
 			{{- range $field := .Fields }}
+				{{- with .Description}}
+					{{.|prefixLines "// "}}
+				{{- end}}
 				{{- if $field.GoFieldName }}
 					{{ $field.GoFieldName }} {{$field.Signature}} `json:"{{$field.GQLName}}"`
 				{{- else }}
@@ -25,10 +29,13 @@ import (
 {{- end}}
 
 {{ range $enum := .Enums }}
+	{{with .Description}}{{.|prefixLines "// "}} {{end}}
 	type {{.GoType}} string
 	const (
-	{{ range $value := .Values -}}
-		{{with .Description}} {{.|prefixLines "// "}} {{end}}
+	{{- range $value := .Values}}
+		{{- with .Description}}
+			{{.|prefixLines "// "}}
+		{{- end}}
 		{{$enum.GoType}}{{ .Name|toCamel }} {{$enum.GoType}} = {{.Name|quote}}
 	{{- end }}
 	)

diff --git a/codegen/testserver/models-gen.go b/codegen/testserver/models-gen.go
diff --git a/example/config/models_gen.go b/example/config/models_gen.go
diff --git a/example/dataloader/models_gen.go b/example/dataloader/models_gen.go
diff --git a/example/selection/models_gen.go b/example/selection/models_gen.go
diff --git a/example/starwars/models_gen.go b/example/starwars/models_gen.go
diff --git a/example/todo/models_gen.go b/example/todo/models_gen.go