generator

Documentation

Index

• Variables
• func Register(generator Generator)
• func Run(itemType Type, arguments []string) error
• type Block
• type BlockDefinition
• type BlockType
• type Config
• type Generator
• type Metadata
• type Path
• type Target
• type Type
• type TypeDefinition
  • func NewTypeDefinition(itemType Type, args []string) (*TypeDefinition, error)
• type Writer

Variables

var (
	Generators = make([]Generator, 0)
)

Functions

func Register

func Register(generator Generator)

func Run

func Run(itemType Type, arguments []string) error

Types

type Block

type Block struct {
	Type              BlockType
	Name              string
	Label             string
	JSONName          string
	TypeName          string
	ReferenceName     string
	ReferenceJSONTags []string
	Definition        BlockDefinition
}

Block is the building block(s) of types

type BlockDefinition

type BlockDefinition struct {
	Title       string
	Type        string
	IsArray     bool
	IsReference bool
}

type BlockType

type BlockType int

const (
	Field BlockType = iota + 1
	ContentBlock
)

type Config

type Config struct {
	Target Target
	Type   Type
}

type Generator

type Generator interface {
	Generate(definition *TypeDefinition, writer Writer) error
	Initialize(definition *TypeDefinition, writer Writer) error
}

type Metadata

type Metadata struct {
	MethodReceiverName string
}

type Path

type Path struct {
	Root string
	Base string
}

type Target

type Target struct {
	Path    Path
	Package string
}

type Type

type Type int

const (
	Plain Type = iota + 1
	Content
	FieldCollection
)

type TypeDefinition

type TypeDefinition struct {
	Name   string
	Label  string
	Blocks []Block
	Type
	Metadata
}

func NewTypeDefinition

func NewTypeDefinition(itemType Type, args []string) (*TypeDefinition, error)

type Writer

type Writer interface {
	Write(filePath string, buf []byte) error
}

var FormattedSourceWriter Writer = new(fileWriter)