plugcmds

package

v1.15.0 Latest Latest Go to latest Published: Jun 14, 2019 License: MIT Imports: 9 Imported by: 2

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

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 format

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

Listen adds a command for github.com/gobuffalo/events. This will listen for ALL events. Use ListenFor to listen to a regex of events.

func (a *Available) ListenFor(rx string, fn func(e events.Event) error) error

ListenFor adds a command for github.com/gobuffalo/events. This will only listen for events that match the regex provided.

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)