Documentation
¶
Overview ¶
Package tui is the bubbletea terminal UI behind `capysquash tui` and the --tui flags.
Index ¶
- Constants
- func Launch(migrationDir, configPath string) error
- func LaunchWithView(migrationDir, configPath string, view ViewType) error
- type AnalysisCompleteMsg
- type AnalysisStats
- type ConfigSavedMsg
- type DependencyInfo
- type ErrorMsg
- type KeyCapturer
- type LifecyclePattern
- type LoadedMsg
- type LoadingMsg
- type Model
- type NavigateMsg
- type SquashCompleteMsg
- type SquashStats
- type SuccessMsg
- type View
- type ViewType
Constants ¶
const ( ViewDashboard = viewtypes.ViewDashboard ViewAnalysis = viewtypes.ViewAnalysis ViewConfig = viewtypes.ViewConfig ViewDependencyGraph = viewtypes.ViewDependencyGraph ViewProgress = viewtypes.ViewProgress ViewHelp = viewtypes.ViewHelp ViewValidation = viewtypes.ViewValidation )
Variables ¶
This section is empty.
Functions ¶
func Launch ¶
Launch is a convenience function that creates and runs a TUI in one step. This is the simplest way to start the TUI with default settings.
Example:
if err := tui.Launch("./migrations", "capysquash.config.json"); err != nil {
log.Fatal(err)
}
func LaunchWithView ¶
LaunchWithView is a convenience function that creates and runs a TUI, immediately navigating to the specified view.
Example:
// Launch directly into analysis view
if err := tui.LaunchWithView("./migrations", "", tui.ViewAnalysis); err != nil {
log.Fatal(err)
}
Types ¶
type AnalysisCompleteMsg ¶
type AnalysisCompleteMsg = viewtypes.AnalysisCompleteMsg
Re-export message types for convenience
type AnalysisStats ¶
type AnalysisStats = viewtypes.AnalysisStats
Re-export message types for convenience
type ConfigSavedMsg ¶
type ConfigSavedMsg = viewtypes.ConfigSavedMsg
Re-export message types for convenience
type DependencyInfo ¶
type DependencyInfo = viewtypes.DependencyInfo
Re-export message types for convenience
type KeyCapturer ¶ added in v1.2.0
type KeyCapturer = viewtypes.KeyCapturer
Re-export KeyCapturer for convenience
type LifecyclePattern ¶
type LifecyclePattern = viewtypes.LifecyclePattern
Re-export message types for convenience
type Model ¶
type Model struct {
// contains filtered or unexported fields
}
Model is the main TUI application model
type SquashCompleteMsg ¶
type SquashCompleteMsg = viewtypes.SquashCompleteMsg
Re-export message types for convenience