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

Bump ratatui from 0.28.0 to 0.28.1 #9

Merged
merged 2 commits into from
Sep 2, 2024
Merged

Conversation

dependabot[bot]
Copy link
Contributor

@dependabot dependabot bot commented on behalf of github Aug 26, 2024

Bumps ratatui from 0.28.0 to 0.28.1.

Release notes

Sourced from ratatui's releases.

v0.28.1

v0.28.1 - 2024-08-25

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).

... (truncated)

Changelog

Sourced from ratatui's changelog.

v0.28.1 - 2024-08-25

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

... (truncated)

Commits
  • 3a90e2a chore(release): prepare for 0.28.1 (#1343)
  • 65da535 chore(ci): update release strategy (#1337)
  • 9ed85fd docs(table): fix incorrect backticks in TableState docs (#1342)
  • aed60b9 fix(terminal): Terminal::insert_before would crash when called while the view...
  • 3631b34 docs(examples): add widget implementation example (#1147)
  • 0d5f3c0 test: Avoid unneeded allocations in assertions (#1335)
  • ed51c4b feat(terminal): Add ratatui::init() and restore() methods (#1289)
  • 23516bc chore: rename ratatui-org to ratatui (#1334)
  • 6d1bd99 docs: minor grammar fixes (#1330)
  • 2fb0b8a fix: fix u16 overflow in Terminal::insert_before. (#1323)
  • Additional commits viewable in compare view

Dependabot compatibility score

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot show <dependency name> ignore conditions will show all of the ignore conditions of the specified dependency
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)

Bumps [ratatui](https://github.com/ratatui/ratatui) from 0.28.0 to 0.28.1.
- [Release notes](https://github.com/ratatui/ratatui/releases)
- [Changelog](https://github.com/ratatui/ratatui/blob/main/CHANGELOG.md)
- [Commits](ratatui/ratatui@v0.28.0...v0.28.1)

---
updated-dependencies:
- dependency-name: ratatui
  dependency-type: direct:production
  update-type: version-update:semver-patch
...

Signed-off-by: dependabot[bot] <support@github.com>
@dependabot dependabot bot added dependencies Pull requests that update a dependency file rust Pull requests that update Rust code labels Aug 26, 2024
@codecov-commenter
Copy link

codecov-commenter commented Aug 26, 2024

Codecov Report

Attention: Patch coverage is 0% with 3 lines in your changes missing coverage. Please review.

Project coverage is 0.00%. Comparing base (acfc451) to head (ac0a6cf).
Report is 1 commits behind head on main.

Files with missing lines Patch % Lines
src/app.rs 0.00% 3 Missing ⚠️
Additional details and impacted files
@@          Coverage Diff          @@
##            main      #9   +/-   ##
=====================================
  Coverage   0.00%   0.00%           
=====================================
  Files          4       3    -1     
  Lines        129      96   -33     
=====================================
+ Misses       129      96   -33     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Use ratatui::init instead of custom code
Removed unnecessary error handling which is now handled by ratatui

BREAKING CHANGE: App::draw accepts a Frame instead of Terminal
@joshka joshka merged commit ad7f99a into main Sep 2, 2024
11 checks passed
@joshka joshka deleted the dependabot/cargo/ratatui-0.28.1 branch September 2, 2024 18:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file rust Pull requests that update Rust code
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants