Documentation
¶
Index ¶
- func GenerateDoc(pluginName string, specDirs []string, startAPIFunc func([]string) int)
- func GetInstallDir(pluginName, v string) (string, error)
- func GetLanguageJSONFilePath(language string) (string, error)
- func IsLanguagePlugin(plugin string) bool
- func IsPluginAdded(m *manifest.Manifest, descriptor *PluginDescriptor) bool
- func IsPluginInstalled(pluginName, pluginVersion string) bool
- func PluginsWithoutScope() (infos []pluginInfo.PluginInfo)
- func QueryParams() string
- func SetEnvForPlugin(action pluginScope, pd *PluginDescriptor, m *manifest.Manifest, ...) error
- type GaugePlugins
- type Handler
- type PluginDescriptor
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateDoc ¶ added in v0.5.0
func GetInstallDir ¶ added in v0.3.0
GetInstallDir returns the install directory of given plugin and a given version.
func GetLanguageJSONFilePath ¶ added in v0.3.0
func IsLanguagePlugin ¶ added in v0.9.0
func IsPluginAdded ¶
func IsPluginAdded(m *manifest.Manifest, descriptor *PluginDescriptor) bool
func IsPluginInstalled ¶
IsPluginInstalled checks if given plugin with specific version is installed or not.
func PluginsWithoutScope ¶ added in v0.9.3
func PluginsWithoutScope() (infos []pluginInfo.PluginInfo)
func QueryParams ¶ added in v0.4.0
func QueryParams() string
func SetEnvForPlugin ¶
Types ¶
type GaugePlugins ¶ added in v0.8.5
type GaugePlugins struct {
// contains filtered or unexported fields
}
GaugePlugins holds a reference to all plugins launched. The plugins are listed in project manifest
func (*GaugePlugins) GracefullyKillPlugins ¶ added in v0.8.5
func (gp *GaugePlugins) GracefullyKillPlugins()
GracefullyKillPlugins tells the plugins to stop, letting them cleanup whatever they need to
func (*GaugePlugins) NotifyPlugins ¶ added in v0.8.5
func (gp *GaugePlugins) NotifyPlugins(message *gauge_messages.Message)
NotifyPlugins passes a message to all plugins listed in the manifest
type Handler ¶ added in v0.3.0
type Handler interface {
NotifyPlugins(*gauge_messages.Message)
GracefullyKillPlugins()
}
Handler manages plugins listed in project manifest.
func StartPlugins ¶
type PluginDescriptor ¶ added in v1.0.9
type PluginDescriptor struct {
ID string
Version string
Name string
Description string
Command struct {
Windows []string
Linux []string
Darwin []string
}
Scope []string
GaugeVersionSupport version.VersionSupport
Capabilities []string
// contains filtered or unexported fields
}
func GetPluginDescriptor ¶
func GetPluginDescriptor(pluginID, pluginVersion string) (*PluginDescriptor, error)
GetPluginDescriptor return the information about the plugin including name, id, commands to start etc.
func GetPluginDescriptorFromJSON ¶ added in v0.3.0
func GetPluginDescriptorFromJSON(pluginJSON string) (*PluginDescriptor, error)
Source Files
Directories
Click to show internal directories.
Click to hide internal directories.