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.

Sign up for GitHub

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

Jump to bottom

fix(deps): update tui #180

Merged
merged 1 commit into from
Sep 2, 2024
Merged

fix(deps): update tui #180

merged 1 commit into from
Sep 2, 2024

Conversation

renovate[bot]
Copy link
Contributor

@renovate renovate bot commented Jun 24, 2024 •
edited
Loading

This PR contains the following updates:

Package Type Update Change
ratatui (source) dependencies minor 0.26.2 -> 0.28.0
tui-logger dependencies minor 0.11.1 -> 0.12.0

Release Notes

ratatui/ratatui (ratatui)

v0.28.1

Compare Source

Features

  • ed51c4b (terminal) Add ratatui::init() and restore() methods by @​joshka in #​1289

    These are simple opinionated methods for creating a terminal that is
    useful to use in most apps. The new init method creates a crossterm
    backend writing to stdout, enables raw mode, enters the alternate
    screen, and sets a panic handler that restores the terminal on panic.

    A minimal hello world now looks a bit like:

    use ratatui::{
    crossterm::event::{self, Event},
    text::Text,
    Frame,
};

fn main() {
    let mut terminal = ratatui::init();
    loop {
        terminal
            .draw(|frame: &mut Frame| frame.render_widget(Text::raw("Hello World!"), frame.area()))
            .expect("Failed to draw");
        if matches!(event::read().expect("failed to read event"), Event::Key(_)) {
            break;
        }
    }
    ratatui::restore();
}

    A type alias DefaultTerminal is added to represent this terminal
    type and to simplify any cases where applications need to pass this
    terminal around. It is equivalent to:
    Terminal<CrosstermBackend<Stdout>>

    We also added ratatui::try_init() and try_restore(), for situations
    where you might want to handle initialization errors yourself instead
    of letting the panic handler fire and cleanup. Simple Apps should
    prefer the init and restore functions over these functions.

    Corresponding functions to allow passing a TerminalOptions with
    a Viewport (e.g. inline, fixed) are also available
    (init_with_options,
    and try_init_with_options).

    The existing code to create a backend and terminal will remain and
    is not deprecated by this approach. This just provides a simple one
    line initialization using the common options.

Bug Fixes

  • aed60b9 (terminal) Terminal::insert_before would crash when called while the viewport filled the screen by @​nfachan in #​1329

    Reimplement Terminal::insert_before. The previous implementation would
    insert the new lines in chunks into the area between the top of the
    screen and the top of the (new) viewport. If the viewport filled the
    screen, there would be no area in which to insert lines, and the
    function would crash.

    The new implementation uses as much of the screen as it needs to, all
    the way up to using the whole screen.

    This commit:

    • adds a scrollback buffer to the TestBackend so that tests can
      inspect and assert the state of the scrollback buffer in addition to the
      screen
    • adds functions to TestBackend to assert the state of the scrollback
    • adds and updates TestBackend tests to test the behavior of the
      scrollback and the new asserting functions
    • reimplements Terminal::insert_before, including adding two new
      helper functions Terminal::draw_lines and Terminal::scroll_up.
    • updates the documentation for Terminal::insert_before to clarify
      some of the edge cases
    • updates terminal tests to assert the state of the scrollback buffer
    • adds a new test for the condition that causes the bug
    • adds a conversion constructor Cell::from(char)

    Fixes:https://github.com/ratatui/ratatui/issues/999

  • fdd5d8c (text) Remove trailing newline from single-line Display trait impl by @​LucasPickering in #​1320

  • 2fb0b8a (uncategorized) Fix u16 overflow in Terminal::insert_before. by @​nfachan in #​1323

    If the amount of characters in the screen above the viewport was greater
    than u16::MAX, a multiplication would overflow. The multiply was used to
    compute the maximum chunk size. The fix is to just do the multiplication
    as a usize and also do the subsequent division as a usize.

    There is currently another outstanding issue that limits the amount of
    characters that can be inserted when calling Terminal::insert_before to
    u16::MAX. However, this bug can still occur even if the viewport and the
    amount of characters being inserted are both less than u16::MAX, since
    it's dependant on how large the screen is above the viewport.

    Fixes #​1322

Documentation
Testing

  • 0d5f3c0 (uncategorized) Avoid unneeded allocations in assertions by @​mo8it in #​1335

    A vector can be compared to an array.

Miscellaneous Tasks

  • 65da535 (ci) Update release strategy by @​orhun in #​1337

    closes #​1232

    Now we can trigger point releases by pushing a tag (follow the
    instructions in RELEASE.md). This will create a release with generated
    changelog.

    There is still a lack of automation (e.g. updating CHANGELOG.md), but
    this PR is a good start towards improving that.

  • 57d8b74 (ci) Use cargo-docs-rs to lint docs by @​joshka in #​1318

  • 8b624f5 (maintainers) Remove EdJoPaTo by @​EdJoPaTo in #​1314

  • 23516bc (uncategorized) Rename ratatui-org to ratatui by @​joshka in #​1334

    All urls updated to point at https://github.com/ratatui

    To update your repository remotes, you can run the following commands:

    git remote set-url origin https://github.com/ratatui/ratatui
Build

  • 0256269 (uncategorized) Simplify Windows build by @​joshka in #​1317

    Termion is not supported on Windows, so we need to avoid building it.

    Adds a conditional dependency to the Cargo.toml file to only include
    termion when the target is not Windows. This allows contributors to
    build using the --all-features flag on Windows rather than needing
    to specify the features individually.

New Contributors

Full Changelog: ratatui/ratatui@v0.28.0...v0.28.1

v0.28.0

Compare Source

"If you are what you eat, then I only want to eat the good stuff." – Remy

We are excited to announce the new version of ratatui - a Rust library that's all about cooking up TUIs 🐭

In this version, we have upgraded to Crossterm 0.28.0, introducing enhanced functionality and performance improvements.
New features include GraphType::Bar, lines in bar charts, and enhanced scroll/navigation methods.
We have also refined the terminal module and added brand new methods for cursor positions and text operations.

✨ Release highlights: https://ratatui.rs/highlights/v028/

⚠️ List of breaking changes can be found here.

Features

  • 8d4a102 (barchart) Allow axes to accept Lines by @​joshka in #​1273 [breaking]

    Fixes:#​1272

  • a23ecd9 (buffer) Add Buffer::cell, cell_mut and index implementations by @​joshka in #​1084

    Code which previously called buf.get(x, y) or buf.get_mut(x, y)
    should now use index operators, or be transitioned to buff.cell() or
    buf.cell_mut() for safe access that avoids panics by returning
    Option<&Cell> and Option<&mut Cell>.

    The new methods accept Into<Position> instead of x and y
    coordinates, which makes them more ergonomic to use.

    let mut buffer = Buffer::empty(Rect::new(0, 0, 10, 10));

let cell = buf[(0, 0)];
let cell = buf[Position::new(0, 0)];

let symbol = buf.cell((0, 0)).map(|cell| cell.symbol());
let symbol = buf.cell(Position::new(0, 0)).map(|cell| cell.symbol());

buf[(0, 0)].set_symbol("🐀");
buf[Position::new(0, 0)].set_symbol("🐀");

buf.cell_mut((0, 0)).map(|cell| cell.set_symbol("🐀"));
buf.cell_mut(Position::new(0, 0)).map(|cell| cell.set_symbol("🐀"));

    The existing get() and get_mut() methods are marked as deprecated.
    These are fairly widely used and we will leave these methods around on
    the buffer for a longer time than our normal deprecation approach (2
    major release)

    Addresses part of: #​1011

  • afe1534 (chart) Accept IntoIterator for axis labels by @​EdJoPaTo in #​1283 [breaking]

    BREAKING CHANGES: #​1273 is already breaking and this only advances the
    already breaking part

  • 5b51018 (chart) Add GraphType::Bar by @​joshka in #​1205

    Demo

  • f97e07c (frame) Replace Frame::size() with Frame::area() by @​EdJoPaTo in #​1293

    Area is the more correct term for the result of this method.
    The Frame::size() method is marked as deprecated and will be
    removed around Ratatui version 0.30 or later.

    Fixes:#​1254 (comment)

  • 5b89bd0 (layout) Add Size::ZERO and Position::ORIGIN constants by @​EdJoPaTo in #​1253

  • b2aa843 (layout) Enable serde for Margin, Position, Rect, Size by @​EdJoPaTo in #​1255

  • 36d49e5 (table) Select first, last, etc to table state by @​robertpsoane in #​1198

    Add select_previous, select_next, select_first & select_last to
    TableState

    Used equivalent API as in ListState

  • 3bb374d (terminal) Add Terminal::try_draw() method by @​joshka in #​1209

    This makes it easier to write fallible rendering methods that can use
    the ? operator

    terminal.try_draw(|frame| {
    some_method_that_can_fail()?;
    another_faillible_method()?;
    Ok(())
})?;

  • 3725262 (text) Add Add and AddAssign implementations for Line, Span, and Text by @​joshka in #​1236

    This enables:

    let line = Span::raw("Red").red() + Span::raw("blue").blue();
let line = Line::raw("Red").red() + Span::raw("blue").blue();
let line = Line::raw("Red").red() + Line::raw("Blue").blue();
let text = Line::raw("Red").red() + Line::raw("Blue").blue();
let text = Text::raw("Red").red() + Line::raw("Blue").blue();

let mut line = Line::raw("Red").red();
line += Span::raw("Blue").blue();

let mut text = Text::raw("Red").red();
text += Line::raw("Blue").blue();

line.extend(vec![Span::raw("1"), Span::raw("2"), Span::raw("3")]);

  • c34fb77 (text) Remove unnecessary lifetime from ToText trait by @​joshka in #​1234 [breaking]

    BREAKING CHANGE:The ToText trait no longer has a lifetime parameter.
    This change simplifies the trait and makes it easier implement.

  • c68ee6c (uncategorized) Add get/set_cursor_position() methods to Terminal and Backend by @​EdJoPaTo in #​1284 [breaking]

    The new methods return/accept Into<Position> which can be either a Position or a (u16, u16) tuple.

    backend.set_cursor_position(Position { x: 0, y: 20 })?;
let position = backend.get_cursor_position()?;
terminal.set_cursor_position((0, 20))?;
let position = terminal.set_cursor_position()?;

  • b70cd03 (uncategorized) Add ListState / TableState scroll_down_by() / scroll_up_by() methods by @​josueBarretogit in #​1267

    Implement new methods scroll_down_by(u16) and scroll_up_by(u16) for
    both Liststate and Tablestate.

    Closes:#​1207

Bug Fixes

  • 864cd9f (testbackend) Prevent area mismatch by @​EdJoPaTo in #​1252

    Removes the height and width fields from TestBackend, which can get
    out of sync with the Buffer, which currently clamps to 255,255.

    This changes the TestBackend serde representation. It should be
    possible to read older data, but data generated after this change
    can't be read by older versions.

  • 7e1bab0 (buffer) Dont render control characters by @​EdJoPaTo in #​1226

  • c08b522 (chart) Allow removing all the axis labels by @​EdJoPaTo in #​1282

    axis.labels(vec![]) removes all the labels correctly.

    This makes calling axis.labels with an empty Vec the equivalent
    of not calling axis.labels. It's likely that this is never used, but it
    prevents weird cases by removing the mix-up of Option::None
    and Vec::is_empty, and simplifies the implementation code.

  • 03f3124 (paragraph) Line_width, and line_count include block borders by @​airblast-dev in #​1235

    The line_width, and line_count methods for Paragraph would not
    take into account the Block if one was set. This will now correctly
    calculate the values including the Block's width/height.

    Fixes:#​1233

  • 3ca920e (span) Prevent panic on rendering out of y bounds by @​EdJoPaTo in #​1257

  • 84cb164 (terminal) Make terminal module private by @​joshka in #​1260 [breaking]

    This is a simplification of the public API that is helpful for new users
    that are not familiar with how rust re-exports work, and helps avoid
    clashes with other modules in the backends that are named terminal.

    BREAKING CHANGE:The terminal module is now private and can not be
    used directly. The types under this module are exported from the root of
    the crate.

    - use ratatui::terminal::{CompletedFrame, Frame, Terminal, TerminalOptions, ViewPort};
+ use ratatui::{CompletedFrame, Frame, Terminal, TerminalOptions, ViewPort};

    Fixes:#​1210

  • 29c8c84 (uncategorized) Ignore newlines in Span's Display impl by @​SUPERCILEX in #​1270

  • cd93547 (uncategorized) Remove unnecessary synchronization in layout cache by @​SUPERCILEX in #​1245

    Layout::init_cache no longer returns bool and takes a NonZeroUsize instead of usize

    The cache is a thread-local, so doesn't make much sense to require
    synchronized initialization.

  • b344f95 (uncategorized) Only apply style to first line when rendering a Line by @​joshka in #​1247

    A Line widget should only apply its style to the first line when
    rendering and not the entire area. This is because the Line widget
    should only render a single line of text. This commit fixes the issue by
    clamping the area to a single line before rendering the text.

  • 7ddfbc0 (uncategorized) Unnecessary allocations when creating Lines by @​SUPERCILEX in #​1237

  • 84f3341 (uncategorized) Clippy lints from rust 1.80.0 by @​joshka in #​1238

Refactor
Documentation

  • 6ce447c (block) Add docs about style inheritance by @​joshka in #​1190

    Fixes:#​1129

  • 55e0880 (block) Update block documentation by @​leohscl in #​1206

    Update block documentation with constructor methods and setter methods
    in the main doc comment Added an example for using it to surround
    widgets

    Fixes:#​914

  • f2fa1ae (breaking-changes) Add missing code block by @​orhun in #​1291

  • f687af7 (breaking-changes) Mention removed lifetime of ToText trait by @​orhun in #​1292

  • d468463 (breaking-changes) Fix the PR link by @​orhun in #​1294

  • 1b9bdd4 (contributing) Fix minor issues by @​EdJoPaTo in #​1300

  • 5f7a7fb (examples) Update barcharts gifs by @​joshka in #​1306

  • fe4eeab (examples) Simplify the barchart example by @​joshka in #​1079

    The barchart example has been split into two examples: barchart and
    barchart-grouped. The barchart example now shows a simple barchart
    with random data, while the barchart-grouped example shows a grouped
    barchart with fake revenue data.

    This simplifies the examples a bit so they don't cover too much at once.

    • Simplify the rendering functions
    • Fix several clippy lints that were marked as allowed

  • 6e7b4e4 (examples) Add async example by @​joshka in #​1248

    This example demonstrates how to use Ratatui with widgets that fetch
    data asynchronously. It uses the octocrab crate to fetch a list of
    pull requests from the GitHub API. You will need an environment
    variable named GITHUB_TOKEN with a valid GitHub personal access
    token. The token does not need any special permissions.

  • 935a718 (examples) Add missing examples to README by @​kibibyt3 in #​1225

    Resolves:#​1014

  • 50e5674 (examples) Fix: fix typos in tape files by @​kibibyt3 in #​1224

  • 810da72 (examples) Fix hyperlink example tape by @​kibibyt3 in #​1222

  • 5eeb1cc (github) Create CODE_OF_CONDUCT.md by @​joshka in #​1279

  • 7c0665c (layout) Fix typo in example by @​EmiOnGit in #​1217

  • 272d059 (paragraph) Update main docs by @​joshka in #​1202

  • bb71e5f (readme) Remove MSRV by @​EdJoPaTo in #​1266

    This notice was useful when the Cargo.toml had no standardized field
    for this. Now it's easier to look it up in the Cargo.toml and it's
    also a single point of truth. Updating the README was overlooked for
    quite some time so it's better to just omit it rather than having
    something wrong that will be forgotten again in the future.

  • 8857037 (terminal) Fix imports by @​EdJoPaTo in #​1263

  • 2fd5ae6 (widgets) Document stability of WidgetRef by @​joshka in #​1288

    Addresses some confusion about when to implement WidgetRef vs impl Widget for &W. Notes the stability rationale and links to an issue that
    helps explain the context of where we're at in working this out.

  • 716c931 (uncategorized) Document crossterm breaking change by @​joshka in #​1281

  • f775030 (uncategorized) Update main lib.rs / README examples by @​joshka in #​1280

  • 8433d09 (uncategorized) Update demo image by @​joshka in #​1276

    Follow up to #​1203

Performance

  • 663486f (list) Avoid extra allocations when rendering List by @​airblast-dev in #​1244

    When rendering a List, each ListItem would be cloned. Removing the
    clone, and replacing Widget::render with WidgetRef::render_ref saves
    us allocations caused by the clone of the Text<'_> stored inside of
    ListItem.

    Based on the results of running the "list" benchmark locally;
    Performance is improved by %1-3 for all render benchmarks for List.

  • 4753b72 (reflow) Eliminate most WordWrapper allocations by @​SUPERCILEX in #​1239

    On large paragraphs (~1MB), this saves hundreds of thousands of
    allocations.

    TL;DR:reuse as much memory as possible across next_line calls.
    Instead of allocating new buffers each time, allocate the buffers once
    and clear them before reuse.

  • be3eb75 (table) Avoid extra allocations when rendering Table by @​airblast-dev in #​1242

    When rendering a Table the Text stored inside of a Cell gets
    cloned before rendering. This removes the clone and uses WidgetRef
    instead, saving us from allocating a Vec<Line<'_>> inside Text. Also
    avoids an allocation when rendering the highlight symbol if it contains
    an owned value.

  • f04bf85 (uncategorized) Add buffer benchmarks by @​joshka in #​1303

  • e6d2e04 (uncategorized) Move benchmarks into a single benchmark harness by @​joshka in #​1302

    Consolidates the benchmarks into a single executable rather than having
    to create a new cargo.toml setting per and makes it easier to rearrange
    these when adding new benchmarks.

Styling

  • a80a8a6 (format) Lint markdown by @​joshka in #​1131

    • chore: Fix line endings for changelog
    • chore: cleanup markdown lints
    • ci: add Markdown linter
    • build: add markdown lint to the makefile
Testing
Miscellaneous Tasks
Build
Continuous Integration

  • 476ac87 (uncategorized) Split up lint job by @​EdJoPaTo in #​1264

    This helps with identifying what failed right from the title. Also steps
    after a failing one are now always executed.

    Also shortens the steps a bit by removing obvious names.

New Contributors

Full Changelog: ratatui/ratatui@v0.27.0...0.28.0

v0.27.0

Compare Source

In this version, we have focused on enhancing usability and functionality with new features like
background styles for LineGauge, palette colors, and various other improvements including
improved performance. Also, we added brand new examples for tracing and creating hyperlinks!

✨ Release highlights: https://ratatui.rs/highlights/v027/

⚠️ List of breaking changes can be found here.

Features

  • eef1afe (linegauge) Allow LineGauge background styles by @​nowNick in #​565

    This PR deprecates `gauge_style` in favor of `filled_style` and
`unfilled_style` which can have its foreground and background styled.

`cargo run --example=line_gauge --features=crossterm`
    line_gauge_demo.mov

    Implements:#​424

  • 1365620 (borders) Add FULL and EMPTY border sets by @​joshka in #​1182

    border::FULL uses a full block symbol, while border::EMPTY uses an
    empty space. This is useful for when you need to allocate space for the
    border and apply the border style to a block without actually drawing a
    border. This makes it possible to style the entire title area or a block
    rather than just the title content.

use ratatui::{symbols::border, widgets::Block};
let block = Block::bordered().title("Title").border_set(border::FULL);
let block = Block::bordered().title("Title").border_set(border::EMPTY);
cargo run --example tracing
RUST_LOG=trace cargo run --example=tracing
cat tracing.log

Made with VHS

  • 1520ed9 (layout) Impl Display for Position and Size by @​joshka in #​1162

  • 46977d8 (list) Add list navigation methods (first, last, previous, next) by @​joshka in #​1159 [breaking]

    Also cleans up the list example significantly (see also
<https://github.com/ratatui/ratatui/issues/1157>)

    Fixes:#​1159

    BREAKING CHANGE:The List widget now clamps the selected index to the
    bounds of the list when navigating with first, last, previous, and
    next, as well as when setting the index directly with select.

  • 10d7788 (style) Add conversions from the palette crate colors by @​joshka in #​1172

    This is behind the "palette" feature flag.

```rust
use palette::{LinSrgb, Srgb};
use ratatui::style::Color;

let color = Color::from(Srgb::new(1.0f32, 0.0, 0.0));
let color = Color::from(LinSrgb::new(1.0f32, 0.0, 0.0));
```

  • 7ef2dae (text) support conversion from Display to Span, Line and Text by @​orhun in #​1167

    Now you can create `Line` and `Text` from numbers like so:

```rust
let line = 42.to_line();
let text = 666.to_text();
```

  • 74a32af (uncategorized) Re-export backends from the ratatui crate by @​joshka in #​1151

    `crossterm`, `termion`, and `termwiz` can now be accessed as
`ratatui::{crossterm, termion, termwiz}` respectively. This makes it
possible to just add the Ratatui crate as a dependency and use the
backend of choice without having to add the backend crates as
dependencies.

To update existing code, replace all instances of `crossterm::` with
`ratatui::crossterm::`, `termion::` with `ratatui::termion::`, and
`termwiz::` with `ratatui::termwiz::`.

  • 3594180 (uncategorized) Make Stylize's .bg(color) generic by @​kdheepak in #​1103 [breaking]

  • 0b5fd6b (uncategorized) Add writer() and writer_mut() to termion and crossterm backends by @​enricozb in #​991

    It is sometimes useful to obtain access to the writer if we want to see
what has been written so far. For example, when using &mut [u8] as a
writer.
Bug Fixes
Refactor
- list.start_corner(Corner::TopLeft);
- list.start_corner(Corner::TopRight);
// This is not an error, BottomRight rendered top to bottom previously
- list.start_corner(Corner::BottomRight);
// all becomes
+ list.direction(ListDirection::TopToBottom);
- list.start_corner(Corner::BottomLeft);
// becomes
+ list.direction(ListDirection::BottomToTop);

layout::Corner is removed entirely.

  • 4f77910 (padding) Add Padding::ZERO as a constant by @​EdJoPaTo in #​1133

    Deprecate Padding::zero()

  • 8061813 (uncategorized) Expand glob imports by @​joshka in #​1152

    Consensus is that explicit imports make it easier to understand the
example code. This commit removes the prelude import from all examples
and replaces it with the necessary imports, and expands other glob
imports (widget::*, Constraint::*, KeyCode::*, etc.) everywhere else.
Prelude glob imports not in examples are not covered by this PR.

See https://github.com/ratatui/ratatui/issues/1150 for more details.

  • d929971 (uncategorized) Dont manually impl Default for defaults by @​EdJoPaTo in #​1142

    Replace `impl Default` by `#[derive(Default)]` when its implementation
equals.

  • 8a60a56 (uncategorized) Needless_pass_by_ref_mut by @​EdJoPaTo in #​1137

    https://rust-lang.github.io/rust-clippy/master/index.html#needless_pass_by_ref_mut

  • 1de9a82 (uncategorized) Simplify if let by @​EdJoPaTo in #​1135

    While looking through lints
[`clippy::option_if_let_else`](https://rust-lang.github.io/rust-clippy/master/index.html#option_if_let_else)
found these. Other findings are more complex so I skipped them.
Documentation

Configuration

📅 Schedule: Branch creation - At any time (no schedule defined), 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 if that's undesired.

  • If you want to rebase/retry this PR, check this box

This PR was generated by Mend Renovate. View the repository job log.

@renovate renovate bot changed the title fix(deps): update rust crate ratatui to 0.27.0 fix(deps): update tui Jul 17, 2024
@rtkay123 rtkay123 merged commit 79c60ec into master Sep 2, 2024
13 checks passed
@rtkay123 rtkay123 deleted the renovate/tui branch September 2, 2024 15:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@rtkay123