Documentation
¶
Index ¶
- func AddPluginCommandStubs(dockerCLI config.Provider, rootCmd *cobra.Command) (err error)
- func IsPluginCommand(cmd *cobra.Command) bool
- func PluginRunCommand(dockerCli config.Provider, name string, rootcmd *cobra.Command) (*exec.Cmd, error)
- func RunCLICommandHooks(ctx context.Context, dockerCLI config.Provider, ...)
- func RunPluginHooks(ctx context.Context, dockerCLI config.Provider, ...)
- type HookPluginData
- type Plugin
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func AddPluginCommandStubs ¶
AddPluginCommandStubs adds a stub cobra.Commands for each valid and invalid plugin. The command stubs will have several annotations added, see `CommandAnnotationPlugin*`.
func IsPluginCommand ¶
IsPluginCommand checks if the given cmd is a plugin-stub.
func PluginRunCommand ¶
func PluginRunCommand(dockerCli config.Provider, name string, rootcmd *cobra.Command) (*exec.Cmd, error)
PluginRunCommand returns an os/exec.Cmd which when os/exec.Cmd.Run will execute the named plugin. The rootcmd argument is referenced to determine the set of builtin commands in order to detect conficts. The error returned satisfies the errdefs.IsNotFound predicate if no plugin was found or if the first candidate plugin was invalid somehow.
func RunCLICommandHooks ¶
func RunCLICommandHooks(ctx context.Context, dockerCLI config.Provider, rootCmd, subCommand *cobra.Command, cmdErrorMessage string)
RunCLICommandHooks is the entrypoint into the hooks execution flow after a main CLI command was executed. It calls the hook subcommand for all present CLI plugins that declare support for hooks in their metadata and parses/prints their responses.
Types ¶
type HookPluginData ¶
type HookPluginData struct {
// RootCmd is a string representing the matching hook configuration
// which is currently being invoked. If a hook for `docker context` is
// configured and the user executes `docker context ls`, the plugin will
// be invoked with `context`.
RootCmd string
Flags map[string]string
CommandError string
}
HookPluginData is the type representing the information that plugins declaring support for hooks get passed when being invoked following a CLI command execution.
type Plugin ¶
type Plugin struct {
metadata.Metadata
Name string `json:",omitempty"`
Path string `json:",omitempty"`
// Err is non-nil if the plugin failed one of the candidate tests.
Err error `json:",omitempty"`
// ShadowedPaths contains the paths of any other plugins which this plugin takes precedence over.
ShadowedPaths []string `json:",omitempty"`
}
Plugin represents a potential plugin with all it's metadata.
func ListPlugins ¶
ListPlugins produces a list of the plugins available on the system
func (*Plugin) MarshalJSON ¶
MarshalJSON implements json.Marshaler to handle marshaling the [Plugin.Err] field (Go doesn't marshal errors by default).
Source Files