gen_plugin

Documentation

Index

• Constants
• Variables
• func ValidateHookName(name string) error
• func ValidateHooks(str string) (names []string, err error)
• type Var
  • func (v *Var) Execute(file, tmplName, tmpl string) error

Constants

const ConfigTemplate = `` /* 474-byte string literal not displayed */

const HookTemplate = `` /* 541-byte string literal not displayed */

const MainTemplate = `` /* 772-byte string literal not displayed */

Variables

var Command = &cobra.Command{
	Use:   "plugin",
	Short: "code generator",
	Example: "The following command will generate a code template for the 'awesome' plugin, which makes use of OnBasicAuth and OnSubscribe hook and enables the configuration in ./plugin directory.\n" +
		"\n" +
		"gmqctl gen plugin -n awesome -H OnBasicAuth,OnSubscribe -c true -o ./plugin",
}

Functions

func ValidateHookName

func ValidateHookName(name string) error

ValidateHookName returns an error when the given hook name is invalid

func ValidateHooks

func ValidateHooks(str string) (names []string, err error)

ValidateHooks parse the input string into hook name slice. Return an error when any of the names is invalid.

Types

type Var

type Var struct {
	// Name is the plugin name. Snack style.
	Name string
	// StrutName is the struct name. Camel style.
	StrutName string
	// Receiver is the struct method receiver.
	Receiver string
	// Hooks is the hooks used in the plugin.
	Hooks []string
	// Config indicates whether the plugin use  configuration.
	Config bool
}

Var is the template variable for all templates

func (*Var) Execute

func (v *Var) Execute(file, tmplName, tmpl string) error

Execute executes the template into file with Var as variable.