util.go 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224
  1. package tsgen
  2. import (
  3. "errors"
  4. "fmt"
  5. "io"
  6. "strings"
  7. "github.com/wuntsong-org/go-zero-plus/tools/goctlwt/api/spec"
  8. apiutil "github.com/wuntsong-org/go-zero-plus/tools/goctlwt/api/util"
  9. "github.com/wuntsong-org/go-zero-plus/tools/goctlwt/util"
  10. )
  11. const (
  12. formTagKey = "form"
  13. pathTagKey = "path"
  14. headerTagKey = "header"
  15. )
  16. func writeProperty(writer io.Writer, member spec.Member, indent int) error {
  17. writeIndent(writer, indent)
  18. ty, err := genTsType(member)
  19. if err != nil {
  20. return err
  21. }
  22. optionalTag := ""
  23. if member.IsOptional() || member.IsOmitEmpty() {
  24. optionalTag = "?"
  25. }
  26. name, err := member.GetPropertyName()
  27. if err != nil {
  28. return err
  29. }
  30. comment := member.GetComment()
  31. if len(comment) > 0 {
  32. comment = strings.TrimPrefix(comment, "//")
  33. comment = " // " + strings.TrimSpace(comment)
  34. }
  35. if len(member.Docs) > 0 {
  36. fmt.Fprintf(writer, "%s\n", strings.Join(member.Docs, ""))
  37. writeIndent(writer, 1)
  38. }
  39. _, err = fmt.Fprintf(writer, "%s%s: %s%s\n", name, optionalTag, ty, comment)
  40. return err
  41. }
  42. func writeIndent(writer io.Writer, indent int) {
  43. for i := 0; i < indent; i++ {
  44. fmt.Fprint(writer, "\t")
  45. }
  46. }
  47. func genTsType(m spec.Member) (ty string, err error) {
  48. ty, err = goTypeToTs(m.Type, false)
  49. if enums := m.GetEnumOptions(); enums != nil {
  50. if ty == "string" {
  51. for i := range enums {
  52. enums[i] = "'" + enums[i] + "'"
  53. }
  54. }
  55. ty = strings.Join(enums, " | ")
  56. }
  57. return
  58. }
  59. func goTypeToTs(tp spec.Type, fromPacket bool) (string, error) {
  60. switch v := tp.(type) {
  61. case spec.DefineStruct:
  62. return addPrefix(tp, fromPacket), nil
  63. case spec.PrimitiveType:
  64. r, ok := primitiveType(tp.Name())
  65. if !ok {
  66. return "", errors.New("unsupported primitive type " + tp.Name())
  67. }
  68. return r, nil
  69. case spec.MapType:
  70. valueType, err := goTypeToTs(v.Value, fromPacket)
  71. if err != nil {
  72. return "", err
  73. }
  74. return fmt.Sprintf("{ [key: string]: %s }", valueType), nil
  75. case spec.ArrayType:
  76. if tp.Name() == "[]byte" {
  77. return "Blob", nil
  78. }
  79. valueType, err := goTypeToTs(v.Value, fromPacket)
  80. if err != nil {
  81. return "", err
  82. }
  83. return fmt.Sprintf("Array<%s>", valueType), nil
  84. case spec.InterfaceType:
  85. return "any", nil
  86. case spec.PointerType:
  87. return goTypeToTs(v.Type, fromPacket)
  88. }
  89. return "", errors.New("unsupported type " + tp.Name())
  90. }
  91. func addPrefix(tp spec.Type, fromPacket bool) string {
  92. if fromPacket {
  93. return packagePrefix + util.Title(tp.Name())
  94. }
  95. return util.Title(tp.Name())
  96. }
  97. func primitiveType(tp string) (string, bool) {
  98. switch tp {
  99. case "string":
  100. return "string", true
  101. case "int", "int8", "int16", "int32", "int64", "uint", "uint8", "uint16", "uint32", "uint64":
  102. return "number", true
  103. case "float", "float32", "float64":
  104. return "number", true
  105. case "bool":
  106. return "boolean", true
  107. case "[]byte":
  108. return "Blob", true
  109. case "interface{}":
  110. return "any", true
  111. }
  112. return "", false
  113. }
  114. func writeType(writer io.Writer, tp spec.Type) error {
  115. fmt.Fprintf(writer, "export interface %s {\n", util.Title(tp.Name()))
  116. if err := writeMembers(writer, tp, false); err != nil {
  117. return err
  118. }
  119. fmt.Fprintf(writer, "}\n")
  120. return genParamsTypesIfNeed(writer, tp)
  121. }
  122. func genParamsTypesIfNeed(writer io.Writer, tp spec.Type) error {
  123. definedType, ok := tp.(spec.DefineStruct)
  124. if !ok {
  125. return errors.New("no members of type " + tp.Name())
  126. }
  127. members := definedType.GetNonBodyMembers()
  128. if len(members) == 0 {
  129. return nil
  130. }
  131. fmt.Fprintf(writer, "export interface %sParams {\n", util.Title(tp.Name()))
  132. if err := writeTagMembers(writer, tp, formTagKey); err != nil {
  133. return err
  134. }
  135. fmt.Fprintf(writer, "}\n")
  136. if len(definedType.GetTagMembers(headerTagKey)) > 0 {
  137. fmt.Fprintf(writer, "export interface %sHeaders {\n", util.Title(tp.Name()))
  138. if err := writeTagMembers(writer, tp, headerTagKey); err != nil {
  139. return err
  140. }
  141. fmt.Fprintf(writer, "}\n")
  142. }
  143. return nil
  144. }
  145. func writeMembers(writer io.Writer, tp spec.Type, isParam bool) error {
  146. definedType, ok := tp.(spec.DefineStruct)
  147. if !ok {
  148. pointType, ok := tp.(spec.PointerType)
  149. if ok {
  150. return writeMembers(writer, pointType.Type, isParam)
  151. }
  152. return fmt.Errorf("type %s not supported", tp.Name())
  153. }
  154. members := definedType.GetBodyMembers()
  155. if isParam {
  156. members = definedType.GetNonBodyMembers()
  157. }
  158. for _, member := range members {
  159. if member.IsInline {
  160. if err := writeMembers(writer, member.Type, isParam); err != nil {
  161. return err
  162. }
  163. continue
  164. }
  165. if err := writeProperty(writer, member, 1); err != nil {
  166. return apiutil.WrapErr(err, " type "+tp.Name())
  167. }
  168. }
  169. return nil
  170. }
  171. func writeTagMembers(writer io.Writer, tp spec.Type, tagKey string) error {
  172. definedType, ok := tp.(spec.DefineStruct)
  173. if !ok {
  174. pointType, ok := tp.(spec.PointerType)
  175. if ok {
  176. return writeTagMembers(writer, pointType.Type, tagKey)
  177. }
  178. return fmt.Errorf("type %s not supported", tp.Name())
  179. }
  180. members := definedType.GetTagMembers(tagKey)
  181. for _, member := range members {
  182. if member.IsInline {
  183. if err := writeTagMembers(writer, member.Type, tagKey); err != nil {
  184. return err
  185. }
  186. continue
  187. }
  188. if err := writeProperty(writer, member, 1); err != nil {
  189. return apiutil.WrapErr(err, " type "+tp.Name())
  190. }
  191. }
  192. return nil
  193. }