Documentation
¶
Overview ¶
Package plugincommand implements plugin discovery, installation, inspection and authoring commands.
Index ¶
- func DeclaredPlugin(ctx context.Context, project *installation.Project, ...) (int, error)
- func RequestedPlugin(name string, options RegistryOptions, existing []pluginreference.Reference) (pluginreference.Reference, error)
- func RequestedPluginIndex(ref pluginreference.Reference, registry string, ...) (int, error)
- type InspectOptions
- type Operation
- type RegistryOptions
- type RegistryRequest
- type TestOptions
- type ValidateOptions
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func DeclaredPlugin ¶
func DeclaredPlugin(ctx context.Context, project *installation.Project, refs []pluginreference.Reference, name, registry string) (int, error)
DeclaredPlugin resolves command spelling against declarations and recorded pins only. A shorthand from another registry never selects this declaration.
func RequestedPlugin ¶
func RequestedPlugin(name string, options RegistryOptions, existing []pluginreference.Reference) (pluginreference.Reference, error)
func RequestedPluginIndex ¶
func RequestedPluginIndex(ref pluginreference.Reference, registry string, existing []pluginreference.Reference) (int, error)
RequestedPluginIndex finds the existing declaration for this repository. Aliases stay scoped to the registry that assigns them.
Types ¶
type InspectOptions ¶
func (InspectOptions) Run ¶
func (r InspectOptions) Run(ctx context.Context, streams output.Streams, acquisition dependencycache.Acquisition) (int, error)
Run reads plugin metadata without executing the plugin.
type RegistryOptions ¶
type RegistryRequest ¶
type RegistryRequest struct {
Operation Operation
Options RegistryOptions
Paths []string
Config configuration.ConfigFileSelection
JSON bool
}
func (RegistryRequest) Run ¶
func (r RegistryRequest) Run(ctx context.Context, streams output.Streams, acquisition dependencycache.Acquisition) (int, error)
Run executes the plugin registry operation.
type TestOptions ¶
func (TestOptions) Run ¶
func (r TestOptions) Run(ctx context.Context, streams output.Streams, _ dependencycache.Acquisition) (int, error)
Run applies the manifest transforms to fixtures without running its tool.
type ValidateOptions ¶
func (ValidateOptions) Run ¶
func (r ValidateOptions) Run(ctx context.Context, streams output.Streams, _ dependencycache.Acquisition) (int, error)
Run validates the manifest without running its tool.
Click to show internal directories.
Click to hide internal directories.