astutils

Documentation

Index

• func ExprString(expr ast.Expr) string
• func FixImport(src []byte, file string)
• func GetImportPath(file string) string
• func GetMod() string
• func RewriteJsonTag(file string, omitempty bool, convert func(old string) string) (string, error)
• func Visit(files *[]string) filepath.WalkFunc
• type FieldMeta
• type InterfaceCollector
  • func BuildInterfaceCollector(file string, exprString func(ast.Expr) string) InterfaceCollector
  • func NewInterfaceCollector(exprString func(ast.Expr) string) *InterfaceCollector
  • func (ic *InterfaceCollector) Collect(n ast.Node) ast.Visitor
  • func (ic *InterfaceCollector) Visit(n ast.Node) ast.Visitor
• type InterfaceMeta
• type MethodMeta
  • func GetMethodMeta(spec *ast.FuncDecl) MethodMeta
  • func NewMethodMeta(ft *ast.FuncType, exprString func(ast.Expr) string) MethodMeta
  • func (mm MethodMeta) String() string
• type PackageMeta
• type StructCollector
  • func BuildStructCollector(file string, exprString func(ast.Expr) string) StructCollector
  • func NewStructCollector(exprString func(ast.Expr) string) *StructCollector
  • func (sc *StructCollector) Collect(n ast.Node) ast.Visitor
  • func (sc *StructCollector) DocFlatEmbed() []StructMeta
  • func (sc *StructCollector) Visit(n ast.Node) ast.Visitor
• type StructMeta
  • func NewStructMeta(structType *ast.StructType, exprString func(ast.Expr) string) StructMeta

Examples

• RewriteJsonTag

Functions

func ExprString

func ExprString(expr ast.Expr) string

func FixImport

func FixImport(src []byte, file string)

func GetImportPath

func GetImportPath(file string) string

func GetMod

func GetMod() string

func RewriteJsonTag

func RewriteJsonTag(file string, omitempty bool, convert func(old string) string) (string, error)

Example

file := pathutils.Abs("testfiles/rewritejsontag.go")
result, err := RewriteJsonTag(file, true, strcase.ToLowerCamel)
if err != nil {
	panic(err)
}
fmt.Println(result)

Output:

package main

type base struct {
	Index string `json:"index,omitempty"`
	Type  string `json:"type,omitempty"`
}

type struct1 struct {
	base
	Name       string `json:"name,omitempty"`
	StructType int    `json:"structType,omitempty" dd:"awesomtag"`
	Format     string `dd:"anothertag" json:"format,omitempty"`
	Pos        int    `json:"pos,omitempty"`
}

func Visit

func Visit(files *[]string) filepath.WalkFunc

Types

type FieldMeta

type FieldMeta struct {
	Name     string
	Type     string
	Tag      string
	Comments []string
	IsExport bool
	DocName  string
}

type InterfaceCollector

type InterfaceCollector struct {
	Interfaces []InterfaceMeta
	Package    PackageMeta
	// contains filtered or unexported fields
}

func BuildInterfaceCollector

func BuildInterfaceCollector(file string, exprString func(ast.Expr) string) InterfaceCollector

func NewInterfaceCollector

func NewInterfaceCollector(exprString func(ast.Expr) string) *InterfaceCollector

func (*InterfaceCollector) Collect

func (ic *InterfaceCollector) Collect(n ast.Node) ast.Visitor

func (*InterfaceCollector) Visit

func (ic *InterfaceCollector) Visit(n ast.Node) ast.Visitor

type InterfaceMeta

type InterfaceMeta struct {
	Name     string
	Methods  []MethodMeta
	Comments []string
}

type MethodMeta

type MethodMeta struct {
	Recv string
	Name string
	// when generate client code from openapi3 spec json file, Params holds all method input parameters.
	// when generate client code from service interface in svc.go file, if there is struct type param, this struct type param will put into request body,
	// then others will be put into url as query string. if there is no struct type param and the api is a get request, all will be put into url as query string.
	// if there is no struct type param and the api is Not a get request, all will be put into request body as application/x-www-form-urlencoded data.
	// specailly, if there is one or more *multipart.FileHeader or []*multipart.FileHeader params, all will be put into request body as multipart/form-data data.
	Params []FieldMeta
	// response
	Results []FieldMeta
	// not support when generate client code from service interface in svc.go file
	// when generate client code from openapi3 spec json file, PathVars is parameters in url as path variable.
	PathVars []FieldMeta
	// not support when generate client code from service interface in svc.go file
	// when generate client code from openapi3 spec json file, HeaderVars is parameters in header.
	HeaderVars []FieldMeta
	// not support when generate client code from service interface in svc.go file
	// when generate client code from openapi3 spec json file, BodyParams is parameters in request body as query string.
	BodyParams *FieldMeta
	// not support when generate client code from service interface in svc.go file
	// when generate client code from openapi3 spec json file, BodyJson is parameters in request body as json.
	BodyJson *FieldMeta
	// not support when generate client code from service interface in svc.go file
	// when generate client code from openapi3 spec json file, Files is parameters in request body as multipart file.
	Files    []FieldMeta
	Comments []string
	// api path
	// not support when generate client code from service interface in svc.go file
	Path string
	// not support when generate client code from service interface in svc.go file
	// when generate client code from openapi3 spec json file, QueryParams is parameters in url as query string.
	QueryParams *FieldMeta
}

MethodMeta represented a api

func GetMethodMeta

func GetMethodMeta(spec *ast.FuncDecl) MethodMeta

func NewMethodMeta

func NewMethodMeta(ft *ast.FuncType, exprString func(ast.Expr) string) MethodMeta

func (MethodMeta) String

func (mm MethodMeta) String() string

type PackageMeta

type PackageMeta struct {
	Name string
}

type StructCollector

type StructCollector struct {
	Structs          []StructMeta
	Methods          map[string][]MethodMeta
	Package          PackageMeta
	NonStructTypeMap map[string]ast.Expr
	// contains filtered or unexported fields
}

func BuildStructCollector

func BuildStructCollector(file string, exprString func(ast.Expr) string) StructCollector

func NewStructCollector

func NewStructCollector(exprString func(ast.Expr) string) *StructCollector

func (*StructCollector) Collect

func (sc *StructCollector) Collect(n ast.Node) ast.Visitor

func (*StructCollector) DocFlatEmbed

func (sc *StructCollector) DocFlatEmbed() []StructMeta

func (*StructCollector) Visit

func (sc *StructCollector) Visit(n ast.Node) ast.Visitor

type StructMeta

type StructMeta struct {
	Name     string
	Fields   []FieldMeta
	Comments []string
	Methods  []MethodMeta
	IsExport bool
}

func NewStructMeta

func NewStructMeta(structType *ast.StructType, exprString func(ast.Expr) string) StructMeta