extension

Documentation

Index

• func NewVersionCobraCmd(opts ...CobraOption) *cobra.Command
• type AliasesOptions
  • func WithAliasesOptions(aliases ...string) *AliasesOptions
  • func (c *AliasesOptions) ApplyToCobraOption(options *CobraOptions)
• type CobraOption
• type CobraOptions
• type CustomPrinterOptions
  • func WithPrinterOptions(opts ...printer.ContainerOption) *CustomPrinterOptions
  • func (c *CustomPrinterOptions) ApplyToCobraOption(options *CobraOptions)
• type EnableUpgradeNotice
  • func WithUpgradeNotice(owner, repo string, opts ...upgrade.Options) *EnableUpgradeNotice
  • func (c *EnableUpgradeNotice) ApplyToCobraOption(options *CobraOptions)
• type HookFunc
• type PostHook
  • func WithPostHook(fn HookFunc) *PostHook
  • func (c *PostHook) ApplyToCobraOption(options *CobraOptions)
• type PreHook
  • func WithPreHook(fn HookFunc) *PreHook
  • func (c *PreHook) ApplyToCobraOption(options *CobraOptions)

Functions

func NewVersionCobraCmd

func NewVersionCobraCmd(opts ...CobraOption) *cobra.Command

NewVersionCobraCmd returns a root cobra.Command for printing CLI version.

Types

type AliasesOptions

type AliasesOptions struct {
	// contains filtered or unexported fields
}

AliasesOptions provides an option to set a custom printer related options across multiple constructors.

func WithAliasesOptions

func WithAliasesOptions(aliases ...string) *AliasesOptions

WithAliasesOptions sets a given aliases for the 'version' command.

func (*AliasesOptions) ApplyToCobraOption

func (c *AliasesOptions) ApplyToCobraOption(options *CobraOptions)

ApplyToCobraOption sets a given option for Cobra.

type CobraOption

type CobraOption interface {
	// ApplyToCobraOption sets a given option for Cobra command.
	ApplyToCobraOption(*CobraOptions)
}

CobraOption provides an option to set a Cobra options.

type CobraOptions

type CobraOptions struct {
	PrinterOptions []printer.ContainerOption
	Aliases        []string
	PreHook        HookFunc
	PostHook       HookFunc
}

CobraOptions holds Cobra command possible customization settings.

type CustomPrinterOptions

type CustomPrinterOptions struct {
	// contains filtered or unexported fields
}

CustomPrinterOptions provides an option to set a custom printer related options across multiple constructors.

func WithPrinterOptions

func WithPrinterOptions(opts ...printer.ContainerOption) *CustomPrinterOptions

WithPrinterOptions sets a custom printer related options.

func (*CustomPrinterOptions) ApplyToCobraOption

func (c *CustomPrinterOptions) ApplyToCobraOption(options *CobraOptions)

ApplyToCobraOption sets a given option for Cobra.

type EnableUpgradeNotice

type EnableUpgradeNotice struct {
	// contains filtered or unexported fields
}

EnableUpgradeNotice provides an option to enable upgrade notice across multiple constructors.

func WithUpgradeNotice

func WithUpgradeNotice(owner, repo string, opts ...upgrade.Options) *EnableUpgradeNotice

WithUpgradeNotice enables upgrade notice.

func (*EnableUpgradeNotice) ApplyToCobraOption

func (c *EnableUpgradeNotice) ApplyToCobraOption(options *CobraOptions)

ApplyToCobraOption sets a given option for Cobra. It's a syntax sugar for:

extension.NewVersionCobraCmd(
	extension.WithPrinterOptions(
		printer.WithUpgradeNotice("mszostok", "codeowners-validator"),
	),
)

so you can just do: extension.NewVersionCobraCmd(

	extension.WithUpgradeNotice("mszostok", "codeowners-validator"),
)

type HookFunc

type HookFunc func(ctx context.Context) error

HookFunc represents post execution function signature.

type PostHook

type PostHook struct {
	// contains filtered or unexported fields
}

PostHook provides an option to set post execution function across multiple constructors.

func WithPostHook

func WithPostHook(fn HookFunc) *PostHook

WithPostHook sets post execution function.

func (*PostHook) ApplyToCobraOption

func (c *PostHook) ApplyToCobraOption(options *CobraOptions)

ApplyToCobraOption sets a given option for Cobra.

type PreHook

type PreHook struct {
	// contains filtered or unexported fields
}

PreHook provides an option to set pre execution function across multiple constructors.

func WithPreHook

func WithPreHook(fn HookFunc) *PreHook

WithPreHook sets pre execution function.

func (*PreHook) ApplyToCobraOption

func (c *PreHook) ApplyToCobraOption(options *CobraOptions)

ApplyToCobraOption sets a given option for Cobra.