gen

Documentation

Index

• func Generate(manifestPath string, mcfg *packages.Config) error
• type CommonStruct
• type ConvertFunctionParams
• type Manifest
  • func LoadManifest(path string, mcfg *packages.Config) Manifest
  • func (m *Manifest) GetCommonStruct(name string) *CommonStruct
• type MapOverride
• type ObjectMap

Functions

func Generate

func Generate(manifestPath string, mcfg *packages.Config) error

Generate generates the mapping files.

Types

type CommonStruct

type CommonStruct struct {
	PackageName string       `yaml:"package_name"`
	StructName  string       `yaml:"struct_name"`
	Path        string       `yaml:"path"`
	Struct      csgen.Struct `yaml:"struct"`
}

CommonStruct a container for structs that have global application when creating maps

type ConvertFunctionParams

type ConvertFunctionParams struct {
	ConverterPackage     string
	FunctionName         string
	FunctionNameForSlice string
	SourcePackage        string
	SourceObjectName     string
	FQSourceObjectName   string
	TargetPackage        string
	TargetObjectName     string
	FQTargetObjectName   string
	Assignments          []string
	Imports              []string
}

ConvertFunctionParams is a struct that contains the parameters that feed into the template.

type Manifest

type Manifest struct {
	ProjectRoot      string         `yaml:"project_root"`
	GeneratorPath    string         `yaml:"generator_path"`
	GeneratorPackage string         `yaml:"generator_package"`
	ObjectMaps       []ObjectMap    `yaml:"maps"`
	CommonStructs    []CommonStruct `yaml:"common_structs"`
}

Manifest strongly typed respresentation of the manifest file.

func LoadManifest

func LoadManifest(path string, mcfg *packages.Config) Manifest

LoadManifest loads the manifest file and returns a slice of ObjectMap structs.

func (*Manifest) GetCommonStruct

func (m *Manifest) GetCommonStruct(name string) *CommonStruct

GetCommonStruct return a common struct by name if it exists and nil otherwise

type MapOverride

type MapOverride struct {
	SourceName string `yaml:"source_name"`
	TargetName string `yaml:"target_name"`
}

MapOverride struct that represents an explicitly specified object mapping, overriding the defailt name matching

type ObjectMap

type ObjectMap struct {
	Name          string `yaml:"name"`
	SourcePath    string `yaml:"source_path"`
	SourceObjects []csgen.Struct
	TargetPath    string `yaml:"target_path"`
	TargetObjects []csgen.Struct
	Imports       []string      `yaml:"imports"`
	MapOverrides  []MapOverride `yaml:"map_overrides"`
}

ObjectMap is a struct that contains the source and destination paths for a single mapping.