cmdrplugin

README

cmdr-base

The basic infrastructures for cmdr.

History

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

Documentation

Overview

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

Index

• type PluginCmd
• type PluginCompBase
• type PluginEntry
• type PluginFlag

Types

type PluginCmd

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

PluginCmd a command of an addon

type PluginCompBase

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

PluginCompBase component for cmd and flag of an addon

type PluginEntry

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

PluginEntry entry of an addon (golang plugin)

type PluginFlag

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

PluginFlag a flag of a command of an addon