astTraversal

type BaseTraverser struct {
	Log      *zerolog.Logger
	Packages *PackageManager
	// contains filtered or unexported fields
}

type BindingTag struct {
	Name           string `json:"name,omitempty" yaml:"name,omitempty"`
	NotShown       bool   `json:"not_shown,omitempty" yaml:"not_shown,omitempty"`
	ReturnOptional bool   `json:"return_optional,omitempty" yaml:"return_optional,omitempty"`
}

type BindingTagMap map[BindingTagType]BindingTag

type BindingTagType string

type CallExpressionTraverser struct {
	Traverser *BaseTraverser
	Node      *ast.CallExpr
	File      *FileNode
}

type DeclarationTraverser struct {
	Traverser *BaseTraverser
	Decl      ast.Node
	File      *FileNode
	VarName   string
}

type ExpressionTraverser struct {
	Traverser *BaseTraverser
	Node      ast.Expr
	File      *FileNode
	ReturnNum int
}

type FileImport struct {
	Package *PackageNode
	Name    string
}

type FileNode struct {
	Package  *PackageNode
	FileName string
	Imports  []FileImport
	AST      *ast.File
}

type FunctionTraverser struct {
	Traverser *BaseTraverser
	Node      *ast.FuncLit
	File      *FileNode
	DeclNode  *ast.FuncDecl
}

type LiteralTraverser struct {
	Traverser *BaseTraverser
	Node      ast.Node
	ReturnNum int
}

type PackageManager struct {
	// contains filtered or unexported fields
}

type PackageNode struct {
	Parent  *PackageNode
	Name    string
	Package *packages.Package
	Edges   []*PackageNode
	Files   []*FileNode

	// TypeDocMap is a map of type names to their documentation
	// We cache this to save iterating over types every time we need to find the documentation
	TypeDocMap map[string]string
}

type PackagePathLoader func(path string) (string, error)

type Result struct {
	// Type is the type of the result
	Type string

	// Package is the package of the result
	// It's used to reference the external package of a types.Named type
	// It's used as the package of a Slice, Array or Map Value
	Package *PackageNode

	// Name is the name of the result if it's a types.Named type
	Name string

	// Names is a list of names that are associated with the result (e.g. for a struct field)
	Names []string

	// IsEmbedded is true if the result is embedded in a struct
	IsEmbedded bool

	// ConstantValue is the constant value of the result (e.g. for a string)
	ConstantValue string

	// EnumValues is a list of enum values (e.g. for an enum { Foo, Bar })
	// This is used for when the result of a types.Named becomes a types.Basic and has constant values defined in the package
	EnumValues []any

	// MapKeyPackage is the package of the map key (e.g. for a map[string]string)
	MapKeyPackage *PackageNode

	// MapKeyType is the type of the map key (e.g. for a map[string]string)
	MapKeyType string

	// MapValueType is the type of the map value (e.g. for a map[string]string)
	MapValueType string

	// SliceType is the type of the slice (e.g. for a []string)
	SliceType string

	// ArrayType is the type of the array (e.g. for a [5]string)
	ArrayType string

	// ArrayLength is the length of the array (e.g. for a [5]string)
	ArrayLength int64

	// StructFields is a map of struct fields (e.g. for a struct { Foo string })
	StructFields map[string]Result

	StructFieldBindingTags BindingTagMap

	StructFieldValidationTags ValidationTagMap

	// Doc is the documentation of the result
	Doc string
}

type TypeTraverser struct {
	Traverser *BaseTraverser
	Node      types.Type
	Package   *PackageNode
	// contains filtered or unexported fields
}

type ValidationTag struct {
	IsRequired bool `json:"is_required,omitempty" yaml:"is_required,omitempty"`
}

type ValidationTagMap map[ValidationTagType]ValidationTag

type ValidationTagType string