Documentation
¶
Index ¶
- func EnsureConfiguredPlugins(engineType engine.EngineType, version string) (int, error)
- func EnsurePlugin(pluginName string, engineType engine.EngineType, version string) error
- func EnsurePluginDir(version string) (string, error)
- func EnsurePlugins(plugins []string, engineType engine.EngineType, version string, ...) (int, error)
- func GetPluginLocalPath(pluginName string, engineType engine.EngineType, version string) (fileName string, localPath string, err error)
- func ListDefaultPlugins() ([]string, error)
- func ListVersionDirs() ([]string, error)
- func UninstallPlugin(pluginName string, engineType engine.EngineType, version string) (bool, error)
- func UninstallPlugins(plugins []string, engineType engine.EngineType, version string, ...) (int, error)
- type PluginMetadata
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func EnsureConfiguredPlugins ¶
func EnsureConfiguredPlugins(engineType engine.EngineType, version string) (int, error)
EnsureConfiguredPlugins collects the plugins from both the global CLI config, as well those within the current configuration context, such as config files within the working directory
func EnsurePlugin ¶
func EnsurePlugin(pluginName string, engineType engine.EngineType, version string) error
func EnsurePluginDir ¶
func EnsurePlugins ¶
func GetPluginLocalPath ¶
func GetPluginLocalPath( pluginName string, engineType engine.EngineType, version string, ) (fileName string, localPath string, err error)
GetPluginLocalPath returns the plugin file name and the local file path for the specified plugin name, engine type, and version.
func ListDefaultPlugins ¶
func ListVersionDirs ¶
ListVersionDirs returns the names of the versioned directories under the plugin base dir. This is only the list of versions, not fully qualified paths.
func UninstallPlugin ¶
UninstallPlugin removes a single plugin from disk. Returns true if the plugin was installed and removed, false if it wasn't installed.
func UninstallPlugins ¶
func UninstallPlugins(plugins []string, engineType engine.EngineType, version string, removeDefault bool) (int, error)
UninstallPlugins removes the specified plugins from disk and optionally from the default plugins configuration.
Types ¶
type PluginMetadata ¶
type PluginMetadata struct {
Name string
EngineType engine.EngineType
Version string
}
func List ¶
func List(engineType engine.EngineType, version string) ([]PluginMetadata, error)
List returns a list of available plugins for the specified engine type and version.
Source Files