fix(tty): fall back to default dimensions when terminal size is 0x0 (#1836)
Co-authored-by: AdamMagued <adammagued.business@gmail.com>
This commit is contained in:
parent
33f6a40ec0
commit
96d69d2f7e
3 changed files with 231 additions and 1 deletions
2
tea.go
2
tea.go
|
|
@ -1057,7 +1057,7 @@ func (p *Program) Run() (returnModel Model, returnErr error) {
|
|||
return p.initialModel, fmt.Errorf("bubbletea: error getting terminal size: %w", err)
|
||||
}
|
||||
|
||||
width, height = w, h
|
||||
width, height = p.fallbackDimensions(w, h)
|
||||
}
|
||||
|
||||
p.width, p.height = width, height
|
||||
|
|
|
|||
40
tty.go
40
tty.go
|
|
@ -3,6 +3,7 @@ package tea
|
|||
import (
|
||||
"fmt"
|
||||
"os"
|
||||
"strconv"
|
||||
"time"
|
||||
|
||||
uv "github.com/charmbracelet/ultraviolet"
|
||||
|
|
@ -104,6 +105,43 @@ func (p *Program) waitForReadLoop() {
|
|||
}
|
||||
}
|
||||
|
||||
const (
|
||||
defaultWidth = 80
|
||||
defaultHeight = 24
|
||||
)
|
||||
|
||||
// fallbackDimensions returns width and height, falling back to COLUMNS/LINES
|
||||
// environment variables or 80x24 defaults when dimensions are non-positive.
|
||||
func (p *Program) fallbackDimensions(width, height int) (int, int) {
|
||||
if width <= 0 {
|
||||
var cols string
|
||||
if p != nil && p.environ != nil {
|
||||
cols = p.environ.Getenv("COLUMNS")
|
||||
} else {
|
||||
cols = os.Getenv("COLUMNS")
|
||||
}
|
||||
if c, err := strconv.Atoi(cols); err == nil && c > 0 {
|
||||
width = c
|
||||
} else {
|
||||
width = defaultWidth
|
||||
}
|
||||
}
|
||||
if height <= 0 {
|
||||
var lines string
|
||||
if p != nil && p.environ != nil {
|
||||
lines = p.environ.Getenv("LINES")
|
||||
} else {
|
||||
lines = os.Getenv("LINES")
|
||||
}
|
||||
if l, err := strconv.Atoi(lines); err == nil && l > 0 {
|
||||
height = l
|
||||
} else {
|
||||
height = defaultHeight
|
||||
}
|
||||
}
|
||||
return width, height
|
||||
}
|
||||
|
||||
// checkResize detects the current size of the output and informs the program
|
||||
// via a WindowSizeMsg.
|
||||
func (p *Program) checkResize() {
|
||||
|
|
@ -122,6 +160,8 @@ func (p *Program) checkResize() {
|
|||
return
|
||||
}
|
||||
|
||||
w, h = p.fallbackDimensions(w, h)
|
||||
|
||||
p.width, p.height = w, h
|
||||
p.Send(WindowSizeMsg{Width: w, Height: h})
|
||||
}
|
||||
|
|
|
|||
190
tty_test.go
Normal file
190
tty_test.go
Normal file
|
|
@ -0,0 +1,190 @@
|
|||
package tea
|
||||
|
||||
import (
|
||||
"bytes"
|
||||
"testing"
|
||||
)
|
||||
|
||||
type windowSizeModel struct {
|
||||
windowSize WindowSizeMsg
|
||||
quit bool
|
||||
}
|
||||
|
||||
func (m *windowSizeModel) Init() Cmd {
|
||||
return nil
|
||||
}
|
||||
|
||||
func (m *windowSizeModel) Update(msg Msg) (Model, Cmd) {
|
||||
switch msg := msg.(type) {
|
||||
case WindowSizeMsg:
|
||||
m.windowSize = msg
|
||||
m.quit = true
|
||||
return m, Quit
|
||||
}
|
||||
return m, nil
|
||||
}
|
||||
|
||||
func (m *windowSizeModel) View() View {
|
||||
return NewView("")
|
||||
}
|
||||
|
||||
func TestFallbackDimensions(t *testing.T) {
|
||||
t.Run("default fallback to 80x24", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "")
|
||||
t.Setenv("LINES", "")
|
||||
|
||||
p := NewProgram(nil)
|
||||
w, h := p.fallbackDimensions(0, 0)
|
||||
if w != defaultWidth || h != defaultHeight {
|
||||
t.Errorf("expected %dx%d, got %dx%d", defaultWidth, defaultHeight, w, h)
|
||||
}
|
||||
|
||||
w, h = p.fallbackDimensions(-10, -5)
|
||||
if w != defaultWidth || h != defaultHeight {
|
||||
t.Errorf("expected %dx%d, got %dx%d", defaultWidth, defaultHeight, w, h)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("preserve positive dimensions", func(t *testing.T) {
|
||||
p := NewProgram(nil)
|
||||
w, h := p.fallbackDimensions(120, 40)
|
||||
if w != 120 || h != 40 {
|
||||
t.Errorf("expected 120x40, got %dx%d", w, h)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("mixed non-positive dimensions", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "")
|
||||
t.Setenv("LINES", "")
|
||||
|
||||
p := NewProgram(nil)
|
||||
w, h := p.fallbackDimensions(0, 50)
|
||||
if w != defaultWidth || h != 50 {
|
||||
t.Errorf("expected %dx50, got %dx%d", defaultWidth, w, h)
|
||||
}
|
||||
|
||||
w, h = p.fallbackDimensions(100, 0)
|
||||
if w != 100 || h != defaultHeight {
|
||||
t.Errorf("expected 100x%d, got %dx%d", defaultHeight, w, h)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("fallback to COLUMNS and LINES from os env", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "132")
|
||||
t.Setenv("LINES", "43")
|
||||
|
||||
p := NewProgram(nil)
|
||||
w, h := p.fallbackDimensions(0, 0)
|
||||
if w != 132 || h != 43 {
|
||||
t.Errorf("expected 132x43, got %dx%d", w, h)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("fallback to COLUMNS and LINES from program environment", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "200")
|
||||
t.Setenv("LINES", "100")
|
||||
|
||||
p := NewProgram(nil, WithEnvironment([]string{"COLUMNS=150", "LINES=60"}))
|
||||
w, h := p.fallbackDimensions(0, 0)
|
||||
if w != 150 || h != 60 {
|
||||
t.Errorf("expected 150x60, got %dx%d", w, h)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("program environment without COLUMNS and LINES falls back to 80x24 skipping os env", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "200")
|
||||
t.Setenv("LINES", "100")
|
||||
|
||||
p := NewProgram(nil, WithEnvironment([]string{"OTHER_VAR=1"}))
|
||||
w, h := p.fallbackDimensions(0, 0)
|
||||
if w != defaultWidth || h != defaultHeight {
|
||||
t.Errorf("expected %dx%d, got %dx%d", defaultWidth, defaultHeight, w, h)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("invalid or non-positive COLUMNS and LINES fall back to defaults", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "invalid")
|
||||
t.Setenv("LINES", "-10")
|
||||
|
||||
p := NewProgram(nil)
|
||||
w, h := p.fallbackDimensions(0, 0)
|
||||
if w != defaultWidth || h != defaultHeight {
|
||||
t.Errorf("expected %dx%d, got %dx%d", defaultWidth, defaultHeight, w, h)
|
||||
}
|
||||
|
||||
t.Setenv("COLUMNS", "0")
|
||||
t.Setenv("LINES", "0")
|
||||
|
||||
w, h = p.fallbackDimensions(0, 0)
|
||||
if w != defaultWidth || h != defaultHeight {
|
||||
t.Errorf("expected %dx%d, got %dx%d", defaultWidth, defaultHeight, w, h)
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
func TestProgramNonTTYDimensions(t *testing.T) {
|
||||
t.Run("non-tty output does not receive fallback dimensions", func(t *testing.T) {
|
||||
t.Setenv("COLUMNS", "110")
|
||||
t.Setenv("LINES", "35")
|
||||
|
||||
var buf bytes.Buffer
|
||||
var in bytes.Buffer
|
||||
m := &windowSizeModel{}
|
||||
|
||||
p := NewProgram(m,
|
||||
WithInput(&in),
|
||||
WithOutput(&buf),
|
||||
)
|
||||
|
||||
if _, err := p.Run(); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if m.windowSize.Width != 0 || m.windowSize.Height != 0 {
|
||||
t.Errorf("expected WindowSizeMsg 0x0 for non-TTY output, got %dx%d",
|
||||
m.windowSize.Width, m.windowSize.Height)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("non-tty output with program environment does not receive fallback dimensions", func(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
var in bytes.Buffer
|
||||
m := &windowSizeModel{}
|
||||
|
||||
p := NewProgram(m,
|
||||
WithInput(&in),
|
||||
WithOutput(&buf),
|
||||
WithEnvironment([]string{"COLUMNS=150", "LINES=60"}),
|
||||
)
|
||||
|
||||
if _, err := p.Run(); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if m.windowSize.Width != 0 || m.windowSize.Height != 0 {
|
||||
t.Errorf("expected WindowSizeMsg 0x0 for non-TTY output, got %dx%d",
|
||||
m.windowSize.Width, m.windowSize.Height)
|
||||
}
|
||||
})
|
||||
|
||||
t.Run("non-tty output preserves WithWindowSize when specified", func(t *testing.T) {
|
||||
var buf bytes.Buffer
|
||||
var in bytes.Buffer
|
||||
m := &windowSizeModel{}
|
||||
|
||||
p := NewProgram(m,
|
||||
WithInput(&in),
|
||||
WithOutput(&buf),
|
||||
WithWindowSize(120, 50),
|
||||
)
|
||||
|
||||
if _, err := p.Run(); err != nil {
|
||||
t.Fatalf("unexpected error: %v", err)
|
||||
}
|
||||
|
||||
if m.windowSize.Width != 120 || m.windowSize.Height != 50 {
|
||||
t.Errorf("expected WindowSizeMsg 120x50, got %dx%d",
|
||||
m.windowSize.Width, m.windowSize.Height)
|
||||
}
|
||||
})
|
||||
}
|
||||
Loading…
Reference in a new issue