cmds

Documentation

Index

• type BareCommand
• type Command
• type CommandDescription
  • func NewCommandDescription(name string, options ...CommandDescriptionOption) *CommandDescription
  • func (c *CommandDescription) Clone(cloneFlagsAndArguments bool, options ...CommandDescriptionOption) *CommandDescription
  • func (c *CommandDescription) GetFlagMap() map[string]*parameters.ParameterDefinition
• type CommandDescriptionOption
  • func WithArguments(a ...*parameters.ParameterDefinition) CommandDescriptionOption
  • func WithFlags(f ...*parameters.ParameterDefinition) CommandDescriptionOption
  • func WithLayers(l ...layers.ParameterLayer) CommandDescriptionOption
  • func WithLayout(l *layout.Layout) CommandDescriptionOption
  • func WithLong(s string) CommandDescriptionOption
  • func WithName(s string) CommandDescriptionOption
  • func WithParents(p ...string) CommandDescriptionOption
  • func WithPrependParents(p ...string) CommandDescriptionOption
  • func WithPrependSource(s string) CommandDescriptionOption
  • func WithReplaceArguments(args ...*parameters.ParameterDefinition) CommandDescriptionOption
  • func WithReplaceFlags(flags ...*parameters.ParameterDefinition) CommandDescriptionOption
  • func WithReplaceLayers(layers_ ...layers.ParameterLayer) CommandDescriptionOption
  • func WithShort(s string) CommandDescriptionOption
  • func WithSource(s string) CommandDescriptionOption
  • func WithStripParentsPrefix(prefixes []string) CommandDescriptionOption
• type ExitWithoutGlazeError
  • func (e *ExitWithoutGlazeError) Error() string
• type GlazeCommand
• type WriterCommand

Types

type BareCommand

type BareCommand interface {
	Command
	Run(
		ctx context.Context,
		parsedLayers map[string]*layers.ParsedParameterLayer,
		ps map[string]interface{},
	) error
}

type Command

type Command interface {
	Description() *CommandDescription
}

type CommandDescription

type CommandDescription struct {
	Name      string                            `yaml:"name"`
	Short     string                            `yaml:"short"`
	Long      string                            `yaml:"long,omitempty"`
	Layout    *layout.Layout                    `yaml:"layout,omitempty"`
	Flags     []*parameters.ParameterDefinition `yaml:"flags,omitempty"`
	Arguments []*parameters.ParameterDefinition `yaml:"arguments,omitempty"`
	Layers    []layers.ParameterLayer           `yaml:"layers,omitempty"`

	Parents []string `yaml:",omitempty"`
	// Source indicates where the command was loaded from, to make debugging easier.
	Source string `yaml:",omitempty"`
}

CommandDescription contains the necessary information for registering a command with cobra. Because a command gets registered in a verb tree, a full list of Parents all the way to the root needs to be provided.

func NewCommandDescription

func NewCommandDescription(name string, options ...CommandDescriptionOption) *CommandDescription

func (*CommandDescription) Clone

func (c *CommandDescription) Clone(cloneFlagsAndArguments bool, options ...CommandDescriptionOption) *CommandDescription

func (*CommandDescription) GetFlagMap

func (c *CommandDescription) GetFlagMap() map[string]*parameters.ParameterDefinition

type CommandDescriptionOption

type CommandDescriptionOption func(*CommandDescription)

func WithArguments

func WithArguments(a ...*parameters.ParameterDefinition) CommandDescriptionOption

func WithFlags

func WithFlags(f ...*parameters.ParameterDefinition) CommandDescriptionOption

func WithLayers

func WithLayers(l ...layers.ParameterLayer) CommandDescriptionOption

func WithLayout

func WithLayout(l *layout.Layout) CommandDescriptionOption

func WithLong

func WithLong(s string) CommandDescriptionOption

func WithName

func WithName(s string) CommandDescriptionOption

func WithParents

func WithParents(p ...string) CommandDescriptionOption

func WithPrependParents

func WithPrependParents(p ...string) CommandDescriptionOption

func WithPrependSource

func WithPrependSource(s string) CommandDescriptionOption

func WithReplaceArguments

func WithReplaceArguments(args ...*parameters.ParameterDefinition) CommandDescriptionOption

func WithReplaceFlags

func WithReplaceFlags(flags ...*parameters.ParameterDefinition) CommandDescriptionOption

func WithReplaceLayers

func WithReplaceLayers(layers_ ...layers.ParameterLayer) CommandDescriptionOption

func WithShort

func WithShort(s string) CommandDescriptionOption

func WithSource

func WithSource(s string) CommandDescriptionOption

func WithStripParentsPrefix

func WithStripParentsPrefix(prefixes []string) CommandDescriptionOption

type ExitWithoutGlazeError

type ExitWithoutGlazeError struct{}

func (*ExitWithoutGlazeError) Error

func (e *ExitWithoutGlazeError) Error() string

type GlazeCommand

type GlazeCommand interface {
	Command
	// Run is called to actually execute the command.
	//
	// NOTE(manuel, 2023-02-27) We can probably simplify this to only take parsed layers
	//
	// The ps and GlazeProcessor calls could be replaced by a GlazeCommand specific layer,
	// which would allow the GlazeCommand to parse into a specific struct. The GlazeProcessor
	// is just something created by the passed in GlazeLayer anyway.
	//
	// When we are just left with building a convenience wrapper for Glaze based commands,
	// instead of forcing it into the upstream interface.
	//
	// https://github.com/go-go-golems/glazed/issues/217
	// https://github.com/go-go-golems/glazed/issues/216
	// See https://github.com/go-go-golems/glazed/issues/173
	Run(
		ctx context.Context,
		parsedLayers map[string]*layers.ParsedParameterLayer,
		ps map[string]interface{},
		gp processor.Processor,
	) error
}

type WriterCommand

type WriterCommand interface {
	Command
	RunIntoWriter(
		ctx context.Context,
		parsedLayers map[string]*layers.ParsedParameterLayer,
		ps map[string]interface{},
		w io.Writer,
	) error
}