plugcmd

package

v0.0.0-...-289cda9 Latest Latest Go to latest Published: Apr 5, 2020 License: MIT Imports: 5 Imported by: 11

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.

func ByAliaser(f plugfind.Finder) plugfind.Finder

DEPRECRATED: ByAliaser can be used to search plugins that implement Aliaser and who's alias matches the name

func ByCommander(f plugfind.Finder) plugfind.FinderFn

DEPRECRATED: ByCommander can be used to search for plugins that implement Commander and who's plugin name matches the name

func ByNamer(f plugfind.Finder) plugfind.Finder

DEPRECRATED: ByNamer can be used to search for plugins that implement Namer and who's CmdName matches the name

type Aliaser interface {
	plugins.Plugin
	CmdAliases() []string
}

Aliaser is a command that provides aliases for itself

type Commander interface {
	plugins.Plugin
	Main(ctx context.Context, root string, args []string) error
}

Commander is a plugin that is meant to be the beginning of a CLI application

func Find(name string, plugs []plugins.Plugin) Commander

Find wraps the other cmd finders into a mega finder for cmds

func FindFromArgs(args []string, plugs []plugins.Plugin) Commander

FindFromArgs uses the first arg that does not begin with `-` as the name argument for Find

type Namer interface {
	plugins.Plugin
	CmdName() string
}

Namer is a command that provides a different name for the command than the name of the Plugin

type SubCommander interface {
	SubCommands() []plugins.Plugin
}

SubCommander can be implemented to provide a list of plugins.Plugin that can be used as sub-commands of the current Plugin