← 返回
未分类

Bubbletea Code Review

Reviews BubbleTea TUI code for proper Elm architecture, model/update/view patterns, and Lipgloss styling. Use when reviewing terminal UI code using charmbrac...
审查 BubbleTea TUI 代码,确保符合 Elm 架构,正确使用 model/update/view 模式以及 Lipgloss 样式。适用于使用 charmbracelet 库的终端 UI 代码审查。
anderskev anderskev 来源
未分类 clawhub v2.3.2 3 版本 100000 Key: 无需
★ 0
Stars
📥 490
下载
💾 2
安装
3
版本
#latest

概述

BubbleTea Code Review

Hard gates (sequence)

Advance only when each pass condition is objectively true (reduces false positives on tea.Cmd and unsubstantiated blocking claims):

GatePass condition
----------------------
G1 — Anti–false-positiveYou skimmed NOT Issues below or read references/elm-architecture.md before recording a finding about tea.Cmd returns, value receivers on Update, or nested child Update.
G2 — Evidence for blocking / suspicious I/OEach Critical/Major finding names file path + line (or a short quoted snippet) showing the blocking call, huh.Form.Run in the wrong place, or other asserted anti-pattern—not a hypothetical.
G3 — VerificationBefore publishing review output, you applied the review-verification-protocol to each proposed finding.

Quick Reference

Issue TypeReference
-----------------------
Elm architecture, tea.Cmd as datareferences/elm-architecture.md
Model state, message handlingreferences/model-update.md
View rendering, Lipgloss stylingreferences/view-styling.md
Component composition, Huh formsreferences/composition.md
Bubbles components (list, table, etc.)references/bubbles-components.md

CRITICAL: Avoid False Positives

Read elm-architecture.md first! The most common review mistake is flagging correct patterns as bugs.

NOT Issues (Do NOT Flag These)

PatternWhy It's Correct
---------------------------
return m, m.loadData()tea.Cmd is returned immediately; runtime executes async
Value receiver on Update()Standard BubbleTea pattern; model returned by value
Nested m.child, cmd = m.child.Update(msg)Normal component composition
Helper functions returning tea.CmdCreates command descriptor, no I/O in Update
tea.Batch(cmd1, cmd2)Commands execute concurrently by runtime

ACTUAL Issues (DO Flag These)

PatternWhy It's Wrong
-------------------------
os.ReadFile() in UpdateBlocks UI thread
http.Get() in UpdateNetwork I/O blocks
time.Sleep() in UpdateFreezes UI
<-channel in Update (blocking)May block indefinitely
huh.Form.Run() in UpdateBlocking call

Review Checklist

Architecture

  • [ ] No blocking I/O in Update() (file, network, sleep)
  • [ ] Helper functions returning tea.Cmd are NOT flagged as blocking
  • [ ] Commands used for all async operations

Model & Update

  • [ ] Model is immutable (Update returns new model, not mutates)
  • [ ] Init returns proper initial command (or nil)
  • [ ] Update handles all expected message types
  • [ ] WindowSizeMsg handled for responsive layout
  • [ ] tea.Batch used for multiple commands
  • [ ] tea.Quit used correctly for exit

View & Styling

  • [ ] View is a pure function (no side effects)
  • [ ] Lipgloss styles defined once, not in View
  • [ ] Key bindings use key.Matches with help.KeyMap

Components

  • [ ] Sub-component updates propagated correctly
  • [ ] Bubbles components initialized with dimensions
  • [ ] Huh forms embedded via Update loop (not Run())

Critical Patterns

Model Must Be Immutable

// BAD - mutates model
func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    m.items = append(m.items, newItem)  // mutation!
    return m, nil
}

// GOOD - returns new model
func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    newItems := make([]Item, len(m.items)+1)
    copy(newItems, m.items)
    newItems[len(m.items)] = newItem
    m.items = newItems
    return m, nil
}

Commands for Async/IO

// BAD - blocking in Update
func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    data, _ := os.ReadFile("config.json")  // blocks UI!
    m.config = parse(data)
    return m, nil
}

// GOOD - use commands
func (m Model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    return m, loadConfigCmd()
}

func loadConfigCmd() tea.Cmd {
    return func() tea.Msg {
        data, err := os.ReadFile("config.json")
        if err != nil {
            return errMsg{err}
        }
        return configLoadedMsg{parse(data)}
    }
}

Styles Defined Once

// BAD - creates new style each render
func (m Model) View() string {
    style := lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("205"))
    return style.Render("Hello")
}

// GOOD - define styles at package level or in model
var titleStyle = lipgloss.NewStyle().Bold(true).Foreground(lipgloss.Color("205"))

func (m Model) View() string {
    return titleStyle.Render("Hello")
}

When to Load References

Review Questions

  1. Is Update() free of blocking I/O? (NOT: "is the cmd helper blocking?")
  2. Is the model immutable in Update?
  3. Are Lipgloss styles defined once, not in View?
  4. Is WindowSizeMsg handled for resizing?
  5. Are key bindings documented with help.KeyMap?
  6. Are Bubbles components sized correctly?

版本历史

共 3 个版本

  • v2.3.2 当前
    2026-06-01 20:57 安全 安全
  • v2.3.1
    2026-05-03 07:24 安全 安全
  • v2.3.0
    2026-03-31 06:03 安全 安全

安全检测

腾讯云安全 (Keen)

安全,无风险
查看报告

腾讯云安全 (Sanbu)

安全,无风险
查看报告

🔗 相关推荐

dev-programming

Github

steipete
使用 `gh` CLI 与 GitHub 交互,通过 `gh issue`、`gh pr`、`gh run` 和 `gh api` 管理议题、PR、CI 运行及高级查询。
★ 679 📥 328,393
dev-programming

CodeConductor.ai

larsonreever
AI驱动平台,提供快速全栈开发、智能体、工作流自动化及低代码AI集成的可扩展产品创建。
★ 72 📥 182,148
dev-programming

Mcporter

steipete
使用 mcporter CLI 直接列出、配置、认证及调用 MCP 服务器/工具(支持 HTTP 或 stdio),涵盖临时服务器、配置编辑及 CLI/类型生成功能。
★ 195 📥 67,797