chore: merge branch 'v2-exp' into v2-renderer

.github/workflows/lint.yml

@@ -3,26 +3,6 @@ on:
  push:
  pull_request:
 
-permissions:
- contents: read
- # Optional: allow read access to pull request. Use with `only-new-issues` option.
- pull-requests: read
-
 jobs:
- golangci:
- name: lint
- runs-on: ubuntu-latest
- steps:
- - name: Install Go
- uses: actions/setup-go@v5
- with:
- go-version: ^1
-
- - uses: actions/checkout@v4
- - name: golangci-lint
- uses: golangci/golangci-lint-action@v6
- with:
- # Optional: golangci-lint command line arguments.
- #args:
- # Optional: show only new issues if it's a pull request. The default value is `false`.
- only-new-issues: true
+ lint:
+ uses: charmbracelet/meta/.github/workflows/lint.yml@main

README.md

@@ -247,8 +247,8 @@ look at the [Command Tutorial][cmd]. It's pretty simple.
 There are also several [Bubble Tea examples][examples] available and, of course,
 there are [Go Docs][docs].
 
-[cmd]: http://github.com/charmbracelet/bubbletea/tree/master/tutorials/commands/
-[examples]: http://github.com/charmbracelet/bubbletea/tree/master/examples
+[cmd]: https://github.com/charmbracelet/bubbletea/tree/master/tutorials/commands/
+[examples]: https://github.com/charmbracelet/bubbletea/tree/master/examples
 [docs]: https://pkg.go.dev/github.com/charmbracelet/bubbletea?tab=doc
 
 ## Debugging
@@ -347,6 +347,12 @@ For more applications built with Bubble Tea see [Charm & Friends][community].
 Is there something cool you made with Bubble Tea you want to share? [PRs][community] are
 welcome!
 
+## Contributing
+
+See [contributing][contribute].
+
+[contribute]: https://github.com/charmbracelet/bubbletea/contribute
+
 ## Feedback
 
 We’d love to hear your thoughts on this project. Feel free to drop us a note!

cancelreader_windows.go

@@ -10,6 +10,7 @@ import (
  "sync"
  "time"
 
+ xwindows "github.com/charmbracelet/x/windows"
  "github.com/muesli/cancelreader"
  "golang.org/x/sys/windows"
 )
@@ -47,6 +48,11 @@ func newCancelreader(r io.Reader) (cancelreader.CancelReader, error) {
  return fallback(r)
  }
 
+ // Discard any pending input events.
+ if err := xwindows.FlushConsoleInputBuffer(conin); err != nil {
+ return fallback(r)
+ }
+
  originalMode, err := prepareConsole(conin,
  windows.ENABLE_MOUSE_INPUT,
  windows.ENABLE_WINDOW_INPUT,

examples/simple/testdata/TestApp.golden

@@ -1,4 +1,4 @@
-[?25l[?2004h[?2027h[?2027$pHi. This program will exit in 10 seconds.
+[?25l[?2004hHi. This program will exit in 10 seconds.
 
 To quit sooner press ctrl-c, or press ctrl-z to suspend...
 Hi. This program will exit in 9 seconds.

exec_test.go

@@ -44,8 +44,15 @@ func TestTeaExec(t *testing.T) {
  expectErr bool
  }
 
- var tests []test
  // TODO: add more tests for windows
+ tests := []test{
+ {
+ name: "invalid command",
+ cmd: "invalid",
+ expectErr: true,
+ },
+ }
+
  if runtime.GOOS != "windows" {
  tests = append(tests, []test{
  {
@@ -61,12 +68,6 @@ func TestTeaExec(t *testing.T) {
  }...)
  }
 
- tests = append(tests, test{
- name: "invalid command",
- cmd: "invalid",
- expectErr: true,
- })
-
  for _, test := range tests {
  t.Run(test.name, func(t *testing.T) {
  var buf bytes.Buffer

options.go

@@ -254,7 +254,7 @@ func WithKeyboardEnhancements(enhancements ...KeyboardEnhancement) ProgramOption
  }
 }
 
-// WithoutGraphemeClustering disables grapheme clustering. This is useful if you
+// WithGraphemeClustering disables grapheme clustering. This is useful if you
 // want to disable grapheme clustering for your program.
 //
 // Grapheme clustering is a character width calculation method that accurately
@@ -263,9 +263,9 @@ func WithKeyboardEnhancements(enhancements ...KeyboardEnhancement) ProgramOption
 // characters.
 //
 // See https://mitchellh.com/writing/grapheme-clusters-in-terminals
-func WithoutGraphemeClustering() ProgramOption {
+func WithGraphemeClustering() ProgramOption {
  return func(p *Program) {
- p.startupOptions |= withoutGraphemeClustering
+ p.startupOptions |= withGraphemeClustering
  }
 }
 

screen_test.go

@@ -17,62 +17,67 @@ func TestClearMsg(t *testing.T) {
  {
  name: "clear_screen",
  cmds: []Cmd{ClearScreen},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[2J\x1b[1;1H\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[2J\x1b[1;1H\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "altscreen",
  cmds: []Cmd{EnterAltScreen, ExitAltScreen},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[?25l\x1b[?1049l\x1b[?25l\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[?25l\x1b[?1049l\x1b[?25l\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "altscreen_autoexit",
  cmds: []Cmd{EnterAltScreen},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[?25l\rsuccess\r\n\x1b[2;0H\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?1049l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?1049h\x1b[2J\x1b[1;1H\x1b[?25l\rsuccess\r\n\x1b[2;0H\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?1049l\x1b[?25h",
  },
  {
  name: "mouse_cellmotion",
  cmds: []Cmd{EnableMouseCellMotion},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?1002h\x1b[?1006h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?1002l\x1b[?1003l\x1b[?1006l",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?1002h\x1b[?1006h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?1002l\x1b[?1003l\x1b[?1006l",
  },
  {
  name: "mouse_allmotion",
  cmds: []Cmd{EnableMouseAllMotion},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?1003h\x1b[?1006h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?1002l\x1b[?1003l\x1b[?1006l",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?1003h\x1b[?1006h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?1002l\x1b[?1003l\x1b[?1006l",
  },
  {
  name: "mouse_disable",
  cmds: []Cmd{EnableMouseAllMotion, DisableMouse},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?1003h\x1b[?1006h\x1b[?1002l\x1b[?1003l\x1b[?1006l\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?1003h\x1b[?1006h\x1b[?1002l\x1b[?1003l\x1b[?1006l\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "cursor_hide",
  cmds: []Cmd{HideCursor},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "cursor_hideshow",
  cmds: []Cmd{HideCursor, ShowCursor},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?25h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?25h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l",
  },
  {
  name: "bp_stop_start",
  cmds: []Cmd{DisableBracketedPaste, EnableBracketedPaste},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[?2004l\x1b[?2004h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?2004l\x1b[?2004h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "read_set_clipboard",
  cmds: []Cmd{ReadClipboard, SetClipboard("success")},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b]52;c;?\a\x1b]52;c;c3VjY2Vzcw==\a\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b]52;c;?\a\x1b]52;c;c3VjY2Vzcw==\a\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "bg_fg_cur_color",
  cmds: []Cmd{ForegroundColor, BackgroundColor, CursorColor},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b]10;?\a\x1b]11;?\a\x1b]12;?\a\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\x1b]10;?\a\x1b]11;?\a\x1b]12;?\a\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  },
  {
  name: "bg_set_color",
  cmds: []Cmd{SetBackgroundColor(color.RGBA{255, 255, 255, 255})},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b]11;#ffffff\a\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b]111\a",
+ expected: "\x1b[?25l\x1b[?2004h\x1b]11;#ffffff\a\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b]111\a",
+ },
+ {
+ name: "grapheme_clustering",
+ cmds: []Cmd{EnableGraphemeClustering},
+ expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[?2027l",
  },
  }
 
@@ -81,13 +86,13 @@ func TestClearMsg(t *testing.T) {
  tests = append(tests, test{
  name: "kitty_start",
  cmds: []Cmd{DisableKeyboardEnhancements, EnableKeyboardEnhancements(WithKeyReleases)},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
+ expected: "\x1b[?25l\x1b[?2004h\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h",
  })
  } else {
  tests = append(tests, test{
  name: "kitty_start",
  cmds: []Cmd{DisableKeyboardEnhancements, EnableKeyboardEnhancements(WithKeyReleases)},
- expected: "\x1b[?25l\x1b[?2004h\x1b[?2027h\x1b[?2027$p\x1b[>4;1m\x1b[>3u\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[>4;0m\x1b[>0u",
+ expected: "\x1b[?25l\x1b[?2004h\x1b[>4;1m\x1b[>3u\rsuccess\r\n\x1b[D\x1b[2K\r\x1b[?2004l\x1b[?25h\x1b[>4;0m\x1b[>0u",
  })
  }
 

tea.go

@@ -104,7 +104,7 @@ const (
  withoutBracketedPaste
  withReportFocus
  withKeyboardEnhancements
- withoutGraphemeClustering
+ withGraphemeClustering
 )
 
 // channelHandlers manages the series of channels returned by various processes.
@@ -741,7 +741,7 @@ func (p *Program) Run() (Model, error) {
  p.execute(ansi.EnableBracketedPaste)
  p.modes[ansi.BracketedPasteMode] = true
  }
- if p.startupOptions&withoutGraphemeClustering == 0 {
+ if p.startupOptions&withGraphemeClustering != 0 {
  p.execute(ansi.EnableGraphemeClustering)
  p.execute(ansi.RequestGraphemeClustering)
  // We store the state of grapheme clustering after we query it and get