loaders

Documentation

Index

• func FileNameToFsFilePath(fileName string) (fs.FS, string, error)
• func GetParentsFromDir(dir string) []string
• func LoadCommandAliasFromYAML(s io.Reader, options ...alias.Option) ([]*alias.CommandAlias, error)
• func LoadCommandOrAliasFromReader(r io.Reader, rawLoadCommand LoadReaderCommandFunc, ...) ([]cmds.Command, error)
• func LoadCommandsFromFS(f fs.FS, dir string, source string, loader CommandLoader, ...) ([]cmds.Command, error)
• type BaseCommand
• type CommandLoader
• type LoadReaderCommandFunc
• type MultiLoader
  • func NewMultiLoader() *MultiLoader
  • func (m *MultiLoader) IsFileSupported(f fs.FS, fileName string) bool
  • func (m *MultiLoader) LoadCommands(f fs.FS, entryName string, options []cmds.CommandDescriptionOption, ...) ([]cmds.Command, error)
  • func (m *MultiLoader) RegisterLoader(typeName string, loader CommandLoader)
  • func (m *MultiLoader) SetDefaultLoader(loader CommandLoader)

Functions

func FileNameToFsFilePath

func FileNameToFsFilePath(fileName string) (fs.FS, string, error)

func GetParentsFromDir

func GetParentsFromDir(dir string) []string

GetParentsFromDir is a helper function to simply return a list of parent verbs for applications loaded from declarative yaml files. The directory structure mirrors the verb structure in cobra.

func LoadCommandAliasFromYAML

func LoadCommandAliasFromYAML(s io.Reader, options ...alias.Option) ([]*alias.CommandAlias, error)

func LoadCommandOrAliasFromReader

func LoadCommandOrAliasFromReader(
	r io.Reader,
	rawLoadCommand LoadReaderCommandFunc,
	options []cmds.CommandDescriptionOption,
	aliasOptions []alias.Option,
) ([]cmds.Command, error)

func LoadCommandsFromFS

func LoadCommandsFromFS(
	f fs.FS,
	dir string,
	source string,
	loader CommandLoader,
	options []cmds.CommandDescriptionOption,
	aliasOptions []alias.Option,
) ([]cmds.Command, error)

LoadCommandsFromFS walks the FS and loads all commands and command aliases found.

TODO(manuel, 2023-03-16) Add loading of helpsystem files See https://github.com/go-go-golems/glazed/issues/55 See https://github.com/go-go-golems/glazed/issues/218

Types

type BaseCommand

type BaseCommand struct {
	Type string `yaml:"type" json:"type"`
}

BaseCommand represents the minimal structure needed to determine the type of a command

type CommandLoader

type CommandLoader interface {
	LoadCommands(
		f fs.FS, entryName string,
		options []cmds.CommandDescriptionOption,
		aliasOptions []alias.Option,
	) ([]cmds.Command, error)
	IsFileSupported(f fs.FS, fileName string) bool
}

CommandLoader is an interface that describes the most generic loader type, which is then used to load commands and command aliases from embedded queries and from "repository" directories used by glazed.

Examples of this pattern are used in sqleton, escuse-me and pinocchio.

type LoadReaderCommandFunc

type LoadReaderCommandFunc func(
	r io.Reader,
	options []cmds.CommandDescriptionOption,
	aliasOptions []alias.Option,
) ([]cmds.Command, error)

type MultiLoader

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

MultiLoader implements CommandLoader and dispatches to registered loaders based on the Type field

func NewMultiLoader

func NewMultiLoader() *MultiLoader

NewMultiLoader creates a new MultiLoader instance

func (*MultiLoader) IsFileSupported

func (m *MultiLoader) IsFileSupported(f fs.FS, fileName string) bool

IsFileSupported implements the CommandLoader interface

func (*MultiLoader) LoadCommands

func (m *MultiLoader) LoadCommands(
	f fs.FS,
	entryName string,
	options []cmds.CommandDescriptionOption,
	aliasOptions []alias.Option,
) ([]cmds.Command, error)

LoadCommands implements the CommandLoader interface

func (*MultiLoader) RegisterLoader

func (m *MultiLoader) RegisterLoader(typeName string, loader CommandLoader)

RegisterLoader registers a new loader for a specific type

func (*MultiLoader) SetDefaultLoader

func (m *MultiLoader) SetDefaultLoader(loader CommandLoader)

SetDefaultLoader sets the default loader to use when no Type field is present