simpleast

README

go get cirello.io/simpleast

https://pkg.go.dev/cirello.io/simpleast

Documentation

Overview

Package simpleast provides a simple way to inspect Go files and extract structs and methods from them.

Index

• type Const
  • func ParseConsts(r io.Reader) ([]*Const, error)
• type Field
• type Method
• type Struct
  • func ParseStructs(r io.Reader) ([]*Struct, error)
• type StructTag
• type StructTags
  • func (st StructTags) Get(name string) string

Types

type Const

type Const struct {
	Name       string `json:"name,omitempty"`
	DocComment string `json:"doc_comment,omitempty"`
	Type       string `json:"type,omitempty"`
	Value      string `json:"value,omitempty"`
}

func ParseConsts

func ParseConsts(r io.Reader) ([]*Const, error)

type Field

type Field struct {
	Name       string     `json:"name,omitempty"`
	DocComment string     `json:"doc_comment,omitempty"`
	Type       string     `json:"type,omitempty"`
	Tags       StructTags `json:"tags,omitempty"`
}

Field represents a Go field of Struct.

type Method

type Method struct {
	Name       string   `json:"name,omitempty"`
	DocComment string   `json:"doc_comment,omitempty"`
	TypeParams []string `json:"type_params,omitempty"`
	Parameters []Field  `json:"parameters,omitempty"`
	Results    []Field  `json:"results,omitempty"`
	// contains filtered or unexported fields
}

Method represents a Go method of Struct.

type Struct

type Struct struct {
	Name       string   `json:"name,omitempty"`
	DocComment string   `json:"doc_comment,omitempty"`
	TypeParams []Field  `json:"type_params,omitempty"`
	Fields     []Field  `json:"fields,omitempty"`
	Methods    []Method `json:"methods,omitempty"`
	Alias      string   `json:"alias,omitempty"`
	Type       string   `json:"type,omitempty"`
}

Struct represents a Go struct. Fields and Methods are not ordered.

func ParseStructs

func ParseStructs(r io.Reader) ([]*Struct, error)

ParseStructs extracts structs and methods from a Go file.

type StructTag

type StructTag struct {
	Name  string `json:"name,omitempty"`
	Value string `json:"value,omitempty"`
}

StructTag represents a Go struct field tag.

type StructTags

type StructTags []StructTag

func (StructTags) Get

func (st StructTags) Get(name string) string