Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: switch to term/ansi for text manipulation #268

Merged
merged 2 commits into from Mar 29, 2024
Merged

Conversation

aymanbagabas
Copy link
Member

@aymanbagabas aymanbagabas commented Mar 14, 2024

Use ANSI aware, wide characters support, uniseg backed term/ansi package to calculate string widths, truncate, and wrap strings.

Related: muesli/reflow#71
Fixes: #258
Related: #220

Copy link
Contributor

@mikelorant mikelorant left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Everything looks good except the confusion caused by the commented out line.

join.go Outdated Show resolved Hide resolved
@aymanbagabas aymanbagabas force-pushed the use-ansi branch 4 times, most recently from caab99b to e28ab39 Compare March 28, 2024 15:12
Use ANSI aware, wide characters support, uniseg backed term/ansi package
to calculate string widths, truncate, and wrap strings.

Related: muesli/reflow#71
Fixes: #258
Fixes: #220
get.go Outdated Show resolved Hide resolved
@aymanbagabas aymanbagabas merged commit f6f9334 into master Mar 29, 2024
18 checks passed
@aymanbagabas aymanbagabas deleted the use-ansi branch March 29, 2024 19:05
@mikelorant
Copy link
Contributor

@aymanbagabas We need Bubbles to be updated ASAP as this will cause major inconsistencies.

another-rex added a commit to google/osv-scanner that referenced this pull request May 27, 2024
Renovate + Also Remove/updates some deprecated function calls

[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence | Type |
Update |
|---|---|---|---|---|---|---|---|
| [github.com/BurntSushi/toml](https://togithub.com/BurntSushi/toml) |
`v1.3.2` -> `v1.4.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fBurntSushi%2ftoml/v1.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fBurntSushi%2ftoml/v1.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fBurntSushi%2ftoml/v1.3.2/v1.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fBurntSushi%2ftoml/v1.3.2/v1.4.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
| require | minor |
|
[github.com/charmbracelet/bubbletea](https://togithub.com/charmbracelet/bubbletea)
| `v0.26.2` -> `v0.26.3` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fcharmbracelet%2fbubbletea/v0.26.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fcharmbracelet%2fbubbletea/v0.26.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fcharmbracelet%2fbubbletea/v0.26.2/v0.26.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fcharmbracelet%2fbubbletea/v0.26.2/v0.26.3?slim=true)](https://docs.renovatebot.com/merge-confidence/)
| require | patch |
|
[github.com/charmbracelet/lipgloss](https://togithub.com/charmbracelet/lipgloss)
| `v0.10.0` -> `v0.11.0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/github.com%2fcharmbracelet%2flipgloss/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/github.com%2fcharmbracelet%2flipgloss/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/github.com%2fcharmbracelet%2flipgloss/v0.10.0/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/github.com%2fcharmbracelet%2flipgloss/v0.10.0/v0.11.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
| require | minor |
| golang.org/x/exp | `9bf2ced` -> `4c93da0` |
[![age](https://developer.mend.io/api/mc/badges/age/go/golang.org%2fx%2fexp/v0.0.0-20240525044651-4c93da0ed11d?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/go/golang.org%2fx%2fexp/v0.0.0-20240525044651-4c93da0ed11d?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/go/golang.org%2fx%2fexp/v0.0.0-20240506185415-9bf2ced13842/v0.0.0-20240525044651-4c93da0ed11d?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/go/golang.org%2fx%2fexp/v0.0.0-20240506185415-9bf2ced13842/v0.0.0-20240525044651-4c93da0ed11d?slim=true)](https://docs.renovatebot.com/merge-confidence/)
| require | digest |

---

### Release Notes

<details>
<summary>BurntSushi/toml (github.com/BurntSushi/toml)</summary>

### [`v1.4.0`](https://togithub.com/BurntSushi/toml/releases/tag/v1.4.0)

[Compare
Source](https://togithub.com/BurntSushi/toml/compare/v1.3.2...v1.4.0)

This version requires Go 1.18

- Add toml.Marshal()
([#&#8203;405](https://togithub.com/BurntSushi/toml/issues/405))

- Require 2-digit hour
([#&#8203;320](https://togithub.com/BurntSushi/toml/issues/320))

- Wrap UnmarshalTOML() and UnmarshalText() return values in ParseError
for position information
([#&#8203;398](https://togithub.com/BurntSushi/toml/issues/398))

- Fix inline tables with dotted keys inside inline arrays (e.g.
`k=[{a.b=1}]`)
([#&#8203;400](https://togithub.com/BurntSushi/toml/issues/400))

</details>

<details>
<summary>charmbracelet/bubbletea
(github.com/charmbracelet/bubbletea)</summary>

###
[`v0.26.3`](https://togithub.com/charmbracelet/bubbletea/releases/tag/v0.26.3)

[Compare
Source](https://togithub.com/charmbracelet/bubbletea/compare/v0.26.2...v0.26.3)

This is a patch release that prevents `tea.WindowSizeMsg`s from being
fired during altscreen changes on Windows. This was due to the fact that
Windows emits a `window-size-event` on altscreen changes even if the
size hand’t changed. Now, we cache the window-size and compare before
sending the message to the `Model`.

#### What's Changed

- Prevent multiple window-size-events from firing on Windows by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/bubbletea#1021
- refactor: use x/term and x/ansi for renderer sequences by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/bubbletea#962

**Full Changelog**:
charmbracelet/bubbletea@v0.26.2...v0.26.3

***

<a href="https://charm.sh/"><img alt="The Charm logo"
src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Thoughts? Questions? We love hearing from you. Feel free to reach out on
[Twitter](https://twitter.com/charmcli), [The
Fediverse](https://mastodon.social/@&#8203;charmcli), or
[Discord](https://charm.sh/chat).

</details>

<details>
<summary>charmbracelet/lipgloss
(github.com/charmbracelet/lipgloss)</summary>

###
[`v0.11.0`](https://togithub.com/charmbracelet/lipgloss/releases/tag/v0.11.0)

[Compare
Source](https://togithub.com/charmbracelet/lipgloss/compare/v0.10.0...v0.11.0)

### Immutable Styles and Raw Speed, Baby

So! The big news in this release is:

-   `Style` methods will now *always* return new styles
-   `Style` and ANSI operations under the hood are faster

There are also a handful of great lil' bug fixes. Read on for more.

#### Immutable Styles

Every `Style` method now returns a completely new style with its own
underlying data structure no matter what. This means working with Styles
is a lot easier. No more need for `Copy()`!

```go
// Before
s := lipgloss.NewStyle().Bold(true)
newStyle := s.Copy()

// After
s := lipgloss.NewStyle().Bold(true)
newStyle := s // this is a true copy
```

Okay, but why are styles easier to work with now? Consider this:

```go
// Before
baseStyle := lipgloss.NewStyle().Background(lipgloss.Color("59"))
styleAtRuntime := baseStyle.Copy().Width(m.Width)

// After
baseStyle := lipgloss.NewStyle().Padding(1, 2)
styleAtRuntime := baseStyle.Width(m.Width)
```

It might seem small, but eliminating the risk of mutations in persistent
styles in an enormous usability improvement.

##### How to upgrade

There's nothing to do, however `Style.Copy()` is now deprecated and only
returns itself, so you can just remove `Style.Copy()` calls. If you need
to *just* copy a style without any changes to it you can simply `b :=
a`.

#### Faster ANSI

Sometimes watch companies brag about their "in-house" watch movement.
Well, now we're bragging about our in-house-amazing
[`x/ansi`](https://togithub.com/charmbracelet/x/tree/main/ansi) library
by our own [@&#8203;aymanbagabas](https://togithub.com/aymanbagabas).
It's a fine-tuned, low-level way to manage ANSI sequencing and, because
we're pretty nerdy, we’re *super* excited about it.

***

#### What's Changed

##### New!

- always return copies of styles by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#276

##### Changed

- switch to term/ansi for text manipulation by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#268
- replace stripansi with ansi.Strip in table by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#271
- test for different GOOS & GOARCH by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#292

##### Fixed

- fix combining both conditional and unconditional wrapping by
[@&#8203;aymanbagabas](https://togithub.com/aymanbagabas) in
[charmbracelet/lipgloss#275
- fix UnderlineSpaces and StrikethroughSpaces by
[@&#8203;Taz03](https://togithub.com/Taz03) in
[charmbracelet/lipgloss#299
- always render horizontal border edges when enabled by
[@&#8203;UnseenBook](https://togithub.com/UnseenBook) in
[charmbracelet/lipgloss#211
- fix possible nil panic by
[@&#8203;maaslalani](https://togithub.com/maaslalani) in
[charmbracelet/lipgloss#245
- fix transform operating on ANSI sequences by
[@&#8203;meowgorithm](https://togithub.com/meowgorithm) in
[charmbracelet/lipgloss#274
- change propkeys from int to int64 by
[@&#8203;hugoleodev](https://togithub.com/hugoleodev) in
[charmbracelet/lipgloss#291

#### New Contributors

- [@&#8203;benwaffle](https://togithub.com/benwaffle) made their first
contribution in
[charmbracelet/lipgloss#247
- [@&#8203;UnseenBook](https://togithub.com/UnseenBook) made their first
contribution in
[charmbracelet/lipgloss#211
- [@&#8203;hugoleodev](https://togithub.com/hugoleodev) made their first
contribution in
[charmbracelet/lipgloss#291
- [@&#8203;Taz03](https://togithub.com/Taz03) made their first
contribution in
[charmbracelet/lipgloss#299

**Full Changelog**:
charmbracelet/lipgloss@v0.10.0...v0.11.0

***

<a href="https://charm.sh/"><img alt="The Charm logo"
src="https://stuff.charm.sh/charm-badge.jpg" width="400"></a>

Thoughts? Questions? We love hearing from you. Feel free to reach out on
[Twitter](https://twitter.com/charmcli), [The
Fediverse](https://mastodon.technology/@&#8203;charm), or
[Discord](https://charm.sh/discord).

</details>

---

### Configuration

📅 **Schedule**: Branch creation - "before 6am on monday" in timezone
Australia/Sydney, Automerge - At any time (no schedule defined).

🚦 **Automerge**: Disabled by config. Please merge this manually once you
are satisfied.

♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the
rebase/retry checkbox.

👻 **Immortal**: This PR will be recreated if closed unmerged. Get
[config help](https://togithub.com/renovatebot/renovate/discussions) if
that's undesired.

---

- [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check
this box

---

This PR has been generated by [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/google/osv-scanner).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4zNjguMTAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4zNjguMTAiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbImRlcGVuZGVuY2llcyJdfQ==-->

---------

Co-authored-by: Rex P <rexpan@google.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

"nonspacing mark" unicode causes container's width to shift
3 participants