types

Documentation

Index

• type Config
• type Help
• type PluginResult
• type TypeMapping

Types

type Config

type Config struct {
	Name    string
	Version string
	Prefix  string
	Help    Help
}

Config provides Kombustion with information about your plugin

type Help

type Help struct {
	// The name of the plugin
	Name string
	// A short description of what the plugin does
	Description string

	// Help information for all the types this pplugin provides
	TypeMappings []TypeMapping

	// Examples/Snippets of how this plugin can be used
	Snippets []string
}

Help - a set of available documentation fields

type PluginResult

type PluginResult struct {
	Data   kombustionTypes.TemplateObject
	Errors []error
}

PluginResult result of a parserFunc

type TypeMapping

type TypeMapping struct {
	Name        string
	Description string
	Config      interface{}
}

TypeMapping - recursive list of types with its associated config object