feat: schema定义注释支持

Author: guihouchang

schema/field/field.go

@@ -17,6 +17,11 @@ func (t *textBuilder) Analyzer(analyzer string) *textBuilder {
 	return t
 }
 
+func (t *textBuilder) Comment(c string) *textBuilder {
+	t.desc.Comment = c
+	return t
+}
+
 // SearchAnalyzer 搜索分词器
 // Deprecated: 该方法已经弃用,在es7.x版本中不在设置search_analyzer
 func (t *textBuilder) SearchAnalyzer(sa string) *textBuilder {
@@ -51,6 +56,11 @@ func (d *dateBuilder) Format(format string) *dateBuilder {
 	return d
 }
 
+func (d *dateBuilder) Comment(c string) *dateBuilder {
+	d.desc.Comment = c
+	return d
+}
+
 type boolBuilder struct {
 	desc *field.Descriptor
 }
@@ -59,6 +69,11 @@ func (b *boolBuilder) Descriptor() *field.Descriptor {
 	return b.desc
 }
 
+func (b *boolBuilder) Comment(c string) *boolBuilder {
+	b.desc.Comment = c
+	return b
+}
+
 func Text(name string) *textBuilder {
 	builder := &textBuilder{desc: &field.Descriptor{
 		Info: &field.TypeInfo{Type: field.TypeString},
@@ -71,6 +86,11 @@ func (k *keywordBuilder) Descriptor() *field.Descriptor {
 	return k.desc
 }
 
+func (k *keywordBuilder) Comment(c string) *keywordBuilder {
+	k.desc.Comment = c
+	return k
+}
+
 func Keyword(name string) *keywordBuilder {
 	return &keywordBuilder{desc: &field.Descriptor{
 		Info: &field.TypeInfo{Type: field.Type(TypeKeyword)},
@@ -100,6 +120,11 @@ func (j *jsonBuilder) Descriptor() *field.Descriptor {
 	return j.desc
 }
 
+func (j *jsonBuilder) Comment(c string) *jsonBuilder {
+	j.desc.Comment = c
+	return j
+}
+
 func Strings(name string) *jsonBuilder {
 	return &jsonBuilder{desc: field.JSON(name, []string{}).Descriptor()}
 }

schema/field/numeric.go

@@ -10,6 +10,11 @@ func (t *int8Builder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *int8Builder) Comment(c string) *int8Builder {
+	t.desc.Comment = c
+	return t
+}
+
 type int16Builder struct {
 	desc *field.Descriptor
 }
@@ -18,6 +23,11 @@ func (t *int16Builder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *int16Builder) Comment(c string) *int16Builder {
+	t.desc.Comment = c
+	return t
+}
+
 type int32Builder struct {
 	desc *field.Descriptor
 }
@@ -26,6 +36,11 @@ func (t *int32Builder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *int32Builder) Comment(c string) *int32Builder {
+	t.desc.Comment = c
+	return t
+}
+
 type int64Builder struct {
 	desc *field.Descriptor
 }
@@ -34,6 +49,11 @@ func (t *int64Builder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *int64Builder) Comment(c string) *int64Builder {
+	t.desc.Comment = c
+	return t
+}
+
 type floatBuilder struct {
 	desc *field.Descriptor
 }
@@ -42,6 +62,11 @@ func (t *floatBuilder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *floatBuilder) Comment(c string) *floatBuilder {
+	t.desc.Comment = c
+	return t
+}
+
 type doubleBuilder struct {
 	desc *field.Descriptor
 }
@@ -50,6 +75,11 @@ func (t *doubleBuilder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *doubleBuilder) Comment(c string) *doubleBuilder {
+	t.desc.Comment = c
+	return t
+}
+
 type halfFloatBuilder struct {
 	desc *field.Descriptor
 }
@@ -58,6 +88,11 @@ func (t *halfFloatBuilder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *halfFloatBuilder) Comment(c string) *halfFloatBuilder {
+	t.desc.Comment = c
+	return t
+}
+
 type scaledFloatBuilder struct {
 	desc *field.Descriptor
 }
@@ -66,6 +101,11 @@ func (t *scaledFloatBuilder) Descriptor() *field.Descriptor {
 	return t.desc
 }
 
+func (t *scaledFloatBuilder) Comment(c string) *scaledFloatBuilder {
+	t.desc.Comment = c
+	return t
+}
+
 func Byte(name string) *int8Builder {
 	return &int8Builder{desc: &field.Descriptor{
 		Info: &field.TypeInfo{Type: field.Type(TypeInt8)},

schema/gen/gen.go

@@ -34,6 +34,7 @@ var tpl, err = template.New("").Funcs(template.FuncMap{
 	"ToLower":      strings.ToLower,
 	"RendProperty": RendProperty,
 	"Imports":      Imports,
+	"RendComment":  RendComment,
 }).ParseFS(templateFile, "template/*.tmpl")
 
 func ToUnderscore(camelCase string) string {
@@ -67,6 +68,10 @@ func HtmlUnescapeString(s string) template.HTML {
 	return template.HTML(s)
 }
 
+func RendComment(fd *load.Field) template.HTML {
+	return template.HTML(fmt.Sprintf("// %s %s", pascal(fd.Name), fd.Comment))
+}
+
 func RendProperty(fd *load.Field) []template.HTML {
 	switch fd.Info.Type {
 	case entfield.TypeString:

schema/gen/template/struct.tmpl

@@ -8,7 +8,7 @@ import (
 )
 
 type {{.Schema.Name}} struct {
-    {{range .Schema.Fields}}
+    {{range .Schema.Fields}}{{RendComment .}}
     {{ToCamelCase .Name}} {{Type .}} `json:"{{.Name}},omitempty"`
     {{end}}
 }

test/schema/user.go

@@ -13,20 +13,20 @@ type UserData struct {
 
 func (UserData) Fields() []ent.Field {
 	return []ent.Field{
-		esfield.Text("id").Analyzer("ik_max_word").SearchAnalyzer("ik_max_word"),
-		esfield.Keyword("keyword_kkkk"),
-		esfield.Byte("byte_bbbb"),
-		esfield.Short("short_ssss"),
-		esfield.Int("int_iiii"),
-		esfield.Long("long_llll"),
-		esfield.Float("float_ffff"),
-		esfield.Double("double_ddddd"),
-		esfield.Bool("bool_bbbb"),
-		esfield.Date("date_dddd").Format("yyyy-MM-dd HH:mm:ss"),
-		esfield.Strings("stings_sssss"),
-		esfield.Ints("ints_iiiiii"),
-		esfield.Int64s("int64s_iiiiii"),
-		esfield.Floats("floats_llllll"),
+		esfield.Text("id").Analyzer("ik_max_word").Comment("这是一个ID"),
+		esfield.Keyword("keyword_kkkk").Comment("这是一个keyword"),
+		esfield.Byte("byte_bbbb").Comment("这是一个byte"),
+		esfield.Short("short_ssss").Comment("这是一个short"),
+		esfield.Int("int_iiii").Comment("这是一个int"),
+		esfield.Long("long_llll").Comment("这是一个long"),
+		esfield.Float("float_ffff").Comment("这是一个Float"),
+		esfield.Double("double_ddddd").Comment("这是一个double"),
+		esfield.Bool("bool_bbbb").Comment("这是一个bool"),
+		esfield.Date("date_dddd").Format("yyyy-MM-dd HH:mm:ss").Comment("这是一个date"),
+		esfield.Strings("stings_sssss").Comment("这是一个strings"),
+		esfield.Ints("ints_iiiiii").Comment("这是一个ints"),
+		esfield.Int64s("int64s_iiiiii").Comment("这是一个int64s"),
+		esfield.Floats("floats_llllll").Comment("这是一个floats"),
 	}
 }