v5.0.1

Compare Source

Two v5 API bugs traced to the same root cause: NewAnalyzer captured patterns into the processor before the analysis driver parsed flags, so flag-driven values never reached analysis, and the Config fields had to be typed against internal/pattern to be writable at all.

Fixes

• -enforce-rx, -ignore-rx, -optional-rx, and -allow-empty-rx had no effect under the standalone CLI (#​155). Processor construction now happens lazily on first analyzer run, after flags are populated. golangci-lint integrations were unaffected, since they populate Config programmatically before calling NewAnalyzer.

• analyzer.Config no longer leaks the internal pattern.List type (#​158). The four pattern fields (EnforcePatterns, IgnorePatterns, OptionalPatterns, AllowEmptyPatterns) are now plain []string; pattern compilation has moved inside the analyzer. Library callers populating these fields directly drop the pattern.NewList call:

  // before
  list, _ := pattern.NewList(`.*\.Foo`)
  analyzer.Config{ EnforcePatterns: list }
  
  // after
  analyzer.Config{ EnforcePatterns: []string{`.*\.Foo`} }

Upgrading

go install dev.gaijin.team/go/exhaustruct/v5/cmd/exhaustruct@latest

CLI users reinstall. Library callers update Config field assignments as shown above.

v5.0.0

Compare Source

exhaustruct v5 reshapes how the linter is configured. Struct tags give way to comment directives, opt-in checking lands as a first-class mode, and patterns now reach down to individual fields. The full reference is in the README; this is the highlight reel.

What's new

Comment directives replace struct tags. Three directives — enforce, ignore, optional — now work at three levels of granularity: type definitions, struct literals, and individual fields. A documented priority order keeps the interaction between them predictable.

//exhaustruct:enforce
type Config struct {
    Host    string
    //exhaustruct:optional
    Timeout int
}

Explicit mode (-explicit) flips the default. Instead of checking every struct literal in the project, the linter only checks types you've explicitly marked — either with //exhaustruct:enforce or via -enforce-rx. The right pick for large codebases where exhaustruct should be a precision tool, not a blanket policy.

Field-level regex patterns. The pattern flags now accept Type#Field syntax, so a single configuration line can express optionality across a codebase without touching the type definitions:

.*\.Server#Timeout    # Timeout field in any Server type

Optional patterns (-optional-rx). Regex-based optionality for whole types or specific fields. Closes a long-standing gap for third-party types you can't annotate directly.

Derived types and aliases now follow a clearer rule. Field-level directives carry through type T = U and type T U — so a field marked optional stays optional on every alias and derived type. Type-level directives stay attached to the original type, which means you can promote a derived type to "enforced" independently.

Better diagnostics. -report-full-type-path reports net/http.Cookie instead of http.Cookie, removing ambiguity when import aliases are in play (#​146). -debug-cache-metrics prints per-package cache statistics, useful for tuning patterns on large projects.

Auto-migration. exhaustruct -fix ./... rewrites the legacy exhaustruct:"optional" tags to comment directives in one pass — no manual sweep required.

Breaking changes

• Struct tags retired. exhaustruct:"optional" is no longer recognized. The -fix flag migrates existing tags automatically; the manual equivalent is a one-line move from the field's struct tag to a //exhaustruct:optional comment above (or beside) the field.
• Flag rename. The old include/exclude vocabulary suggested filtering, but the linter has always been about enforcement. The new names say what they do:
  • -include-rx / -i → -enforce-rx
  • -exclude-rx / -e → -ignore-rx
• Module path moves to /v5. Update imports and reinstall:

  go install dev.gaijin.team/go/exhaustruct/v5/cmd/exhaustruct@latest

Fixes

• Implicit pointer composite literals (&T{} returned where the function signature expects *T) are now flagged — previously they slipped past the checker (#​147).
• Aliased struct types resolve through types.Unalias so their fields are inspected even behind an alias chain (#​149).

Migrating from v4

1. Update import paths from /v4 to /v5.
2. Run exhaustruct -fix ./... to rewrite struct tags to comment directives.
3. Replace -include-rx / -i with -enforce-rx, and -exclude-rx / -e with -ignore-rx in CI configs and .golangci.yaml.
4. Optional: consider -explicit if you'd rather opt specific types into checking than opt the rest out.

v16.0.0

Compare Source

v5.8.0

Compare Source

What's Changed

• Re-purpose the meaning of 0 for cuddle-max-statements by @​bombsimon in #​258
• Add cuddle-group check by @​bombsimon in #​257
• defer allows any expression with intersecting variables by @​bombsimon in #​260
• Treat go cuddling same as defer by @​bombsimon in #​261
• Support all go 1.25 versions by @​bombsimon in #​262
• Ensure CheckErr takes precedence over all other cuddling rules by @​bombsimon in #​263
• Update version by @​bombsimon in #​259

Full Changelog: bombsimon/wsl@v5.7.0...v5.8.0

v5.7.0

Compare Source

⚠️ DO NOT USE

This was a pre-mature release containing regressions and unfinished changes. This release was never included in golangci-lint and will be replaced with v5.8.0

What's Changed

• fix(deps): update module golang.org/x/tools to v0.42.0 by @​renovate[bot] in #​232
• Update go version by @​bombsimon in #​238
• Update faulty doc for branch-max-lines flag by @​bombsimon in #​237
• chore(deps): update dependency golangci/golangci-lint to v2.11.1 by @​renovate[bot] in #​239
• chore(deps): update dependency golangci/golangci-lint to v2.11.2 by @​renovate[bot] in #​240
• chore(deps): update dependency golangci/golangci-lint to v2.11.3 by @​renovate[bot] in #​241
• fix(deps): update module golang.org/x/tools to v0.43.0 by @​renovate[bot] in #​242
• chore(deps): update dependency golangci/golangci-lint to v2.11.4 by @​renovate[bot] in #​246
• chore(deps): switch from gopkg.in/yaml.v3 to go.yaml.in/yaml/v3 by @​scop in #​247
• Update module golang.org/x/tools to v0.44.0 by @​renovate[bot] in #​249
• feat: add cuddle-max-statements config by @​bombsimon in #​245
• Fix decl grouping collapsing multiline composite literals by @​bombsimon in #​250
• Update docs by @​bombsimon in #​251
• Add after- checks by @​bombsimon in #​253
• Fix go/defer not inspecting anonymous function bodies by @​bombsimon in #​255
• Update version - prepare for release by @​bombsimon in #​256

New Contributors

• @​scop made their first contribution in #​247

Full Changelog: bombsimon/wsl@v5.6.0...v5.7.0

v5.6.0

Compare Source

What's Changed

• Don't check comments in else blocks by @​bombsimon in #​230

Full Changelog: bombsimon/wsl@v5.5.0...v5.6.0

v5.5.0

Compare Source

What's Changed

• Rename check from newline-after-block to after-block by @​bombsimon in #​228
• Prepare for v5.5.0 by @​bombsimon in #​229

Full Changelog: bombsimon/wsl@v5.4.0...v5.5.0

v5.4.0

Compare Source

NOTE ⚠️

This release immediately got superseded by v5.5.0. The only reason being a fix of a bad name of the new check before widely spread. The check should be referred to as after-block which it is from v5.5.0 and onwards.

What's Changed

• Run all tests in parallel by @​bombsimon in #​203
• chore: Configure Renovate - autoclosed by @​renovate[bot] in #​205
• chore(deps): update coverallsapp/github-action action to v1.2.5 by @​renovate[bot] in #​206
• fix(deps): update module github.com/stretchr/testify to v1.11.1 by @​renovate[bot] in #​210
• chore(deps): update jandelgado/gcov2lcov-action action to v1.2.0 by @​renovate[bot] in #​209
• chore(deps): update actions/checkout action to v6 by @​renovate[bot] in #​212
• chore(deps): update golangci/golangci-lint-action action to v9 by @​renovate[bot] in #​215
• chore(deps): update coverallsapp/github-action action to v2 by @​renovate[bot] in #​214
• chore(deps): update actions/setup-go action to v6 by @​renovate[bot] in #​213
• fix(deps): update module golang.org/x/tools to v0.39.0 by @​renovate[bot] in #​211
• fix(deps): update module golang.org/x/tools to v0.40.0 by @​renovate[bot] in #​217
• Allow cuddling mutex locking/unlocking by @​bombsimon in #​219
• fix(deps): update module golang.org/x/tools to v0.41.0 by @​renovate[bot] in #​220
• Add support for newline-after-block by @​bombsimon in #​221
• Avoid creating CommentMap by @​bombsimon in #​225
• Use ast.Inspect instead of checkExpr and manually calls by @​bombsimon in #​226
• Prepare release v5.4.0 by @​bombsimon in #​227

New Contributors

• @​renovate[bot] made their first contribution in #​205

Full Changelog: bombsimon/wsl@v5.3.0...v5.4.0

Thanks

• @​breml for report, discussion and extensive test data for the new check newline-after-block

v5.3.0

Compare Source

What's Changed

• Add more granular checks when checking error cuddling by @​bombsimon in #​198
• Ensure all test code is valid and compiles by @​bombsimon in #​200
• Ignore idents for constants, types, packages and nil by @​bombsimon in #​201
• Bump version by @​bombsimon in #​202

Full Changelog: bombsimon/wsl@v5.2.0...v5.3.0

v5.2.0

Compare Source

What's Changed

• Add support to check KeyValueExpr values by @​bombsimon in #​192
• Traverse all possible subexpressions by @​WGH- in #​193
• Circuit break some checks for labels by @​bombsimon in #​196

New Contributors

• @​WGH- made their first contribution in #​193

Full Changelog: bombsimon/wsl@v5.1.1...v5.2.0

v5.1.1

Compare Source

What's Changed

• Update docs for golangci-lint by @​bombsimon in #​185
• Bump golangci-lint, update config by @​bombsimon in #​188
• Add custom version flag by @​bombsimon in #​189
• Bump version constant for new release by @​bombsimon in #​190

Full Changelog: bombsimon/wsl@v5.1.0...v5.1.1

v5.1.0

Compare Source

What's Changed

• tests: rename wsl_test to analyzer_test by @​ldez in #​182
• Make error checking more laxed by @​bombsimon in #​184

Full Changelog: bombsimon/wsl@v5.0.0...v5.1.0

v5.0.0

Compare Source

What's Changed

• wsl v5 - a complete rewrite ✍️ by @​bombsimon in #​169
• Add tests for config and analyzer by @​bombsimon in #​170
• Port test for #​153 by @​bombsimon in #​172
• Allow idents from case arms when cuddling by @​bombsimon in #​173
• Use lineFor to get node line by @​bombsimon in #​176
• Improve fixer for DeclStmt by @​bombsimon in #​175
• Update docs, enable err by default by @​bombsimon in #​178
• Improve err checking, ensure working isolated by @​bombsimon in #​179
• Add test to ensure err check works isolated by @​bombsimon in #​180
• Make append check work isolated, update check type for append by @​bombsimon in #​181

Full Changelog: bombsimon/wsl@v4.7.0...v5.0.0

v2.1.0

Compare Source

Shrink ’n’ grow your textareas

The update adds a new feature to automatically resize your textarea vertically as its content changes.

ta := textarea.New()
ta.DynamicHeight = true   // Enable dynamic resizing
ta.MinHeight = 3          // Minimum visible rows
ta.MaxHeight = 10         // Maximum visible rows
ta.MaxContentHeight = 20  // Maximum rows of content

Piece of cake, right?

Enjoy! 💘

Changelog

New!

• f1daacf: feat(textarea): dynamic height (#​910) (@​meowgorithm)

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.0

Compare Source

Bubbles v2 is here! 🫧

We're thrilled to share Bubbles v2 with you! This release accompanies Bubble Tea v2 and Lip Gloss v2 and brings a ton of consistency, new features, and quality-of-life improvements across every component. Catch 'em all:

go get charm.land/bubbletea/v2
go get charm.land/bubbles/v2
go get charm.land/lipgloss/v2

You can also check the Upgrade Guide for more info.

There are a lot of changes in here, but we've found upgrading pretty easy, especially with a linter. Read on for the full breakdown!

[!NOTE]
When in doubt, check the examples for reference — they've all been updated for v2.

🏠 New Home

Bubbles v2 now lives at charm.land:

import "charm.land/bubbles/v2"

All sub-packages follow the same pattern: charm.land/bubbles/v2/viewport, charm.land/bubbles/v2/list, etc.

🎨 Light and Dark Styles

Some Bubbles, like help, offer default styles for both light and dark backgrounds. Since Lip Gloss v2 removes AdaptiveColor, choosing light or dark is now a manual process. You've got a couple of options.

🎩 The Best Way

Have Bubble Tea query the background color for you. This properly queries the correct inputs and outputs, and happens in lockstep with your application:

func (m model) Init() tea.Cmd {
    return tea.RequestBackgroundColor
}

func (m model) Update(msg tea.Msg) (tea.Model, tea.Cmd) {
    switch msg := msg.(type) {
    case tea.BackgroundColorMsg:
        m.help.Styles = help.DefaultStyles(msg.IsDark())
        return m, nil
    }
    // ...
}

If you're using Wish you must do it this way to get the background color of the client.

🤠 The Quick Way

Use the compat package in Lip Gloss. It's less recommended because it contains blocking I/O that operates independently of Bubble Tea, and when used with Wish it won't detect the client's background:

import "charm.land/lipgloss/v2/compat"

var hasDarkBG = compat.HasDarkBackground()

h := help.New()
h.Styles = help.DefaultStyles(hasDarkBG)

👀 Or Just Pick One

h.Styles = help.DefaultLightStyles() // light mode!
h.Styles = help.DefaultDarkStyles()  // jk dark mode

This pattern applies to help, list, textarea, and textinput.

🔑 The Init You Know and Love is Back

After experimenting with a few different forms of Init during the alphas, we decided the v1 signature was the right call after all. Init was a bit too redundant for our tastes given that initialization already happens in New:

func (m Model) Init() tea.Cmd

✨ The Big Highlights

Getters and Setters Everywhere

All components now use getter/setter methods instead of exported Width and Height fields. This lets us do internal bookkeeping when things change, and it makes the API consistent across every Bubble:

// Before
vp.Width = 40
fmt.Println(vp.Width)

// After
vp.SetWidth(40)
fmt.Println(vp.Width())

Affected: filepicker, help, progress, table, textinput, viewport.

Functional Options

Constructors now use the functional options pattern instead of positional args or separate constructor functions:

vp := viewport.New(viewport.WithWidth(80), viewport.WithHeight(24))
sw := stopwatch.New(stopwatch.WithInterval(500 * time.Millisecond))
t := timer.New(30*time.Second, timer.WithInterval(100*time.Millisecond))

DefaultKeyMap is a Function Now

All DefaultKeyMap package-level variables are now functions, so you get fresh values every time:

km := textinput.DefaultKeyMap()   // was textinput.DefaultKeyMap
km := textarea.DefaultKeyMap()    // was textarea.DefaultKeyMap
km := paginator.DefaultKeyMap()   // was paginator.DefaultKeyMap

Real Cursor Support 🖱️

Both textarea and textinput now support real terminal cursors! The feature is opt-in, so by default your programs will continue to use the easy-breezy virtual cursor. Set VirtualCursor to false and use Model.Cursor() for the real deal. Check out the textarea and textinput examples to see it in action.

Cleaned House 🧹

All previously deprecated symbols have been removed:

• NewModel variants — just use New
• spinner.Tick() — use Model.Tick() instead
• paginator.UsePgUpPgDownKeys and friends — customize KeyMap directly
• filepicker.DefaultStylesWithRenderer() — Lip Gloss is pure now, use DefaultStyles()
• viewport.HighPerformanceRendering — no longer needed
• runeutil and memoization packages moved to internal/ (they were never meant for public use anyway)

What's Changed: the Laundry List

🔮 Cursor

• Model.Blink renamed to Model.IsBlinked for clarity
• Model.BlinkCmd() renamed to Model.Blink()
• Each cursor now gets a unique ID

📂 Filepicker

• DefaultStylesWithRenderer() removed — Lip Gloss is pure now, so just use DefaultStyles()
• Model.Height broken into SetHeight(int) / Height() int

❓ Help

• Model.Width broken into SetWidth(int) / Width() int
• New DefaultStyles(isDark bool), DefaultDarkStyles(), and DefaultLightStyles()
• Defaults to dark background styles out of the box

🥕 List

• DefaultStyles() and NewDefaultItemStyles() now take an isDark bool parameter
• Styles.FilterPrompt and Styles.FilterCursor have been consolidated into Styles.Filter (a textinput.Styles)
• GlobalIndex helper added

📄 Paginator

• DefaultKeyMap variable → DefaultKeyMap() function
• Deprecated fields (UsePgUpPgDownKeys, UseLeftRightKeys, etc.) removed — customize KeyMap directly

🌈 Progress

This one got the biggest makeover!

• Complete color API overhaul:
  • WithGradient / WithScaledGradient → WithColors(...color.Color) — pass 2+ colors for blending
  • WithSolidFill(string) → WithColors(color) — pass a single color for a solid fill
  • WithDefaultGradient() → WithDefaultBlend()
  • New WithScaled(bool) to scale the blend to fit only the filled portion
  • New WithColorFunc(func(total, current float64) color.Color) for fully dynamic coloring
  • WithColorProfile removed — Bubble Tea handles this automatically now
• Model.FullColor and Model.EmptyColor changed from string to image/color.Color
• Model.Width broken into SetWidth(int) / Width() int
• Model.Update now returns Model instead of tea.Model
• Improved blend algorithm with support for multiple color stops — special thanks to the legendary @​lrstanley!

🌀 Spinner

• Tick() package-level function removed — use Model.Tick() instead

⏱️ Stopwatch

• NewWithInterval(d) removed — use New(WithInterval(d)) instead
• Debounced tick messages

🔢 Table

• Model.Width / Model.Height replaced with getter/setter methods
• Uses ansi.Truncate instead of runewidth.Truncate
• Fixed a critical out-of-bounds cursor bug — thanks @​s0ders!

✏️ Textarea

The big change here is real cursor support — but that's opt-in, so by default your programs will keep using the virtual cursor.

• DefaultKeyMap variable → DefaultKeyMap() function
• New PageUp / PageDown key bindings
• Model.FocusedStyle / Model.BlurredStyle → Model.Styles.Focused / Model.Styles.Blurred
• Style type renamed to StyleState; new Styles struct groups Focused, Blurred, and Cursor
• Model.SetCursor renamed to Model.SetCursorColumn
• Model.Cursor is now func() *tea.Cursor for real cursor support
• Model.VirtualCursor bool added — set to false when using a real cursor
• New DefaultStyles(isDark bool), DefaultDarkStyles(), DefaultLightStyles()
• New methods: Column(), ScrollYOffset(), ScrollPosition(), MoveToBeginning(), MoveToEnd()
• Focus status now passed to SetPromptFunc

📜 Textinput

Most of the changes here bring textinput to parity with textarea, including real cursor support. Styling has been consolidated into a Styles struct with Focused and Blurred states:

• DefaultKeyMap variable → DefaultKeyMap() function
• Model.Width broken into SetWidth(int) / Width() int
• Model.PromptStyle → StyleState.Prompt
• Model.TextStyle → StyleState.Text
• Model.PlaceholderStyle → StyleState.Placeholder
• Model.CompletionStyle → StyleState.Suggestion
• Model.Cursor is now func() *tea.Cursor for real cursor support
• Model.VirtualCursor() / SetVirtualCursor(bool) added
• Model.Styles() / SetStyles(Styles) added
• New DefaultStyles(isDark bool), DefaultDarkStyles(), DefaultLightStyles()
• Exposed matched suggestions and suggestion index

⏲️ Timer

• NewWithInterval(timeout, interval) removed — use New(timeout, WithInterval(interval))
• Debounced tick messages

📦 Viewport

viewport got a ton of love in v2. Let's dive in!

Breaking changes:

• New(width, height int) → New(...Option) with WithWidth / WithHeight
• Model.Width, Model.Height, Model.YOffset replaced with getter/setter methods
• HighPerformanceRendering removed

Shiny new features:

You can now scroll horizontally with the left and right arrow keys, and set up a custom gutter column for things like line numbers:

vp := viewport.New()
vp.SetContent("hello world")

// Show line numbers:
vp.LeftGutterFunc = func(info viewport.GutterContext) string {
    if info.Soft {
        return "     │ "
    }
    if info.Index >= info.TotalLines {
        return "   ~ │ "
    }
    return fmt.Sprintf("%4d │ ", info.Index+1)
}

Highlight parts of what's being viewed with regex:

vp.SetHighlights(regexp.MustCompile("hello").FindAllStringIndex(vp.GetContent(), -1))
vp.HighlightNext()      // highlight and navigate to next match
vp.HighlightPrevious()  // highlight and navigate to previous match
vp.ClearHighlights()    // clear all highlights

Let viewport handle soft wrapping for you:

vp.SoftWrap = true
vp.SetContent("hello world from a very long line")

Or, if you need fine control, use SetContentLines with "virtual lines" containing \n — they're treated as soft wraps automatically.

Also new:

• Horizontal mouse wheel scrolling (thanks @​UnseenBook!)
• GetContent() to retrieve content
• FillHeight to pad the viewport with empty lines
• StyleLineFunc for per-line styling
• HighlightStyle and SelectedHighlightStyle for highlight appearance

💝 That's a wrap!

Feel free to reach out, ask questions, give feedback, and let us know how it's going. We'd love to know what you think.

• Discord
• Matrix
• Email

Part of Charm.

Charm热爱开源 • Charm loves open source • نحنُ نحب المصادر المفتوحة

v2.0.6

Compare Source

This release fixes an issue with how Bubble Tea handled wide characters. Before, a wide character might be skipped or cause an infinite loop causing the CPU to spike. See fdcd0cf and charmbracelet/ultraviolet#109 for more details.

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.5

Compare Source

Changelog

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.4

Compare Source

Changelog

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.3

Compare Source

Extra Extra Extended Keyboard Enhancements!

This release adds support for the full set of Keyboard Enhancements. Now you can enable any enhancements on top of the default disambiguate one.

func (m model) View() tea.View {
  var v tea.View
  v.KeyboardEnhancements.ReportAlternateKeys = true
  v.KeyboardEnhancements.ReportAllKeysAsEscapeCodes = true
  return v
}

Smarter Renderer

We also fixed a few renderer related bugs and made the Cursed Renderer smarter. Now, we always reset the terminal tab stops for the Bubble Tea program process context. People using tabs -N in their shell profiles shouldn't be affected.

See the full changelog below.

Changelog

New!

• 05df5ae: feat: support extended keyboard enhancements (#​1626) (@​aymanbagabas)

Fixed

• a3d7807: fix(ci): only run build-examples on non-dependabot PRs (@​aymanbagabas)
• 7df1e65: fix(examples): migrate imports to charm.land for the glamour example (#​1642) (@​mhdna)
• ee06e98: fix(examples): resolve nil pointer dereference (#​1663) (@​mattpcaswell)
• ac355fe: fix(renderer): restore tab stops if hard tabs are enabled (#​1677) (@​aymanbagabas)
• 729f05c: fix: add missing signal.Stop in suspendProcess to prevent signal channel leak (Closes #​1673) (#​1674) (@​kuishou68)

Docs

• bbe4faf: docs(example): add textarea dynamic height example (#​1639) (@​meowgorithm)
• e19d255: docs: fix README wording (#​1624) (@​Rohan5commit)

Other stuff

• 65c3978: ci: sync golangci-lint config (#​1556) (@​github-actions[bot])

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.2

Compare Source

This release contains a small patch fixing a rendering that might affect Wish users running on Unix platforms.

Changelog

Fixed

• f25595a: fix(renderer): use mapNl optimization when not on Windows and no PTY input (#​1615) (@​aymanbagabas)

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.1

Compare Source

A small patch release to fix opening the proper default stdin file for input.

Changelog

Fixed

• 110a919: fix(examples): add missing WithWidth to table example (#​1598) (@​shv-ng)
• 66b7abd: fix: check if os.Stdin is a terminal before opening the TTY (@​aymanbagabas)

Docs

• c751374: docs: correct whats new link (@​aymanbagabas)
• 736fba2: docs: upgrade guide: correct badge url (@​aymanbagabas)

Thoughts? Questions? We love hearing from you. Feel free to reach out on X, Discord, Slack, The Fediverse, Bluesky.

v2.0.0

Compare Source

What's New in Bubble Tea v2

We're very excited to announce the second major release of Bubble Tea!

If you (or your LLM) are just looking for technical details on on migrating from v1, please check out the Upgrade Guide.

[!NOTE]
We don't take API changes lightly and strive to make the upgrade process as simple as possible. We believe the changes bring necessary improvements as well as pave the way for the future. If something feels way off, let us know.

❤️ Charm Land Import Path

We've updated our import paths to use vanity domains and use our domain to import Go packages.

// Before
import tea "github.com/charmbracelet/bubbletea"

// After
import tea "charm.land/bubbletea/v2"

Everything else stays the same 🙂

👾 The Cursed Renderer

Bubble Tea v2 ships with the all-new Cursed Renderer which was built from the ground up. It's based on the ncurses rendering algorithm and is highly optimized for speed, efficiency, and accuracy and is built on an enormous amount of research and development.

Optimized renders also means that Wish users get big performance benefits and lower bandwidth usage by orders of magnitude.

To take advantage of the new Cursed Renderer you don't need to do anything at all except keep on using the Bubble Tea you know and love.

✌️ Key handling is way better now

Newer terminals can now take advantage of all sorts keyboard input via progressive keyboard enhancements. You can now map all sorts of keys and modifiers like shift+enter and super+space. You can also detect key releases (we're looking at you, game developers).

It's easy to detect support for supporting terminals and add fallbacks for those that don't. For details, see keyboard enhancements below.

🥊 No more fighting

In the past, Bubble Tea and Lip Gloss would often fight over i/o. Bubble Tea wanted to read keyboard input and Lip Gloss wanted to query for the background color. This means that things could get messy. Not anymore! In v2, Lip Gloss is now pure, which means, Bubble Tea manages i/o and gives orders to Lip Gloss. In short, we only need one lib to call the shots, and in the context of this relationship, that lib is Bubble Tea.

But what about color downsampling? That's a great question.

👨🏻‍🎨 Built-in Color Downsampling

We sneakily released a little library called colorprofile that will detect the terminal's color profile and auto-downsample any ANSI styling that flows through it to the best available color profile. This means that color will "just work" (and not misbehave) no matter where the ANSI styling comes from.

Downsampling is built-into Bubble Tea and is automatically enabled.

🧘 Declarative, Not Imperative

This is a big one. In v1, you'd toggle terminal features on and off with commands like tea.EnterAltScreen, tea.EnableMouseCellMotion, tea.EnableReportFocus, and so on. In v2, all of that is gone and replaced by fields on the View struct. You just declare what you want your view to look like and Bubble Tea takes care of the rest.

This means no more fighting over startup options and commands. Just set the fields and forget about it. For example, to enter full screen mode:

func (m Model) View() tea.View {
    v := tea.NewView("Hello, full screen!")
    v.AltScreen = true
    return v
}

The same goes for mouse mode, bracketed paste, focus reporting, window title, keyboard enhancements, and more. See A Declarative View below for the full picture.

Keyboard Enhancements

Progressive keyboard enhancements allow you to receive key events not normally possible in traditional terminals. For example, you can now listen for the ctrl+m key, as well as previously unavailable key combinations like shift+enter.

Bubble Tea v2 will always try to enable ba

✂ Note

PR body was truncated to here.