generator

Documentation

Index

• Constants
• Variables
• func GenImports(data GenImportsData) (string, error)
• func GenPackage(data GenPackageData) (string, error)
• func GeneratePublishEvents(o PublishEventsOptions) (string, error)
• func LoadSource(pkg string) (*packages.Package, error)
• type Event
• type GenImportsData
• type GenPackageData
• type GenerateType
  • func GenerateTypeFromString(t string) (GenerateType, error)
• type Generator
  • func NewGenerator(o Options) *Generator
  • func (g *Generator) AddImport(pkg, alias string)
  • func (g *Generator) Build() error
  • func (g *Generator) BuildMethod(m *types.Func) error
  • func (g *Generator) Generate() (string, error)
• type Id
• type ImportAlias
• type ImportPkg
• type Method
• type Options
• type Param
• type PublishEventsOptions
• type Response
• type Subscriber

Constants

const LoadMode = packages.NeedName |
	packages.NeedFiles |
	packages.NeedImports |
	packages.NeedTypes |
	packages.NeedSyntax |
	packages.NeedTypesInfo

const Version = "v0.8.2"

Variables

var (
	ErrServiceNotFound     = errors.New("service not found")
	ErrEmptyService        = errors.New("empty service")
	ErrNotInterface        = errors.New("service is not an interface")
	ErrNoCtxParam          = errors.New(`first param is not "context.Context"`)
	ErrInvalidResults      = errors.New(`method results are not "error", neither "(SomeType, error)"`)
	ErrInvalidGenerateType = errors.New("invalid generate type")
)

var (
	ErrEventNotFound    = errors.New("event not found")
	ErrEventDocNotFound = errors.New("event doc not found")
)

Functions

func GenImports

func GenImports(data GenImportsData) (string, error)

func GenPackage

func GenPackage(data GenPackageData) (string, error)

func GeneratePublishEvents

func GeneratePublishEvents(o PublishEventsOptions) (string, error)

func LoadSource

func LoadSource(pkg string) (*packages.Package, error)

Types

type Event

type Event struct {
	Name  string
	Topic string
}

type GenImportsData

type GenImportsData struct {
	Imports map[ImportPkg]ImportAlias
}

type GenPackageData

type GenPackageData struct {
	PackageName string
	GenComment  bool
	Version     string
	SourceType  string
}

type GenerateType

type GenerateType string

const (
	GenerateTypeService    GenerateType = "service"
	GenerateTypeSubscriber GenerateType = "subscriber"
)

func GenerateTypeFromString

func GenerateTypeFromString(t string) (GenerateType, error)

type Generator

type Generator struct {
	Version    string
	SourceType string
	Package    *packages.Package

	GenerateType GenerateType

	ServicePkg  string
	ServiceType string

	PackageName string // package {{.PackageName}}
	GenComment  bool
	Imports     map[string]string // package->alias
	Methods     []*Method
}

func NewGenerator

func NewGenerator(o Options) *Generator

func (*Generator) AddImport

func (g *Generator) AddImport(pkg, alias string)

func (*Generator) Build

func (g *Generator) Build() error

func (*Generator) BuildMethod

func (g *Generator) BuildMethod(m *types.Func) error

func (*Generator) Generate

func (g *Generator) Generate() (string, error)

type Id

type Id struct {
	Pkg  string
	Name string
}

type ImportAlias

type ImportAlias = string

type ImportPkg

type ImportPkg = string

type Method

type Method struct {
	Name         string
	Params       []*Param
	Responses    []*Response
	Response     *Response
	Variadic     bool
	VariadicType string
}

type Options

type Options struct {
	ServicePkg   string
	ServiceType  string
	GenComment   bool
	GenerateType GenerateType
}

type Param

type Param struct {
	Name    string
	Type    string
	SigType string
}

type PublishEventsOptions

type PublishEventsOptions struct {
	Pkg        string
	GenComment bool
}

type Response

type Response struct {
	Name string
	Type string
	Ptr  bool
}

type Subscriber

type Subscriber struct {
	EventName   string
	HandlerName string
}