ui

package
v1.8.5 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 5, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Overview

Package ui provides bubbletea TUI prompts for destructive migration operations.

MIT License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewBubbleteaPromptFunc

func NewBubbleteaPromptFunc() yamlpkg.PromptFunc

NewBubbleteaPromptFunc returns a yamlpkg.PromptFunc that wraps the bubbletea TUI prompt. It tracks scope state (all remaining / all of type) across calls so that a single "All remaining" or "All of this type" selection applies to subsequent destructive operations automatically.

Types

type PromptScope

type PromptScope int

PromptScope controls how a prompt response is applied to subsequent operations.

const (
	ScopeOne  PromptScope = iota // apply to this operation only
	ScopeAll                     // apply to all remaining destructive ops
	ScopeType                    // apply to all remaining ops of the same ChangeType
)

func ParsePromptInput

func ParsePromptInput(input string) (yamlpkg.PromptResponse, PromptScope)

ParsePromptInput parses a prompt input like "1", "3a", "5t" into a PromptResponse and a scope. Used as fallback for non-interactive environments.

func RunDestructivePrompt

func RunDestructivePrompt(title string, changeType yamlpkg.ChangeType) (yamlpkg.PromptResponse, PromptScope, error)

RunDestructivePrompt shows a bubbletea prompt for a single destructive operation and returns the user's chosen response and scope.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL