astutils

package
v2.4.3 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 9, 2024 License: MIT Imports: 26 Imported by: 0

Documentation

Index

Examples

Constants

This section is empty.

Variables

This section is empty.

Functions

func AppendImportStatements 

func AppendImportStatements(src []byte, appendImports []byte) []byte

func CollectStructsInFolder added in v2.0.9 

func CollectStructsInFolder(dir string, sc *StructCollector)

func ElementType 

func ElementType(t string) string

ElementType get element type string from slice

func ExprString 

func ExprString(expr ast.Expr) string

ExprString return string representation from ast.Expr

func FindGoMod added in v2.4.3 

func FindGoMod(filePath string) (*os.File, error)

func FixImport 

func FixImport(src []byte, file string)

FixImport format source code and add missing import syntax automatically

func GetImportPath 

func GetImportPath(dir string) string

GetImportPath get import path of pkg from dir

func GetImportStatements 

func GetImportStatements(input []byte) []byte

func GetMod 

func GetMod() string

GetMod get module name from go.mod file

func GetPkgPath added in v2.0.9 

func GetPkgPath(filePath string) string

func GrpcRelatedModify 

func GrpcRelatedModify(src []byte, metaName string, grpcSvcName string) []byte

func IsSlice 

func IsSlice(t string) bool

func IsVarargs 

func IsVarargs(t string) bool

func Pattern added in v2.0.5 

func Pattern(method string) (httpMethod string, endpoint string)

GetShelves_ShelfBooks_Book shelves/:shelf/books/:book

func RestRelatedModify 

func RestRelatedModify(src []byte, metaName string) []byte

func RewriteTag 

func RewriteTag(config RewriteTagConfig) (string, error)

RewriteTag overwrites json tag by convert function and return formatted source code

Example 
file := pathutils.Abs("testdata/rewritejsontag.go")
config := RewriteTagConfig{
	File:        file,
	Omitempty:   true,
	ConvertFunc: strcase.ToLowerCamel,
	Form:        false,
}
result, err := RewriteTag(config)
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 ToSlice 

func ToSlice(t string) string

func Visit 

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

Visit visit each files

Types

type Annotation 

type Annotation struct {
	Name   string
	Params []string
}

func GetAnnotations 

func GetAnnotations(text string) []Annotation
Example 
ret := GetAnnotations(`// <b style="color: red">NEW</b> 删除数据接口（不删数据文件）@role(SUPER_ADMIN)@permission(create,update)这是几个注解@sss()`)
fmt.Println(ret)

Output:

[{@role [SUPER_ADMIN]} {@permission [create update]} {@sss []}]

type EnumCollector 

type EnumCollector struct {
	Methods map[string][]MethodMeta
	Package PackageMeta

	Consts map[string][]string
	// contains filtered or unexported fields
}

func EnumsOf added in v2.0.5 

func EnumsOf(file string, exprString func(ast.Expr) string) *EnumCollector

func NewEnumCollector 

func NewEnumCollector(exprString func(ast.Expr) string) *EnumCollector

NewEnumCollector initializes an EnumCollector

func (*EnumCollector) Collect 

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

Collect collects all structs from source code

func (*EnumCollector) Visit 

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

Visit traverse each node from source code

type EnumMeta 

type EnumMeta struct {
	Name   string
	Values []string
}

EnumMeta wraps struct info

type FieldMeta 

type FieldMeta struct {
	Name     string
	Type     string
	Tag      string
	Comments []string
	IsExport bool
	// used in OpenAPI 3.0 spec as property name
	DocName string
	// Annotations of the field
	Annotations []Annotation
	// ValidateTag based on https://github.com/go-playground/validator
	// please refer to its documentation https://pkg.go.dev/github.com/go-playground/validator/v10
	ValidateTag    string
	IsPathVariable bool
}

FieldMeta wraps field info

type InterfaceCollector 

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

InterfaceCollector collect interfaces by parsing source code

func BuildInterfaceCollector 

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

BuildInterfaceCollector initializes an InterfaceCollector and collects interfaces

func NewInterfaceCollector 

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

NewInterfaceCollector initializes an InterfaceCollector

func (*InterfaceCollector) Collect 

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

Collect collects all interfaces from source code

func (*InterfaceCollector) Visit 

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

Visit traverse each node from source code

type InterfaceMeta 

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

InterfaceMeta wraps interface info

type MethodMeta 

type MethodMeta struct {
	// Recv method receiver
	Recv string
	// Name method name
	Name string
	// Params 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.
	// specially, if there is one or more v3.FileModel or []v3.FileModel params,
	// all will be put into request body as multipart/form-data data.
	Params []FieldMeta
	// Results response
	Results   []FieldMeta
	QueryVars []FieldMeta
	// PathVars 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
	// HeaderVars 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
	// BodyParams 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
	// BodyJSON 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
	// Files 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 of the method
	Comments []string
	// Path api path
	// not support when generate client code from service interface in svc.go file
	Path string
	// QueryParams 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
	// Annotations of the method
	Annotations     []Annotation
	HasPathVariable bool
	// HttpMethod only accepts GET, PUT, POST, DELETE
	HttpMethod string
}

MethodMeta represents an api

func GetMethodMeta 

func GetMethodMeta(spec *ast.FuncDecl) MethodMeta

GetMethodMeta get method name then new MethodMeta struct from *ast.FuncDecl

func NewMethodMeta 

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

NewMethodMeta new MethodMeta struct from *ast.FuncDecl

func (MethodMeta) String 

func (mm MethodMeta) String() string

type PackageMeta 

type PackageMeta struct {
	Name string
}

PackageMeta wraps package info

type RewriteTagConfig 

type RewriteTagConfig struct {
	File        string
	Omitempty   bool
	ConvertFunc func(old string) string
	Form        bool
}

type StaticMethodCollector 

type StaticMethodCollector struct {
	Methods []MethodMeta
	Package PackageMeta
	// contains filtered or unexported fields
}

StaticMethodCollector collect methods by parsing source code

func BuildStaticMethodCollector 

func BuildStaticMethodCollector(file string, exprString func(ast.Expr) string) StaticMethodCollector

BuildStaticMethodCollector initializes an StaticMethodCollector and collects static methods

func NewStaticMethodCollector 

func NewStaticMethodCollector(exprString func(ast.Expr) string, opts ...StaticMethodCollectorOption) *StaticMethodCollector

NewStaticMethodCollector initializes an StaticMethodCollector

func (*StaticMethodCollector) Collect 

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

Collect collects all static methods from source code

func (*StaticMethodCollector) Visit 

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

Visit traverse each node from source code

type StaticMethodCollectorOption 

type StaticMethodCollectorOption func(collector *StaticMethodCollector)

type StructCollector 

type StructCollector struct {
	Structs          []StructMeta
	Methods          map[string][]MethodMeta
	Package          PackageMeta
	NonStructTypeMap map[string]ast.Expr

	GlobalStructs []StructMeta
	// contains filtered or unexported fields
}

StructCollector collect structs by parsing source code

func BuildStructCollector 

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

BuildStructCollector initializes an StructCollector and collects structs

func NewStructCollector 

func NewStructCollector(exprString func(ast.Expr) string, opts ...StructCollectorOption) *StructCollector

NewStructCollector initializes an StructCollector

func (*StructCollector) Collect 

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

Collect collects all structs from source code

func (*StructCollector) DocFlatEmbed 

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

DocFlatEmbed flatten embed struct fields

func (*StructCollector) Visit 

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

Visit traverse each node from source code

type StructCollectorOption 

type StructCollectorOption func(collector *StructCollector)

func WithEnums 

func WithEnums(enums map[string]EnumMeta) StructCollectorOption

type StructMeta 

type StructMeta struct {
	Name     string
	Fields   []FieldMeta
	Comments []string
	Methods  []MethodMeta
	IsExport bool
	// go-doudou version
	Version string
}

StructMeta wraps struct info

func NewStructMeta 

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

NewStructMeta new StructMeta from *ast.StructType

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.