AgentSkillsCN

tui-testing-debug

在无需可见终端的情况下，对 Bubble Tea TUI 进行调试与单元测试的方法。

SKILL.md
--- frontmatter
name: tui-testing-debug
description: Methods for debugging and unit testing Bubble Tea TUIs without a visible terminal.
license: MIT
compatibility: opencode

What I do

  • •Implement logging to file (standard TUI debugging).
  • •Setup teatest for automated TUI testing.
  • •Handle terminal recovery logic.

Best Practices

  1. •Log to File: Since fmt.Println breaks the TUI, use tea.LogToFile("debug.log", "prefix") for development.
  2. •Testing with Teatest: Use github.com/charmbracelet/bubbletea/teatest to simulate keypresses and assert the final view string.
  3. •Panic Recovery: Use tea.WithAltScreen() and ensure errors are returned through p.Run() rather than calling os.Exit inside the model.

Example: File Logging

go
if len(os.Getenv("DEBUG")) > 0 {
    f, err := tea.LogToFile("debug.log", "debug")
    if err != nil {
        log.Fatal(err)
    }
    defer f.Close()
}