feat(table): improve sizing and behavior: wrap by default, overflow optionally

[andreynering]

Hey everybody,

The whole work took me multiple days to get right, with a lot of testing and back-and-fourth.

I think it is very close to the ideal now. We may want to do small adjustments, and in this regard I ask for your opinion.

Highlights:

• The whole resizing logic was moved into a separate file, using multiple functions. Before, it was all done inside the Table.String() function.
• Wrapping will now happen by default.
• If wrapping is disabled with t.Wrap(false), the behavior of adding a trailing … is now fixed. Before, it was just cutting the content most of the time.

---

Note

There are many issues related to table rendering. I think this PR might fix all of them. I vote to close all these issues to clean the list up, and if any user still face any minor issue, they can still comment or open new issues to let us know.

• Closes bug(table): v2 uses invalid row index to style cell #459
• Closes Max column width for tables glamour#344
• Closes test(table): expect ellipsis if content is truncated #465
• Closes bug(table): computeHeight doesn't honor all rows when hasHeaders is false #468
• Closes Table manual Height() logic improvement #406
• Closes bug(table): computeHeight doesn't account for margins or padding. #400
• Closes Improper rendering of lipgloss.Table #381
• Closes A table with no outside border, but internal borders, does not render correctly #355
• Closes Table without border and header truncates last line #261
• Previous work: wip: Column wrapping #466
• Previous work: master...table-auto-wrap

---

Screenshots

Before

After

[caarlos0]

can you put some screenshots of before/after?

[andreynering]

@caarlos0 I just added some screenshot to the PR body. They are from the ExampleWrap function, so you can check them locally if you want.

[andreynering]

Also, thanks @bashbunni for all the previous work on this! I end up refactoring most of the code, but many of the new tests and examples were taken from her branches.

[testinfected]

Amazing! Many thanks for that @andreynering

[bashbunni]

Lip Gloss

Examples

✅ Same as master - RTL languages break on Apple's Terminal. Fine in iterm2 and kitty. Probably more to do with ansi package and terminal emulator capabilities.

✅ Same as master - when you resize the terminal window smaller than the table, then change it back to an acceptable size it doesn't redraw quite right

✅ FIXED [Not on master - runtime error when running pokemon table example]

Tests

All good! ✅

Glamour

✅ Artichoke Example (based on v0.7.0)

This is the only example with a table.

Before: (Glamour @ v0.7.0 - pre Lip Gloss table)

After: (Glamour @ master using this branch for Lip Gloss table)

I think this change in style looks good and that the table sizing makes more sense in the "after" image.

Tests

Some tests fail with these changes. Haven't looked deeper on this, but may be worth addressing. Note that these could be due to adaptations we need to make to lipgloss table's usage in glamour's code base, not necessarily caused by the changes in this PR.

• TestRendererIssues/60 - right padding or margin distribution is off given the column sizes + contents.

• TestRendererIssues/46_2 - Unexpected spacing between rows

• TestRendererIssues/44 - Unexpected spacing between rows
  

As mentioned above, there are other tests that are failing and likely need to be updated to work with these changes. That said, all tests pass on Glamour's master branch, so that may indicate that this branch introduces some breaking changes. Again, needs a bit more digging to figure out why these tests are failing.

[andreynering]

@bashbunni Thanks for your detailed review. I just opened charmbracelet/glamour#394 to make the tests pass on Glamour.

[andreynering]

@bashbunni I just fixed the bug causing a panic on the Pokemon example.

[bashbunni]

Note: this feature should not be merged until charmbracelet/x#350 is merged and released as the new cellbuf.Wrap allows us to have clean wrapping of pre-defined styles in tables. We need to support that for Glamour

[aymanbagabas]

I would leave this at 1.18