examples

package

v1.11.3 Latest Latest Go to latest Published: Feb 7, 2026 License: MIT Imports: 5 Imported by: 0

Details

Package examples provides example plugins for Buffalo This demonstrates how to create a simple validator plugin

This section is empty.

This section is empty.

func DefaultConfig() plugin.Config

DefaultConfig returns the default configuration for this plugin

func New() plugin.Plugin

New creates a new instance of the naming validator plugin This function is required and will be called by the plugin loader

type NamingValidator struct {
	// contains filtered or unexported fields
}

NamingValidator validates proto file naming conventions

func (v *NamingValidator) Description() string

Description returns a description of what this plugin does

func (v *NamingValidator) Execute(ctx context.Context, input *plugin.Input) (*plugin.Output, error)

Execute runs the validation logic

func (v *NamingValidator) Init(config plugin.Config) error

Init initializes the plugin with configuration

func (v *NamingValidator) Name() string

Name returns the plugin name

func (v *NamingValidator) Shutdown() error

Shutdown performs cleanup

func (v *NamingValidator) Type() plugin.PluginType

Type returns the plugin type

func (v *NamingValidator) ValidationRules() []string

ValidationRules returns the rules this validator checks

func (v *NamingValidator) Version() string

Version returns the plugin version