fix: improvements

based on #219 Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> Co-authored-by: Ayman Bagabas <ayman.bagabas@gmail.com>
charmbracelet · Jan 8, 2024 · 50a706e · 50a706e
1 parent 9ab015a
commit 50a706e
Show file tree

Hide file tree

Showing 6 changed files with 64 additions and 14 deletions.
diff --git a/bubbletea/tea.go b/bubbletea/tea.go
@@ -9,7 +9,6 @@ import (
 	"github.com/charmbracelet/log"
 	"github.com/charmbracelet/ssh"
 	"github.com/charmbracelet/wish"
-	"github.com/muesli/termenv"
 )
 
 // BubbleTeaHandler is the function Bubble Tea apps implement to hook into the
@@ -22,7 +21,13 @@ type BubbleTeaHandler = Handler // nolint: revive
 // Handler is the function Bubble Tea apps implement to hook into the
 // SSH Middleware. This will create a new tea.Program for every connection and
 // start it with the tea.ProgramOptions returned.
-type Handler func(ssh.Session, *lipgloss.Renderer) (tea.Model, []tea.ProgramOption)
+type Handler func(ssh.Session) (tea.Model, []tea.ProgramOption)
+
+// NewRenderer returns a lipgloss renderer for the current session.
+// This function handle PTYs as well, and should be used to style your application.
+func NewRenderer(s ssh.Session) *lipgloss.Renderer {
+	return newRenderer(s)
+}
 
 // Middleware takes a Handler and hooks the input and output for the
 // ssh.Session into the tea.Program.
@@ -38,19 +43,13 @@ func Middleware(bth Handler) wish.Middleware {
 				return
 			}
 
-			renderer := lipgloss.NewRenderer(tty.Slave, termenv.WithColorCache(true))
-
-			m, opts := bth(s, renderer)
+			m, opts := bth(s)
 			if m == nil {
 				log.Error("no model returned by the handler")
 				return
 			}
 
-			p := tea.NewProgram(m, append(
-				opts,
-				tea.WithInput(tty.Slave),
-				tea.WithOutput(tty.Slave),
-			)...)
+			p := tea.NewProgram(m, append(opts, makeIOOpts(s)...)...)
 			if p != nil {
 				ctx, cancel := context.WithCancel(s.Context())
 				go func() {

diff --git a/bubbletea/tea_other.go b/bubbletea/tea_other.go
@@ -0,0 +1,22 @@
+//go:build !linux && !darwin && !freebsd && !dragonfly && !netbsd && !openbsd && !solaris
+// +build !linux,!darwin,!freebsd,!dragonfly,!netbsd,!openbsd,!solaris
+
+package bubbletea
+
+import (
+	tea "github.com/charmbracelet/bubbletea"
+	"github.com/charmbracelet/lipgloss"
+	"github.com/charmbracelet/ssh"
+	"github.com/muesli/termenv"
+)
+
+func makeIOOpts(s ssh.Session) []tea.ProgramOption {
+	return []tea.ProgramOption{
+		tea.WithInput(s),
+		tea.WithOutput(s),
+	}
+}
+
+func newRenderer(s ssh.Session) *lipgloss.Renderer {
+	return lipgloss.NewRenderer(s, termenv.WithColorCache(true))
+}
diff --git a/bubbletea/tea_unix.go b/bubbletea/tea_unix.go
@@ -0,0 +1,31 @@
+//go:build darwin || dragonfly || freebsd || linux || netbsd || openbsd || solaris
+// +build darwin dragonfly freebsd linux netbsd openbsd solaris
+
+package bubbletea
+
+import (
+	tea "github.com/charmbracelet/bubbletea"
+	"github.com/charmbracelet/lipgloss"
+	"github.com/charmbracelet/ssh"
+	"github.com/muesli/termenv"
+)
+
+func makeIOOpts(s ssh.Session) []tea.ProgramOption {
+	pty, _, ok := s.Pty()
+	if !ok || s.EmulatedPty() {
+		return []tea.ProgramOption{
+			tea.WithInput(s),
+			tea.WithOutput(s),
+		}
+	}
+
+	return []tea.ProgramOption{
+		tea.WithInput(pty.Slave),
+		tea.WithOutput(pty.Slave),
+	}
+}
+
+func newRenderer(s ssh.Session) *lipgloss.Renderer {
+	pty, _, _ := s.Pty()
+	return lipgloss.NewRenderer(pty.Slave, termenv.WithColorCache(true))
+}
diff --git a/examples/go.mod b/examples/go.mod
@@ -20,7 +20,6 @@ require (
 	github.com/anmitsu/go-shlex v0.0.0-20200514113438-38f4b401e2be // indirect
 	github.com/atotto/clipboard v0.1.4 // indirect
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
-	github.com/aymanbagabas/go-pty v0.2.2 // indirect
 	github.com/charmbracelet/keygen v0.5.0 // indirect
 	github.com/cloudflare/circl v1.3.3 // indirect
 	github.com/containerd/console v1.0.4-0.20230313162750-1ae8d489ac81 // indirect

diff --git a/examples/go.sum b/examples/go.sum
@@ -12,8 +12,6 @@ github.com/atotto/clipboard v0.1.4 h1:EH0zSVneZPSuFR11BlR9YppQTVDbh5+16AmcJi4g1z
 github.com/atotto/clipboard v0.1.4/go.mod h1:ZY9tmq7sm5xIbd9bOK4onWV4S6X0u6GY7Vn0Yu86PYI=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiErDT4WkJ2k=
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
-github.com/aymanbagabas/go-pty v0.2.2 h1:YZREB4eSj+1xdbbItIokX0ekjjeifgJOA+ZvxU4/WM8=
-github.com/aymanbagabas/go-pty v0.2.2/go.mod h1:gfvlwH+0U66BCwxJREjJaAOEs9H1OFf3YFjI9WSiZ04=
 github.com/bwesterb/go-ristretto v1.2.3/go.mod h1:fUIoIZaG73pV5biE2Blr2xEzDoMj7NFEuV9ekS419A0=
 github.com/charmbracelet/bubbles v0.16.1 h1:6uzpAAaT9ZqKssntbvZMlksWHruQLNxg49H5WdeuYSY=
 github.com/charmbracelet/bubbles v0.16.1/go.mod h1:2QCp9LFlEsBQMvIYERr7Ww2H2bA7xen1idUDIzm/+Xc=

diff --git a/examples/wish-exec/main.go b/examples/wish-exec/main.go
@@ -59,7 +59,8 @@ func main() {
 	}
 }
 
-func teaHandler(s ssh.Session, renderer *lipgloss.Renderer) (tea.Model, []tea.ProgramOption) {
+func teaHandler(s ssh.Session) (tea.Model, []tea.ProgramOption) {
+	renderer := bm.NewRenderer(s)
 	m := model{
 		sess:     s,
 		style:    renderer.NewStyle().Foreground(lipgloss.Color("8")),