feat(table): use cellbuf to preserve styles for wrapped content

Author: bashbunni

go.mod

@@ -4,20 +4,26 @@ retract v0.7.0 // v0.7.0 introduces a bug that causes some apps to freeze.
 
 retract v0.11.1 // v0.11.1 uses a broken version of x/ansi StringWidth that causes some lines to wrap incorrectly.
 
-go 1.18
+go 1.23.0
+
+toolchain go1.23.1
 
 require (
 	github.com/aymanbagabas/go-udiff v0.2.0
 	github.com/charmbracelet/x/ansi v0.8.0
+	github.com/charmbracelet/x/cellbuf v0.0.12-0.20250218160530-421b202f6f6a
 	github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a
 	github.com/muesli/termenv v0.16.0
 	github.com/rivo/uniseg v0.4.7
 )
 
 require (
 	github.com/aymanbagabas/go-osc52/v2 v2.0.1 // indirect
+	github.com/charmbracelet/colorprofile v0.2.2 // indirect
+	github.com/charmbracelet/x/term v0.2.1 // indirect
 	github.com/lucasb-eyer/go-colorful v1.2.0 // indirect
 	github.com/mattn/go-isatty v0.0.20 // indirect
 	github.com/mattn/go-runewidth v0.0.16 // indirect
-	golang.org/x/sys v0.30.0 // indirect
+	github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e // indirect
+	golang.org/x/sys v0.31.0 // indirect
 )

go.sum

@@ -2,10 +2,18 @@ github.com/aymanbagabas/go-osc52/v2 v2.0.1 h1:HwpRHbFMcZLEVr42D4p7XBqjyuxQH5SMiE
 github.com/aymanbagabas/go-osc52/v2 v2.0.1/go.mod h1:uYgXzlJ7ZpABp8OJ+exZzJJhRNQ2ASbcXHWsFqH8hp8=
 github.com/aymanbagabas/go-udiff v0.2.0 h1:TK0fH4MteXUDspT88n8CKzvK0X9O2xu9yQjWpi6yML8=
 github.com/aymanbagabas/go-udiff v0.2.0/go.mod h1:RE4Ex0qsGkTAJoQdQQCA0uG+nAzJO/pI/QwceO5fgrA=
+github.com/charmbracelet/colorprofile v0.2.2 h1:Cqkg0GqDd9vCdhRIBsCbeS8kvePcm8PyZLhRP9AwmaU=
+github.com/charmbracelet/colorprofile v0.2.2/go.mod h1:X4/0JoqgTIPSFcRA/P6INZzIuyqdFY5rm8tb41s9okk=
 github.com/charmbracelet/x/ansi v0.8.0 h1:9GTq3xq9caJW8ZrBTe0LIe2fvfLR/bYXKTx2llXn7xE=
 github.com/charmbracelet/x/ansi v0.8.0/go.mod h1:wdYl/ONOLHLIVmQaxbIYEC/cRKOQyjTkowiI4blgS9Q=
+github.com/charmbracelet/x/cellbuf v0.0.12-0.20250218160530-421b202f6f6a h1:rMGZ3e/azMB6h2yyZLjP3v/vV9nQv/RbDPPOYWdaKkc=
+github.com/charmbracelet/x/cellbuf v0.0.12-0.20250218160530-421b202f6f6a/go.mod h1:dKfNBxLovpvzzxAP6/GZfs5eb7vNxHlUDnwGhRmvIdY=
+github.com/charmbracelet/x/cellbuf v0.0.12-0.20250310143723-2c58b9d1fef2 h1:QXPtJxqXeevgo4nlFIBBawFWTF7X6zNlRsUQVegBMLM=
+github.com/charmbracelet/x/cellbuf v0.0.12-0.20250310143723-2c58b9d1fef2/go.mod h1:Sae8XjyM5ULaghgrfrfB0Yogm9Govecko6mgTb2pgBE=
 github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a h1:G99klV19u0QnhiizODirwVksQB91TJKV/UaTnACcG30=
 github.com/charmbracelet/x/exp/golden v0.0.0-20240806155701-69247e0abc2a/go.mod h1:wDlXFlCrmJ8J+swcL/MnGUuYnqgQdW9rhSD61oNMb6U=
+github.com/charmbracelet/x/term v0.2.1 h1:AQeHeLZ1OqSXhrAWpYUtZyX1T3zVxfpZuEQMIQaGIAQ=
+github.com/charmbracelet/x/term v0.2.1/go.mod h1:oQ4enTYFV7QN4m0i9mzHrViD7TQKvNEEkHUMCmsxdUg=
 github.com/lucasb-eyer/go-colorful v1.2.0 h1:1nnpGOrhyZZuNyfu1QjKiUICQ74+3FNCN69Aj6K7nkY=
 github.com/lucasb-eyer/go-colorful v1.2.0/go.mod h1:R4dSotOR9KMtayYi1e77YzuveK+i7ruzyGqttikkLy0=
 github.com/mattn/go-isatty v0.0.20 h1:xfD0iDuEKnDkl03q4limB+vH+GxLEtL/jb4xVJSWWEY=
@@ -17,6 +25,10 @@ github.com/muesli/termenv v0.16.0/go.mod h1:ZRfOIKPFDYQoDFF4Olj7/QJbW60Ol/kL1pU3
 github.com/rivo/uniseg v0.2.0/go.mod h1:J6wj4VEh+S6ZtnVlnTBMWIodfgj8LQOQFoIToxlJtxc=
 github.com/rivo/uniseg v0.4.7 h1:WUdvkW8uEhrYfLC4ZzdpI2ztxP1I582+49Oc5Mq64VQ=
 github.com/rivo/uniseg v0.4.7/go.mod h1:FN3SvrM+Zdj16jyLfmOkMNblXMcoc8DfTHruCPUcx88=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e h1:JVG44RsyaB9T2KIHavMF/ppJZNG9ZpyihvCd0w101no=
+github.com/xo/terminfo v0.0.0-20220910002029-abceb7e1c41e/go.mod h1:RbqR21r5mrJuqunuUZ/Dhy/avygyECGrLceyNeo4LiM=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561 h1:MDc5xs78ZrZr3HMQugiXOAkSZtfTpbJLDr/lwfgO53E=
+golang.org/x/exp v0.0.0-20220909182711-5c715a9e8561/go.mod h1:cyybsKvd6eL0RnXn6p/Grxp8F5bW7iYuBgsNCOHpMYE=
 golang.org/x/sys v0.6.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
-golang.org/x/sys v0.30.0 h1:QjkSwP/36a20jFYWkSue1YwXzLmsV5Gfq7Eiy72C1uc=
-golang.org/x/sys v0.30.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
+golang.org/x/sys v0.31.0 h1:ioabZlmFYtWhL+TRYpcnNlLwhyxaM9kWTDEmfnprqik=
+golang.org/x/sys v0.31.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=

style.go

@@ -5,6 +5,7 @@ import (
 	"unicode"
 
 	"github.com/charmbracelet/x/ansi"
+	"github.com/charmbracelet/x/cellbuf"
 	"github.com/muesli/termenv"
 )
 
@@ -364,7 +365,7 @@ func (s Style) Render(strs ...string) string {
 	// Word wrap
 	if !inline && width > 0 {
 		wrapAt := width - leftPadding - rightPadding
-		str = ansi.Wrap(str, wrapAt, "")
+		str = cellbuf.Wrap(str, wrapAt, "")
 	}
 
 	// Render core text

table/table_test.go

@@ -1812,7 +1812,7 @@ func ExampleTable_Wrap() {
 }
 
 // Check that stylized wrapped content does not go beyond its cell.
-func TestTableWithLinks(t *testing.T) {
+func TestWrapPreStyledContent(t *testing.T) {
 	headers := []string{"Package", "Version", "Link"}
 	data := [][]string{
 		{"sourcegit", "0.19", lipgloss.JoinHorizontal(lipgloss.Left, lipgloss.NewStyle().Foreground(lipgloss.Color("#31BB71")).Render("https://aur.archlinux.org/packages/sourcegit-bin"))},
@@ -1823,10 +1823,32 @@ func TestTableWithLinks(t *testing.T) {
 	table := New().
 		Headers(headers...).
 		Rows(data...).
-		//		StyleFunc(TableStyle).
 		Width(80).
 		Wrap(true)
-	t.Log(table.String())
-	// TODO once we have the desired result, save it as a golden file
-	//	golden.RequireEqual(t, []byte(table.String()))
+	golden.RequireEqual(t, []byte(table.String()))
+}
+
+// Check that stylized wrapped content does not go beyond its cell.
+func TestWrapStyleFuncContent(t *testing.T) {
+	headers := []string{"Package", "Version", "Link"}
+	data := [][]string{
+		{"sourcegit", "0.19", "https://aur.archlinux.org/packages/sourcegit-bin"},
+		{"Welcome", "いらっしゃいませ", "مرحباً"},
+		{"Goodbye", "さようなら", "مع السلامة"},
+	}
+	table := New().
+		Headers(headers...).
+		Rows(data...).
+		StyleFunc(func(row, col int) lipgloss.Style {
+			if row == HeaderRow {
+				return lipgloss.NewStyle()
+			}
+			if strings.Contains(data[row][col], "https://") {
+				return lipgloss.NewStyle().Foreground(lipgloss.Color("#31BB71"))
+			}
+			return lipgloss.NewStyle()
+		}).
+		Width(60).
+		Wrap(true)
+	golden.RequireEqual(t, []byte(table.String()))
 }

table/testdata/TestContentWrapping_ColumnWidth/LongTextDifferentLanguages.golden

@@ -8,27 +8,26 @@
 │an. Has ei   │ゆじょて憶主管州けでふく。排ゃ│والكو│仕断青場内凄 │기타 필요한  │
 │quidam       │わつげ美刊ヱミ出見ツ南者オ抜豆│ري   │新東深簿代供 │사항은 법률로│
 │hendrerit    │ハトロネ論索モネニイ任償スヲ話│الأور│供。守聞書神 │정한다.      │
-│intellegebat,│破リヤヨ秒止口イセソス止央のさ│     │秀同浜東波恋 │임시회의     │
-│id tamquam   │食周健でてつだ官送ト読聴遊容ひ│وبيّون│闘秀。未格打 │회기는 30일을│
-│iudicabit    │                              │بوابة│好作器来利阪 │초과할 수    │
-│necessitatibu│                              │تعديل│持西焦朝三女 │없다. 국가는 │
-│s ius, at    │るべ。際ぐドらづ市居ネムヤ研校│واعتل│。権幽問季負 │여자의 복지와│
-│errem        │岩6繹ごわク報拐イ革深52球ゃレ │اء   │娘購合旧資健 │권익의 향상을│
-│officiis     │スご究東スラ衝3間ラ録占たス。 │ضرب  │載員式活陸。 │위하여       │
-│hendrerit    │禁にンご忘康ざほぎル騰般ねど事│بـ.  │未倍校朝遺続 │노력하여야   │
-│mei. Exerci  │超スんいう真表何カモ自浩ヲシミ│إذ   │術吉迎暮広知 │한다. 국군의 │
-│noster at    │図客線るふ静王ぱーま写村月掛焼│أسر  │角亡志不説空 │조직과 편성은│
-│has, sit id  │                              │اتّجة │住。法省当死 │법률로       │
-│tota         │                              │     │年勝絡聞方北 │정한다.      │
-│convenire,   │詐面ぞゃ。昇強ごントほ価保キ族│اعلان│投健。室分性 │             │
-│vel ex rebum │岡モテ恋困ひりこな刊並せご出来│٣٠   │山天態意画詳 │             │
-│inciderint   │ぼぎむう点目ヲウ止環公ニレ事応│اكتوب│知浅方裁。変 │             │
-│liberavisse. │タス必書タメムノ当84無信升ちひ│ر    │激伝阜中野品 │             │
-│Quaeque      │ょ。価ーぐ中客テサ告覧ヨトハ極│العصب│省載嗅闘額端 │             │
-│delectus     │整ラ得95稿はかラせ江利ス宏丸霊│ة    │反。中必台際 │             │
-│corrumpit cu │ミ考整ス静将ず業巨職ノラホ収嗅│استمر│造事寄民経能 │             │
-│cum.         │ざな。                        │ار   │前作臓       │             │
-│             │                              │ومن. │             │             │
+│intellegebat,│破リヤヨ秒止口イセソス止央のさ│وبيّون│秀同浜東波恋 │임시회의     │
+│id tamquam   │食周健でてつだ官送ト読聴遊容ひ│,    │闘秀。未格打 │회기는 30일을│
+│iudicabit    │るべ。際ぐドらづ市居ネムヤ研校│بوابة│好作器来利阪 │초과할 수    │
+│necessitatibu│35岩6繹ごわク報拐イ革深52球ゃ │تعديل│持西焦朝三女 │없다. 국가는 │
+│s ius, at    │レスご究東スラ衝3間ラ録占たス │واعتل│。権幽問季負 │여자의 복지와│
+│errem        │。                            │اء   │娘購合旧資健 │권익의 향상을│
+│officiis     │禁にンご忘康ざほぎル騰般ねど事│ضرب  │載員式活陸。 │위하여       │
+│hendrerit    │超スんいう真表何カモ自浩ヲシミ│بـ.  │未倍校朝遺続 │노력하여야   │
+│mei. Exerci  │図客線るふ静王ぱーま写村月掛焼│إذ   │術吉迎暮広知 │한다. 국군의 │
+│noster at    │詐面ぞゃ。昇強ごントほ価保キ族│أسر  │角亡志不説空 │조직과 편성은│
+│has, sit id  │85岡モテ恋困ひりこな刊並せご出│اتّجة │住。法省当死 │법률로       │
+│tota         │来ぼぎむう点目ヲウ止環公ニレ事│اعلان│年勝絡聞方北 │정한다.      │
+│convenire,   │応タス必書タメムノ当84無信升ち│, ٣٠ │投健。室分性 │             │
+│vel ex rebum │ひょ。価ーぐ中客テサ告覧ヨトハ│اكتوب│山天態意画詳 │             │
+│inciderint   │極整ラ得95稿はかラせ江利ス宏丸│ر    │知浅方裁。変 │             │
+│liberavisse. │霊ミ考整ス静将ず業巨職ノラホ収│العصب│激伝阜中野品 │             │
+│Quaeque      │嗅ざな。                      │ة    │省載嗅闘額端 │             │
+│delectus     │                              │استمر│反。中必台際 │             │
+│corrumpit cu │                              │ار   │造事寄民経能 │             │
+│cum.         │                              │ومن. │前作臓       │             │
 │             │                              │أفاق │             │             │
 │             │                              │للسيط│             │             │
 │             │                              │رة   │             │             │
@@ -79,4 +78,5 @@
 │             │                              │بلاده│             │             │
 │             │                              │فكانت│             │             │
 │             │                              │حدى  │             │             │
+│             │                              │     │             │             │
 ╰─────────────┴──────────────────────────────┴─────┴─────────────┴─────────────╯

table/testdata/TestWrapPreStyledContent.golden

@@ -0,0 +1,9 @@
+╭─────────┬────────────────┬────────────────────────────────┬─────────────┬────╮
+│Package  │Version         │Link                            │             │    │
+├─────────┼────────────────┼────────────────────────────────┼─────────────┼────┤
+│sourcegit│0.19            │https://aur.archlinux.org/packag│             │    │
+│         │                │es/sourcegit-bin                │             │    │
+│         │                │                                │             │    │
+│Welcome  │いらっしゃいませ│مرحباً                           │환영         │欢迎│
+│Goodbye  │さようなら      │مع السلامة                      │안녕히 가세요│再见│
+╰─────────┴────────────────┴────────────────────────────────┴─────────────┴────╯

table/testdata/TestWrapStyleFuncContent.golden

@@ -0,0 +1,8 @@
+╭─────────┬────────────────┬───────────────────────────────╮
+│Package  │Version         │Link                           │
+├─────────┼────────────────┼───────────────────────────────┤
+│sourcegit│0.19            │https://aur.archlinux.org/packa│
+│         │                │ges/sourcegit-bin              │
+│Welcome  │いらっしゃいませ│مرحباً                          │
+│Goodbye  │さようなら      │مع السلامة                     │
+╰─────────┴────────────────┴───────────────────────────────╯