generate

Documentation

Overview

generate package provides the base of the generate command which allows to run generators for tools.

Index

• type AfterGenerator
• type Command
  • func (c Command) Alias() string
  • func (c Command) HelpText() string
  • func (c Command) Name() string
  • func (c Command) ParentName() string
  • func (c *Command) Receive(plugins []core.Plugin)
  • func (c *Command) Run(ctx context.Context, root string, args []string) error
• type Generator

Types

type AfterGenerator

type AfterGenerator interface {
	// AfterGenerate receives the context and other params so it can determine if should
	// run or not.
	core.Plugin
	AfterGenerate(context.Context, string, []string) error
}

After generator is something that runs after generators are executed.

type Command

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

func (Command) Alias

func (c Command) Alias() string

func (Command) HelpText

func (c Command) HelpText() string

func (Command) Name

func (c Command) Name() string

func (Command) ParentName

func (c Command) ParentName() string

func (*Command) Receive

func (c *Command) Receive(plugins []core.Plugin)

func (*Command) Run

func (c *Command) Run(ctx context.Context, root string, args []string) error

type Generator

type Generator interface {
	core.Plugin
	InvocationName() string
	Generate(context.Context, string, []string) error
}

Generator allows to identify those plugins that are generators.