chore(examples): simplify all examples #1189
Draft
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
Adds:
- `CrosstermBackend::stdout` and `CrosstermBackend::stderr` for creating
backends with `std::io::stdout` and `std::io::stderr` respectively.
- `CrosstermBackend::into_terminal` for converting a backend into a
terminal.
- `CrosstermBackend::into_terminal_with_options` for converting a
backend into a terminal with options.
- `CrosstermBackend::into_terminal_with_defaults` for converting a
backend into a terminal with default settings (raw mode and alternate
screen).
- `CrosstermBackend::with_raw_mode` for enabling raw mode.
- `CrosstermBackend::with_alternate_screen` for switching to the
alternate screen.
- `CrosstermBackend::with_mouse_support` for enabling mouse support.
- `CrosstermBackend::reset` for resetting the terminal to its default
state.
- `Drop` implementation for restoring raw mode, mouse capture, and
alternate screen on drop.
Most applications can now just use the `into_terminal_with_defaults`
method to set up the terminal with raw mode and the alternate screen,
and now longer need to worry about restoring the terminal to its default
state when the application exits. The reset method can be used to
restore the terminal to its default state if needed (e.g. in a panic
handler).
```rust
use ratatui::backend::CrosstermBackend;
let terminal = CrosstermBackend::stdout()
.into_terminal_with_defaults()?;
```
Adds:
- `CrosstermBackend::stdout` and `CrosstermBackend::stderr` for creating
backends with `std::io::stdout` and `std::io::stderr` respectively.
- `CrosstermBackend::into_terminal` for converting a backend into a
terminal.
- `CrosstermBackend::into_terminal_with_options` for converting a
backend into a terminal with options.
- `CrosstermBackend::into_terminal_with_defaults` for converting a
backend into a terminal with default settings (raw mode and alternate
screen).
- `CrosstermBackend::with_raw_mode` for enabling raw mode.
- `CrosstermBackend::with_alternate_screen` for switching to the
alternate screen.
- `CrosstermBackend::with_mouse_support` for enabling mouse support.
- `CrosstermBackend::reset` for resetting the terminal to its default
state.
- `Drop` implementation for restoring raw mode, mouse capture, and
alternate screen on drop.
Most applications can now just use the `into_terminal_with_defaults`
method to set up the terminal with raw mode and the alternate screen,
and now longer need to worry about restoring the terminal to its default
state when the application exits. The reset method can be used to
restore the terminal to its default state if needed (e.g. in a panic
handler).
```rust
use ratatui::backend::CrosstermBackend;
let terminal = CrosstermBackend::stdout()
.into_terminal_with_defaults()?;
```
Apps can now enable color-eyre hooks using the with_color_eyre_hooks method on CrosstermBackend. This is also added to the default features in the Cargo.toml file, and the defaults that are applied to terminals created using CrosstermBackend::into_terminal_with_defaults.
|
Note - panic example is not yet complete, and this probably needs a once over to check that I've not accidentally introduced bugs. This is still a WIP, but the key takeaway is that this drops about 900 lines of code from 41 example files. |
Codecov ReportAttention: Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## main #1189 +/- ##
=======================================
- Coverage 94.3% 93.7% -0.6%
=======================================
Files 60 62 +2
Lines 14679 15036 +357
=======================================
+ Hits 13843 14095 +252
- Misses 836 941 +105 ☔ View full report in Codecov by Sentry. |
joshka
added
the
Status: Blocked
|
Blocked on #1181 |
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.
In #1180 and
#1181, we introduced some
simpler ways to create a backend and terminal, and to setup color_eyre
to handle errors. This PR updates the examples to use these new methods,
and removes a bunch of unnecessary boilerplate code.