plugcmds

package

v1.4.1 Latest Latest Go to latest Published: Oct 17, 2018 License: MIT Imports: 8 Imported by: 2

Details

This section is empty.

This section is empty.

This section is empty.

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

Available used to manage all of the available commands for the plugin

func NewAvailable() *Available

NewAvailable returns a fully formed Available type

func (a *Available) Add(bufCmd string, cmd *cobra.Command) error

Add a new command to this list of available ones. The bufCmd should corresponding buffalo command that command should live below.

Special "commands":

"root" - is the `buffalo` command
"events" - listens for emitted events

func (a Available) Cmd() *cobra.Command

Cmd returns the "available" command

func (a Available) Commands() []*cobra.Command

Commands returns all of the commands that are available

func (a *Available) Encode(w io.Writer) error

Encode into the required Buffalo plugins available formate

func (a *Available) Listen(fn func(e events.Event) error) error

Adds a Listen command for github.com/gobuffalo/events.

func (a Available) Mount(cmd *cobra.Command)

Mount all of the commands that are available on to the other command. This is the recommended approach for using Available.

a.Mount(rootCmd)