feat: bracketed paste #397
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This was referenced Aug 15, 2022
|
As discussed with @muesli I changed the PR to always enable bracked paste, unless the option WithoutBracketedPaste is specified on the program. |
meowgorithm
reviewed
Aug 20, 2022
key.go
Outdated
| // | ||
| // The rune array is modified in-place. The returned slice | ||
| // is the original slice shortened after the control characters have been removed. | ||
| func SanitizeRunes(runes []rune, replaceNewLine rune) []rune { |
There was a problem hiding this comment.
Is there any particular reason this function needs to be exported?
There was a problem hiding this comment.
Yes it's for use here: charmbracelet/bubbles#214
I'm expecting any widget that wants to handle multi-rune input to need this (regardless of bracketed paste), so it deserves to be a common utility function.
This comment was marked as outdated.
This comment was marked as outdated.
This was referenced Oct 2, 2022
|
Rebasing. |
muesli
force-pushed
the
bracketed-paste
branch
3 times, most recently
from
1eacdc1
to
23fe7a1
Compare
This comment was marked as outdated.
This comment was marked as outdated.
knz
force-pushed
the
bracketed-paste
branch
5 times, most recently
from
71d1d7d
to
a38be3c
Compare
|
@muesli this is ready again. |
|
@muesli in case you haven't found it already, this patch has a shortcoming: certain terminal emulators feed the pasted datas as non-continuous writes to the terminal buffer, so the bubbletea code can sometimes read less than I will iterate and submit a better version. |
|
I have added a commit on top of the original branch. @muesli you can look at just the diff for the latest commit to see what you need to change on your branch. |
|
Bumping. I have a use-case similar to #800 and would love to be able to detect |
|
Please merge this! |
muesli
force-pushed
the
bracketed-paste
branch
2 times, most recently
from
c0359b4
to
0af1b45
Compare
This introduces support for input via bracketed paste, where escape characters in the pasted input are not interpreted. Pasted input are marked as a special field in the KeyMsg. This is useful because pasted input may need sanitation in individual widgets.
Some terminal emulators feed the bracketed paste data in multiple chunks, which may not be aligned on a 256 byte boundary. So it's possible for `input.Read` to return less than 256 bytes read but while there's still more data to be read to complete a bracketed paste input.
muesli
force-pushed
the
bracketed-paste
branch
from
0af1b45
to
0248b32
Compare
another-rex
pushed a commit
to google/osv-scanner
that referenced
this pull request
May 6, 2024
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [deps.dev/api/v3](https://togithub.com/google/deps.dev) | `v3.0.0-20240411010756-f6f382da6e02` -> `v3.0.0-20240503042720-6166138ce783` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [deps.dev/util/maven](https://togithub.com/google/deps.dev) | `v0.0.0-20240411010756-f6f382da6e02` -> `v0.0.0-20240503042720-6166138ce783` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [deps.dev/util/resolve](https://togithub.com/google/deps.dev) | `v0.0.0-20240411010756-f6f382da6e02` -> `v0.0.0-20240503042720-6166138ce783` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [deps.dev/util/semver](https://togithub.com/google/deps.dev) | `v0.0.0-20240411010756-f6f382da6e02` -> `v0.0.0-20240503042720-6166138ce783` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [github.com/charmbracelet/bubbletea](https://togithub.com/charmbracelet/bubbletea) | `v0.25.0` -> `v0.26.1` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [github.com/gkampitakis/go-snaps](https://togithub.com/gkampitakis/go-snaps) | `v0.5.3` -> `v0.5.4` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [github.com/jedib0t/go-pretty/v6](https://togithub.com/jedib0t/go-pretty) | `v6.5.8` -> `v6.5.9` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [github.com/urfave/cli/v2](https://togithub.com/urfave/cli) | `v2.27.1` -> `v2.27.2` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | golang.org/x/term | `v0.19.0` -> `v0.20.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | | [google.golang.org/protobuf](https://togithub.com/protocolbuffers/protobuf-go) | `v1.33.0` -> `v1.34.0` | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>charmbracelet/bubbletea (github.com/charmbracelet/bubbletea)</summary> ### [`v0.26.1`](https://togithub.com/charmbracelet/bubbletea/releases/tag/v0.26.1) [Compare Source](https://togithub.com/charmbracelet/bubbletea/compare/v0.26.0...v0.26.1) This is a quick one to fix a Windows shortcoming in the last release acutely identified by our pal [@​jon4hz](https://togithub.com/jon4hz). Thank you! #### What's Changed - fix: support more shift and ctrl modifiers on windows by [@​jon4hz](https://togithub.com/jon4hz) in [charmbracelet/bubbletea#995 **Full Changelog**: charmbracelet/bubbletea@v0.26.0...v0.26.1 *** <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/@​charmcli), or [Discord](https://charm.sh/chat). ### [`v0.26.0`](https://togithub.com/charmbracelet/bubbletea/releases/tag/v0.26.0) [Compare Source](https://togithub.com/charmbracelet/bubbletea/compare/v0.25.0...v0.26.0) ### Bracketed Paste, Windows Improvements, Mainframes, and more What do tapioca balls, IBM mainframes, and the Microsoft Windows Console API have in common? Bubble Tea v0.26.0, that’s what. Let’s get to it. #### ⚡️ Windows Input Improvements A few years ago [@​erikgeiser](https://togithub.com/erikgeiser), a penetration tester and ex-particle physicist, wrote this awesome library called [coninput](https://togithub.com/erikgeiser/coninput) to majorly improve Bubble Tea input on Windows. [@​aymanbagabas](https://togithub.com/aymanbagabas) has implemented the library in Bubble Tea and input on Windows is roughly 1000 times better now. In the short term, this means that for Windows users inputting non-Latin characters (like Greek, Cyrillic, Korean, Chinese and so on) stuff will “just work.” The bigger news, however, is that this paves the way for Windows parity with our forthcoming support for super high fidelity input via [Kitty Keyboard](https://sw.kovidgoyal.net/kitty/keyboard-protocol/) and [Fixterms](https://www.leonerd.org.uk/hacks/fixterms/). #### 🍳 Hot Windows Resize Events Terminal emulators on Windows don’t support the `SIGWINCH` signal, which is sent when the terminal is resized. It’s been a huge bummer for a really long time. Thanks (again) to [@​erikgeiser](https://togithub.com/erikgeiser) and [@​aymanbagabas](https://togithub.com/aymanbagabas), we’re now able to reach deep into Windows’ underpinnings, detect window resizes, and send [`tea.WindowSizeMsg`](https://pkg.go.dev/github.com/charmbracelet/bubbletea@v0.26.0#WindowSizeMsg)s accordingly! This is a glorious moment for Bubble Tea on Windows indeed. #### 🫠 Bracketed Paste While building a query editor for a CockroachDB client, [@​knz](https://togithub.com/knz) noticed that Bubble Tea didn't support [Bracketed Paste](https://cirw.in/blog/bracketed-paste). Performance-wise, that sucks because it means pasting large bodies of text (like SQL queries) will normally be seen as a bunch of little successive keypresses. That’s where Bracketed Paste comes in. When enabled at the terminal-level Bracketed Paste lets you slam down a bunch of text with one big, fat input event. Bubble Tea enables bracketed paste by default, however you can opt out of it with the [`WithoutBracketedPaste()`](https://pkg.go.dev/github.com/charmbracelet/bubbletea@v0.26.0#WithoutBracketedPaste) program option: ```go p := tea.NewProgram(myCuteModel, tea.WithoutBracketedPaste()) ``` You can also enable and disable it on demand with the [`EnableBracketedPaste()`](https://pkg.go.dev/github.com/charmbracelet/bubbletea@v0.26.0#EnableBracketedPaste) and [`DisableBracketedPaste()`](https://pkg.go.dev/github.com/charmbracelet/bubbletea@v0.26.0#DisableBracketedPaste) commands. #### 🌿 Multiline `tea.Println` In case you forgot, [`tea.Println`](https://pkg.go.dev/github.com/charmbracelet/bubbletea@v0.26.0#Println) (and it’s brother [`tea.Printf`](https://pkg.go.dev/github.com/charmbracelet/bubbletea@v0.26.0#Printf)) is a `Cmd` that lets you print unmanaged output above a Bubble Tea program, similar to what you see with package managers like `apt-get`. Thanks to [@​Adjective-Object](https://togithub.com/Adjective-Object) (who also implemented `tea.Println` in the first place) now you can send multi-line output, too. For a `tea.Println` refresher see [the package manager example](https://togithub.com/charmbracelet/bubbletea/tree/master/examples/package-manager). #### 📀 Hello, z/OS Don’t you think it’s about time we all ran Bubble Tea apps on our mainframes? Thanks to [@​dustin-ward](https://togithub.com/dustin-ward) that dream is now a reality, so long as you have a [z/OS](https://www.ibm.com/products/zos) mainframe. We're thrilled to announce that Bubble Tea is now fully supported on z/OS. #### 🌹 Bug fixes Bugfixes are the unsung heroes that sometimes get buried below the feature listings. This release has them and they’re good ones; see the changelog below for details. #### Changelog ##### New! - bracketed paste by [@​knz](https://togithub.com/knz) in [charmbracelet/bubbletea#397 - use windows console input buffer + resize events on windows by [@​aymanbagabas](https://togithub.com/aymanbagabas) in [charmbracelet/bubbletea#878 - multiline `tea.Println()` messages by [@​Adjective-Object](https://togithub.com/Adjective-Object) in [charmbracelet/bubbletea#490 - z/OS support by [@​dustin-ward](https://togithub.com/dustin-ward) in [charmbracelet/bubbletea#913 ##### Changed - use go 1.18; update bubbles by [@​caarlos0](https://togithub.com/caarlos0) in [charmbracelet/bubbletea#916 ##### Fixed - fix deadlock condition on model init panic by [@​eolso](https://togithub.com/eolso) in [charmbracelet/bubbletea#926 - reduce console/term dependencies by [@​aymanbagabas](https://togithub.com/aymanbagabas) in [charmbracelet/bubbletea#897 - optimize batches with one item by [@​systay](https://togithub.com/systay) in [charmbracelet/bubbletea#875 ##### New Contributors - [@​kevgo](https://togithub.com/kevgo) made their first contribution in [charmbracelet/bubbletea#893 - [@​canack](https://togithub.com/canack) made their first contribution in [charmbracelet/bubbletea#890 - [@​Pheon-Dev](https://togithub.com/Pheon-Dev) made their first contribution in [charmbracelet/bubbletea#621 - [@​rusinikita](https://togithub.com/rusinikita) made their first contribution in [charmbracelet/bubbletea#835 - [@​hedhyw](https://togithub.com/hedhyw) made their first contribution in [charmbracelet/bubbletea#864 - [@​mat2cc](https://togithub.com/mat2cc) made their first contribution in [charmbracelet/bubbletea#871 - [@​stefanlogue](https://togithub.com/stefanlogue) made their first contribution in [charmbracelet/bubbletea#855 - [@​BigJk](https://togithub.com/BigJk) made their first contribution in [charmbracelet/bubbletea#885 - [@​sharunkumar](https://togithub.com/sharunkumar) made their first contribution in [charmbracelet/bubbletea#839 - [@​timmattison](https://togithub.com/timmattison) made their first contribution in [charmbracelet/bubbletea#908 - [@​dustin-ward](https://togithub.com/dustin-ward) made their first contribution in [charmbracelet/bubbletea#913 - [@​jaymorelli96](https://togithub.com/jaymorelli96) made their first contribution in [charmbracelet/bubbletea#802 - [@​siddhantac](https://togithub.com/siddhantac) made their first contribution in [charmbracelet/bubbletea#906 - [@​taigrr](https://togithub.com/taigrr) made their first contribution in [charmbracelet/bubbletea#853 - [@​systay](https://togithub.com/systay) made their first contribution in [charmbracelet/bubbletea#875 - [@​gabe565](https://togithub.com/gabe565) made their first contribution in [charmbracelet/bubbletea#728 - [@​zMoooooritz](https://togithub.com/zMoooooritz) made their first contribution in [charmbracelet/bubbletea#902 - [@​j178](https://togithub.com/j178) made their first contribution in [charmbracelet/bubbletea#709 - [@​arisnacg](https://togithub.com/arisnacg) made their first contribution in [charmbracelet/bubbletea#948 - [@​braheezy](https://togithub.com/braheezy) made their first contribution in [charmbracelet/bubbletea#950 - [@​dhth](https://togithub.com/dhth) made their first contribution in [charmbracelet/bubbletea#949 - [@​tearingItUp786](https://togithub.com/tearingItUp786) made their first contribution in [charmbracelet/bubbletea#944 - [@​aschey](https://togithub.com/aschey) made their first contribution in [charmbracelet/bubbletea#597 - [@​petergloor](https://togithub.com/petergloor) made their first contribution in [charmbracelet/bubbletea#955 - [@​kaifulee](https://togithub.com/kaifulee) made their first contribution in [charmbracelet/bubbletea#957 - [@​danenania](https://togithub.com/danenania) made their first contribution in [charmbracelet/bubbletea#971 - [@​cuibuwei](https://togithub.com/cuibuwei) made their first contribution in [charmbracelet/bubbletea#977 - [@​agvxov](https://togithub.com/agvxov) made their first contribution in [charmbracelet/bubbletea#972 - [@​eolso](https://togithub.com/eolso) made their first contribution in [charmbracelet/bubbletea#926 **Full Changelog**: charmbracelet/bubbletea@v0.25.0...v0.25.1 *** <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/@​charmcli), or [Discord](https://charm.sh/chat). </details> <details> <summary>gkampitakis/go-snaps (github.com/gkampitakis/go-snaps)</summary> ### [`v0.5.4`](https://togithub.com/gkampitakis/go-snaps/releases/tag/v0.5.4) [Compare Source](https://togithub.com/gkampitakis/go-snaps/compare/v0.5.3...v0.5.4) #### What's Changed - fix: slice bounds out of range \[:5] by [@​zregvart](https://togithub.com/zregvart) in [gkampitakis/go-snaps#98 #### New Contributors - [@​zregvart](https://togithub.com/zregvart) made their first contribution in [gkampitakis/go-snaps#98 **Full Changelog**: gkampitakis/go-snaps@v0.5.3...v0.5.4 </details> <details> <summary>jedib0t/go-pretty (github.com/jedib0t/go-pretty/v6)</summary> ### [`v6.5.9`](https://togithub.com/jedib0t/go-pretty/releases/tag/v6.5.9) [Compare Source](https://togithub.com/jedib0t/go-pretty/compare/v6.5.8...v6.5.9) #### What's Changed - table: html row automerge support by [@​hindessm](https://togithub.com/hindessm) in [jedib0t/go-pretty#319 - table: update note about auto-merge by [@​hindessm](https://togithub.com/hindessm) in [jedib0t/go-pretty#320 #### New Contributors - [@​hindessm](https://togithub.com/hindessm) made their first contribution in [jedib0t/go-pretty#319 **Full Changelog**: jedib0t/go-pretty@v6.5.8...v6.5.9 </details> <details> <summary>urfave/cli (github.com/urfave/cli/v2)</summary> ### [`v2.27.2`](https://togithub.com/urfave/cli/releases/tag/v2.27.2) [Compare Source](https://togithub.com/urfave/cli/compare/v2.27.1...v2.27.2) #### What's Changed - Cleanup: Remove unnecessary intermediate variables by [@​1ambd4](https://togithub.com/1ambd4) in [urfave/cli#1857 - Docs:(issue\_1866) Fix documentation on filepath vs env preference by [@​dearchap](https://togithub.com/dearchap) in [urfave/cli#1867 - Fix:(issue\_1860) Remove hidden flags from flag categories by [@​dearchap](https://togithub.com/dearchap) in [urfave/cli#1868 - Fix repeated \[arguments...] in usage template in v2 by [@​edeustua](https://togithub.com/edeustua) in [urfave/cli#1872 - Update dependencies, actions steps, and usage for v2-maint by [@​meatballhat](https://togithub.com/meatballhat) in [urfave/cli#1888 #### New Contributors - [@​1ambd4](https://togithub.com/1ambd4) made their first contribution in [urfave/cli#1857 - [@​edeustua](https://togithub.com/edeustua) made their first contribution in [urfave/cli#1872 **Full Changelog**: urfave/cli@v2.27.1...v2.27.2 </details> <details> <summary>protocolbuffers/protobuf-go (google.golang.org/protobuf)</summary> ### [`v1.34.0`](https://togithub.com/protocolbuffers/protobuf-go/compare/v1.33.0...v1.34.0) [Compare Source](https://togithub.com/protocolbuffers/protobuf-go/compare/v1.33.0...v1.34.0) </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:eyJjcmVhdGVkSW5WZXIiOiIzNy4zMjEuMiIsInVwZGF0ZWRJblZlciI6IjM3LjM0MC4xMCIsInRhcmdldEJyYW5jaCI6Im1haW4iLCJsYWJlbHMiOlsiZGVwZW5kZW5jaWVzIl19-->
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
First 3 commits from #568, #569 and #570.
Partial fix to #404
This introduces support for input via bracketed paste, where escape
characters in the pasted input are not interpreted.
Pasted input are marked as a special field in the KeyMsg.
This is because pasted input may need sanitation in individual widgets.
cc @maaslalani @muesli