repositories

Documentation

Index

• func LoadCommandsFromInputs(commandLoader loaders.CommandLoader, inputs []string) ([]cmds.Command, error)
• func LoadRepositories(helpSystem *help.HelpSystem, rootCmd *cobra.Command, ...) ([]cmds.Command, error)
• type Directory
• type RemoveCallback
• type RenderNode
• type Repository
  • func NewRepository(options ...RepositoryOption) *Repository
  • func (r *Repository) Add(commands ...cmds.Command)
  • func (r *Repository) CollectCommands(prefix []string, recurse bool) []cmds.Command
  • func (r *Repository) FindNode(prefix []string) *TrieNode
  • func (r *Repository) GetRenderNode(prefix []string) (*RenderNode, bool)
  • func (r *Repository) LoadCommands(helpSystem *help.HelpSystem, options ...cmds.CommandDescriptionOption) error
  • func (r *Repository) Remove(prefixes ...[]string)
  • func (r *Repository) Watch(ctx context.Context, options ...watcher.Option) error
• type RepositoryOption
  • func WithCommandLoader(loader loaders.CommandLoader) RepositoryOption
  • func WithDirectories(directories ...Directory) RepositoryOption
  • func WithName(name string) RepositoryOption
  • func WithRemoveCallback(callback RemoveCallback) RepositoryOption
  • func WithUpdateCallback(callback UpdateCallback) RepositoryOption
• type TrieNode
  • func NewTrieNode(commands []cmds.Command, aliases []*alias.CommandAlias) *TrieNode
  • func (t *TrieNode) CollectCommands(prefix []string, recurse bool) []cmds.Command
  • func (t *TrieNode) FindCommand(path []string) (cmds.Command, bool)
  • func (t *TrieNode) FindNode(prefix []string) *TrieNode
  • func (t *TrieNode) InsertCommand(prefix []string, command cmds.Command)
  • func (t *TrieNode) Remove(prefix []string) []cmds.Command
  • func (r *TrieNode) ToRenderNode() *RenderNode
• type UpdateCallback

Functions

func LoadCommandsFromInputs

func LoadCommandsFromInputs(
	commandLoader loaders.CommandLoader,
	inputs []string,
) ([]cmds.Command, error)

func LoadRepositories

func LoadRepositories(
	helpSystem *help.HelpSystem,
	rootCmd *cobra.Command,
	repositories_ []*Repository,
	options ...cli.CobraParserOption,
) ([]cmds.Command, error)

Types

type Directory

type Directory struct {
	FS fs.FS
	// Root directories are relative to the FS
	RootDirectory    string
	RootDocDirectory string
	Name             string
	SourcePrefix     string
	WatchDirectory   string
}

type RemoveCallback

type RemoveCallback func(cmd cmds.Command) error

type RenderNode

type RenderNode struct {
	Name     string
	Command  cmds.Command
	Children []*RenderNode
}

type Repository

type Repository struct {
	Name        string
	Directories []Directory
	// The root of the repository.
	Root *TrieNode
	// contains filtered or unexported fields
}

func NewRepository

func NewRepository(options ...RepositoryOption) *Repository

NewRepository creates a new repository.

func (*Repository) Add

func (r *Repository) Add(commands ...cmds.Command)

func (*Repository) CollectCommands

func (r *Repository) CollectCommands(prefix []string, recurse bool) []cmds.Command

func (*Repository) FindNode

func (r *Repository) FindNode(prefix []string) *TrieNode

func (*Repository) GetRenderNode

func (r *Repository) GetRenderNode(prefix []string) (*RenderNode, bool)

func (*Repository) LoadCommands

func (r *Repository) LoadCommands(helpSystem *help.HelpSystem, options ...cmds.CommandDescriptionOption) error

LoadCommands initializes the repository by loading all commands from the loader, if available.

func (*Repository) Remove

func (r *Repository) Remove(prefixes ...[]string)

func (*Repository) Watch

func (r *Repository) Watch(
	ctx context.Context,
	options ...watcher.Option,
) error

type RepositoryOption

type RepositoryOption func(*Repository)

func WithCommandLoader

func WithCommandLoader(loader loaders.CommandLoader) RepositoryOption

WithCommandLoader sets the command loader to use when loading commands from the filesystem on startup or when a directory changes.

func WithDirectories

func WithDirectories(directories ...Directory) RepositoryOption

func WithName

func WithName(name string) RepositoryOption

func WithRemoveCallback

func WithRemoveCallback(callback RemoveCallback) RepositoryOption

func WithUpdateCallback

func WithUpdateCallback(callback UpdateCallback) RepositoryOption

type TrieNode

type TrieNode struct {
	Children map[string]*TrieNode
	Commands []cmds.Command
}

func NewTrieNode

func NewTrieNode(commands []cmds.Command, aliases []*alias.CommandAlias) *TrieNode

NewTrieNode creates a new trie node.

func (*TrieNode) CollectCommands

func (t *TrieNode) CollectCommands(prefix []string, recurse bool) []cmds.Command

CollectCommands collects all commands and aliases under the given prefix.

func (*TrieNode) FindCommand

func (t *TrieNode) FindCommand(path []string) (cmds.Command, bool)

func (*TrieNode) FindNode

func (t *TrieNode) FindNode(prefix []string) *TrieNode

func (*TrieNode) InsertCommand

func (t *TrieNode) InsertCommand(prefix []string, command cmds.Command)

InsertCommand inserts a command in the trie, replacing it if it already exists.

func (*TrieNode) Remove

func (t *TrieNode) Remove(prefix []string) []cmds.Command

Remove removes a command from the trie.

func (*TrieNode) ToRenderNode

func (r *TrieNode) ToRenderNode() *RenderNode

type UpdateCallback

type UpdateCallback func(cmd cmds.Command) error