builder

Documentation

Index

• type CompositionConfig
• type Initialization
• type RewriteRule
  • func AddOption(selector Selector, newOption veneers.Option) RewriteRule
  • func ComposeBuilders(selector Selector, config CompositionConfig) RewriteRule
  • func DefaultToConstant(selector Selector, options []string) RewriteRule
  • func Duplicate(selector Selector, duplicateName string, excludeOptions []string) RewriteRule
  • func Initialize(selector Selector, statements []Initialization) RewriteRule
  • func MergeInto(selector Selector, sourceBuilderName string, underPath string, ...) RewriteRule
  • func Omit(selector Selector) RewriteRule
  • func PromoteOptionsToConstructor(selector Selector, optionNames []string) RewriteRule
  • func Properties(selector Selector, properties []ast.StructField) RewriteRule
  • func Rename(selector Selector, newName string) RewriteRule
  • func VeneerTrailAsComments(selector Selector) RewriteRule
• type Selector
  • func ByName(pkg string, builderName string) Selector
  • func ByObjectName(pkg string, objectName string) Selector
  • func ByVariant(variant ast.SchemaVariant) Selector
  • func EveryBuilder() Selector
  • func StructGeneratedFromDisjunction() Selector

Types

type CompositionConfig

type CompositionConfig struct {
	// SourceBuilderName refers to the builder to use as a source for the
	// composition. Builders for "composable" objects will be composed into
	// this source builder following the mapping defined in the CompositionMap
	// field.
	// Note: The builder name must follow the [package].[builder_name] pattern.
	// Example: "dashboard.Panel"
	SourceBuilderName string

	// PluginDiscriminatorField contains the name of the field used to identify
	// the plugin implementing this object.
	// Example: "type", "kind", ...
	PluginDiscriminatorField string

	// Composition map describes how to perform the composition.
	// Each entry in this map associates a builder (referenced by its name)
	// to a path under witch the assignments should be performed.
	//
	// Example:
	// “`go
	// compositionMap := map[string]string{
	//   "Options": "options",
	//   "FieldConfig": "fieldConfig.defaults.custom",
	// }
	// “`
	CompositionMap map[string]string

	// ExcludeOptions lists option names to exclude in the resulting
	// composed builders.
	ExcludeOptions []string

	// ComposedBuilderName configures the name of the newly composed builders.
	// If left empty, the name is taken from SourceBuilderName.
	ComposedBuilderName string
}

type Initialization

type Initialization struct {
	PropertyPath string
	Value        any
}

type RewriteRule

type RewriteRule func(schemas ast.Schemas, builders ast.Builders) (ast.Builders, error)

func AddOption

func AddOption(selector Selector, newOption veneers.Option) RewriteRule

AddOption adds a completely new option to the selected builders.

func ComposeBuilders

func ComposeBuilders(selector Selector, config CompositionConfig) RewriteRule

func DefaultToConstant

func DefaultToConstant(selector Selector, options []string) RewriteRule

DefaultToConstant sets a default value into a constant. When we unfold a value, omit an option, or any other action; we can lose the default value in the Builder struct. If we parse the defaults using the Builder and not the Schema, we might not have all the defaults and with this rule, we set these defaults as constants inside the constructor.

func Duplicate

func Duplicate(selector Selector, duplicateName string, excludeOptions []string) RewriteRule

func Initialize

func Initialize(selector Selector, statements []Initialization) RewriteRule

func MergeInto

func MergeInto(selector Selector, sourceBuilderName string, underPath string, excludeOptions []string, renameOptions map[string]string) RewriteRule

func Omit

func Omit(selector Selector) RewriteRule

func PromoteOptionsToConstructor

func PromoteOptionsToConstructor(selector Selector, optionNames []string) RewriteRule

PromoteOptionsToConstructor promotes the given options as constructor parameters. Both arguments and assignments described by the options will be exposed in the builder's constructor.

func Properties

func Properties(selector Selector, properties []ast.StructField) RewriteRule

func Rename

func Rename(selector Selector, newName string) RewriteRule

func VeneerTrailAsComments

func VeneerTrailAsComments(selector Selector) RewriteRule

type Selector

type Selector func(schemas ast.Schemas, builder ast.Builder) bool

func ByName

func ByName(pkg string, builderName string) Selector

ByName matches builders for the given name. Note: the comparison on builder name is case-insensitive.

func ByObjectName

func ByObjectName(pkg string, objectName string) Selector

ByObjectName matches builders for the given the object (referred to by its package and name). Note: the comparison on object name is case-insensitive.

func ByVariant

func ByVariant(variant ast.SchemaVariant) Selector

ByVariant matches builders defined within a schema marked as "composable" and implementing the given variant.

func EveryBuilder

func EveryBuilder() Selector

EveryBuilder accepts any given builder.

func StructGeneratedFromDisjunction

func StructGeneratedFromDisjunction() Selector

StructGeneratedFromDisjunction matches builders for structs that were generated from a disjunction (see the Disjunction compiler pass).