ui

Documentation

Index

• Variables
• func RunUI(c Controller, opts Options) error
• func SelectProvider(providers []config.ProviderDoc) (string, map[string]string, error)
• type Controller
• type FakeController
  • func NewFakeController() *FakeController
  • func (f *FakeController) DeleteHistory(entry ctrl.HistoryEntry) error
  • func (f *FakeController) GenerateCommands(string) ([]string, error)
  • func (f *FakeController) LoadHistory() []ctrl.HistoryEntry
  • func (f *FakeController) UpdateHistory(prompt, command string) error
• type KeyMap
  • func DefaultKeyMap() KeyMap
• type Model
  • func New(c Controller) Model
  • func (m Model) FullHelp() [][]key.Binding
  • func (m Model) Init() tea.Cmd
  • func (m Model) ShortHelp() []key.Binding
  • func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)
  • func (m Model) View() string
• type Options

Variables

var ErrUserCancel = errors.New("user cancelled")

Functions

func RunUI

func RunUI(c Controller, opts Options) error

RunUI starts the gencmd UI with the provided controller and options.

func SelectProvider

func SelectProvider(providers []config.ProviderDoc) (string, map[string]string, error)

SelectProvider allows the user to select a provider and input its configuration.

Types

type Controller

type Controller interface {
	LoadHistory() []ctrl.HistoryEntry
	UpdateHistory(prompt, command string) error
	DeleteHistory(entry ctrl.HistoryEntry) error
	GenerateCommands(prompt string) ([]string, error)
}

type FakeController

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

func NewFakeController

func NewFakeController() *FakeController

func (*FakeController) DeleteHistory

func (f *FakeController) DeleteHistory(entry ctrl.HistoryEntry) error

func (*FakeController) GenerateCommands

func (f *FakeController) GenerateCommands(string) ([]string, error)

func (*FakeController) LoadHistory

func (f *FakeController) LoadHistory() []ctrl.HistoryEntry

func (*FakeController) UpdateHistory

func (f *FakeController) UpdateHistory(prompt, command string) error

type KeyMap

type KeyMap struct {
	Submit        key.Binding
	Cancel        key.Binding
	Up            key.Binding
	Down          key.Binding
	ToggleHistory key.Binding
	DeleteHistory key.Binding
	ToggleHelp    key.Binding
}

func DefaultKeyMap

func DefaultKeyMap() KeyMap

type Model

type Model struct {
	KeyMap KeyMap
	// contains filtered or unexported fields
}

func New

func New(c Controller) Model

func (Model) FullHelp

func (m Model) FullHelp() [][]key.Binding

func (Model) Init

func (m Model) Init() tea.Cmd

func (Model) ShortHelp

func (m Model) ShortHelp() []key.Binding

func (Model) Update

func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd)

func (Model) View

func (m Model) View() string

type Options

type Options struct {
	TtyPath string
}