cmdrplugin

package module

v1.0.0 Latest Latest Go to latest Published: Feb 12, 2023 License: MIT Imports: 0 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

The basic infrastructures for cmdr.

v1.0.0: no needs for changing anything so we freeze it and publish as v1 stable.
v0.1.3: first release

Package cmdrplugin is a very predecessor for hedzr/cmdr library, which provides the PluginEntry and relevant declarations for cmdr.

This section is empty.

This section is empty.

This section is empty.

type PluginCmd interface {
	PluginCompBase
	SubCommands() []PluginCmd
	Flags() []PluginFlag
	Action(args []string) (err error)
}

PluginCmd a command of an addon

type PluginCompBase interface {
	Name() string
	ShortName() string
	Aliases() []string
	Description() string
}

PluginCompBase component for cmd and flag of an addon

type PluginEntry interface {
	PluginCmd
	AddonTitle() string
	AddonDescription() string
	AddonCopyright() string
	AddonVersion() string
}

PluginEntry entry of an addon (golang plugin)

type PluginFlag interface {
	PluginCompBase
	DefaultValue() interface{}
	PlaceHolder() string
	Action() (err error) // onSet
}

PluginFlag a flag of a command of an addon