README
¶
ToAST
ToAST is a thin wrapper for the Go standard library ast package that provides a simple interface for working with Go types.
This package only supports parsing of type definitions. It was originally intended to be used for generating type definitions for other languages -- particularly CUE, a typesafe superset of JSON.
Types
Each go/ast type specification maps to one of four structs:
PlainType: Basic types, type aliases, and pointersArrayType: Array and slice typesMapType: MapsStructType: Structs, which may contain fields that are themselves one of the four types.
There is also partial support for an EnumType, which is expressed by convention in Go as a type
declaration with a group of constants of the same type.
Transforms
When parsing a file, ToAST can apply a number of transformations on matching objects:
ExcludeImportexcludes specific importsModifyImportmutates specific importsExcludeTypeexcludes specific typesModifyTypemutates specific typesExcludeFieldexcludes specific fields in aStructTypeModifyFieldmutates specific fields in aStructTypeCopyIntoStructcopies fields from one or more namedStructTypes into a targetStructType, replacing the field at of a given namePromoteToEnumTypeconverts aPlainTypeinto anEnumTypeGenFieldTransformtakes aStructTypeand aFieldand returns someTransformthat can be matched on subsequent nodes in the fileGenEnumTypeTransformtakes a string andgo/ast.ValueSpecand returns aPromoteToEnumTypetransform that can be matched on aPlainTypein the file
Usage
First, load an *ast.File. For example:
import "go/parser"
filePath := "path/to/file.go"
astFile, err := parser.ParseFile(token.NewFileSet(), filePath, nil, parser.ParseComments)
if err != nil {
panic(err)
}
Then create a *toast.File:
file := toast.NewFile(astFile,
WithTransform(&toast.ExcludeImport{
Match: func(i Import) bool {
return i.Name == "foo"
}
}),
WithTransform(&toast.ExcludeType{
Match: func(t Type) bool {
return t.Name == "bar"
}
}),
...
)
Documentation
¶
Index ¶
- func DocsFromCommentGroup(cg *ast.CommentGroup) string
- type ArrayType
- type CopyIntoStruct
- type EnumType
- type ExcludeField
- type ExcludeImport
- type ExcludeType
- type Field
- type File
- type GenEnumTypeTransform
- type GenFieldTransform
- type Import
- type MapType
- type ModifyField
- type ModifyImport
- type ModifyType
- type Node
- type Option
- type PlainType
- type PromoteToEnumType
- type StructType
- type Transform
- type Type
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DocsFromCommentGroup ¶
func DocsFromCommentGroup(cg *ast.CommentGroup) string
Types ¶
type ArrayType ¶
type ArrayType struct {
Name string `json:"name"`
Type string `json:"type"`
Length int `json:"length,omitempty"`
Docs string `json:"-"`
}
func (*ArrayType) GetTypeNames ¶
func (*ArrayType) Reflect ¶
func (a *ArrayType) Reflect() json.RawMessage
func (*ArrayType) SetTypeNames ¶
type CopyIntoStruct ¶
type EnumType ¶
type EnumType struct {
Name string `json:"name"`
Values []string `json:"values"`
Docs string `json:"-"`
}
func (*EnumType) GetTypeNames ¶
func (*EnumType) Reflect ¶
func (et *EnumType) Reflect() json.RawMessage
func (*EnumType) SetTypeNames ¶
type ExcludeField ¶
type ExcludeImport ¶
type ExcludeType ¶
type File ¶
type File struct {
Imports map[string]Import
Code []Type
// contains filtered or unexported fields
}
func (*File) Reflect ¶
func (f *File) Reflect() json.RawMessage
type GenEnumTypeTransform ¶
type GenEnumTypeTransform struct {
Generate func(string, *ast.ValueSpec) *PromoteToEnumType
}
type GenFieldTransform ¶
type GenFieldTransform struct {
Generate func(*StructType, *Field) Transform
}
type Import ¶
type Import struct {
Name string `json:"name,omitempty"`
Path string `json:"path"`
// contains filtered or unexported fields
}
func ImportFromSpec ¶
func ImportFromSpec(spec *ast.ImportSpec) Import
func (*Import) GetOldPath ¶
func (*Import) Reflect ¶
func (i *Import) Reflect() json.RawMessage
type MapType ¶
type MapType struct {
Name string `json:"name"`
KeyType string `json:"key_type"`
ValueType string `json:"value_type"`
Docs string `json:"-"`
}
func (*MapType) GetTypeNames ¶
func (*MapType) Reflect ¶
func (m *MapType) Reflect() json.RawMessage
func (*MapType) SetTypeNames ¶
type ModifyField ¶
type ModifyImport ¶
type ModifyType ¶
type Node ¶
type Node interface {
// Renders JSON representation of the node.
Reflect() json.RawMessage
// Renders Go type definitions.
Go() string
// Renders CUE definitions.
CUE() string
}
type Option ¶
type Option func(*File)
func WithCUEPackageName ¶
func WithPackageName ¶
func WithTransform ¶
type PlainType ¶
type PlainType struct {
Name string `json:"name"`
Type string `json:"type"`
Docs string `json:"-"`
}
func PlainTypeFromSelectorExpr ¶
func PlainTypeFromSelectorExpr(name, docs string, s *ast.SelectorExpr) *PlainType
func PlainTypeFromStarExpr ¶
func (*PlainType) GetTypeNames ¶
func (*PlainType) Reflect ¶
func (p *PlainType) Reflect() json.RawMessage
func (*PlainType) SetTypeNames ¶
type PromoteToEnumType ¶
type StructType ¶
type StructType struct {
Name string `json:"name"`
Fields []*Field `json:"fields"`
Docs string `json:"-"`
}
func StructTypeFromSpec ¶
func StructTypeFromSpec(name, docs string, s *ast.StructType) (*StructType, error)
func (*StructType) CUE ¶
func (s *StructType) CUE() string
func (*StructType) GetDocs ¶
func (s *StructType) GetDocs() string
func (*StructType) GetName ¶
func (s *StructType) GetName() string
func (*StructType) GetTypeNames ¶
func (s *StructType) GetTypeNames() []string
func (*StructType) Go ¶
func (s *StructType) Go() string
func (*StructType) Reflect ¶
func (s *StructType) Reflect() json.RawMessage
func (*StructType) SetTypeNames ¶
func (s *StructType) SetTypeNames(tt []string)
Source Files
¶
Directories
Click to show internal directories.
Click to hide internal directories.