charmbracelet / charmbracelet/bubbletea

v2 release checklist

Open
#1,386 1 comment 0 reactions 1 assignee Assigned to @aymanbagabas View on GitHub
Dominant language
Go
Stars
44.9k
Forks
1.3k
PR merge metrics
No merged PRs in 30d

Description

## Action Items

- [ ] remove TODOs from code
- [ ] textinput has duplicate Width functions
- [ ] glamour example needs formatting
- [ ] `TestApp` disabled with a TODO
- [ ] TestAppInteractive is being skipped
- [ ] add more tests for windows (`exec_test.go`)
- [ ] it says `WithGraphemeClustering` disables grapheme clustering. Seems it should be named `WithoutGraphemeClustering` if that's the case
- [ ] `ColorProfileMsg` clean up godoc
- [ ] “Note: that some terminal’s like Apple’s Terminal.app” -> “some terminals”
- [ ] update tutorial instructions in the `tutorials` dir
- [ ] explain when to use real cursor vs virtual cursor
- [ ] RE: WithReportFocus -> We should link to how to configure this for tmux. Also, what happens if this is used and the terminal emulator or multiplexer doesn’t support it? No message is ever received?

## Examples to tidy
- [ ] `tea.NewFrame` should be removed (`_cursor-style-func`)
- [ ] `examples/_image`: there’s a bunch of commented out code + what is the image package?
- [ ] `examples/_wishbug`: What is this example showing? It’s mentioning an ssh session, but I’m not seeing any ssh-related stuff in the example.
- [ ] `examples/altscreen-toggle`
- [ ] `examples/autocomplete`
- [ ] `examples/creditcard`
- [ ] `examples/query-term`

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.