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

Update Rust crate ratatui to 0.25.0 - autoclosed #4384

Closed
wants to merge 1 commit into from

Conversation

oxide-renovate[bot]
Copy link
Contributor

@oxide-renovate oxide-renovate bot commented Oct 28, 2023

This PR contains the following updates:

Package Type Update Change
ratatui workspace.dependencies minor 0.23.0 -> 0.25.0

Release Notes

ratatui-org/ratatui (ratatui)

v0.25.0

Compare Source

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

In this version, we made improvements on widgets such as List, Table and Layout and changed some of the defaults for a better user experience.
Also, we renewed our website and updated our documentation/tutorials to get started with ratatui: https://ratatui.rs 🚀

Release highlights: https://ratatui.rs/highlights/v025/

⚠️ List of breaking changes can be found here.

💖 We also enabled GitHub Sponsors for our organization, consider sponsoring us if you like ratatui: https://github.com/sponsors/ratatui-org

Features
  • aef4956
    (list) List::new now accepts IntoIterator<Item = Into<ListItem>> (#​672) [breaking]

    This allows to build list like
    
    ```
    List::new(["Item 1", "Item 2"])
    ```
    
  • 8bfd666
    (paragraph) Add line_count and line_width unstable helper methods

    This is an unstable feature that may be removed in the future
    
  • 1229b96
    (rect) Add offset method (#​533)

    The offset method creates a new Rect that is moved by the amount
    specified in the x and y direction. These values can be positive or
    negative. This is useful for manual layout tasks.
    
    ```rust
    let rect = area.offset(Offset { x: 10, y -10 });
    ```
    
  • edacaf7
    (buffer) Deprecate Cell::symbol field (#​624)

    The Cell::symbol field is now accessible via a getter method (`symbol()`). This will
    allow us to make future changes to the Cell internals such as replacing `String` with
    `compact_str`.
    
  • 6b2efd0
    (layout) Accept IntoIterator for constraints (#​663)

    Layout and Table now accept IntoIterator for constraints with an Item
    that is AsRef<Constraint>. This allows pretty much any collection of
    constraints to be passed to the layout functions including arrays,
    vectors, slices, and iterators (without having to call collect() on
    them).
    
  • 753e246
    (layout) Allow configuring layout fill (#​633)

    The layout split will generally fill the remaining area when `split()`
    is called. This change allows the caller to configure how any extra
    space is allocated to the `Rect`s. This is useful for cases where the
    caller wants to have a fixed size for one of the `Rect`s, and have the
    other `Rect`s fill the remaining space.
    
    For now, the method and enum are marked as unstable because the exact
    name is still being bikeshedded. To enable this functionality, add the
    `unstable-segment-size` feature flag in your `Cargo.toml`.
    
    To configure the layout to fill the remaining space evenly, use
    `Layout::segment_size(SegmentSize::EvenDistribution)`. The default
    behavior is `SegmentSize::LastTakesRemainder`, which gives the last
    segment the remaining space. `SegmentSize::None` will disable this
    behavior. See the docs for `Layout::segment_size()` and
    `layout::SegmentSize` for more information.
    
    Fixes https://github.com/ratatui-org/ratatui/issues/536
    
  • 1e2f0be
    (layout) Add parameters to Layout::new() (#​557) [breaking]

    Adds a convenience function to create a layout with a direction and a
    list of constraints which are the most common parameters that would be
    generally configured using the builder pattern. The constraints can be
    passed in as any iterator of constraints.
    
    ```rust
    let layout = Layout::new(Direction::Horizontal, [
        Constraint::Percentage(50),
        Constraint::Percentage(50),
    ]);
    ```
    
  • c862aa5
    (list) Support line alignment (#​599)

    The `List` widget now respects the alignment of `Line`s and renders them as expected.
    
  • 4424637
    (span) Add setters for content and style (#​647)

  • ebf1f42
    (style) Implement From trait for crossterm to Style related structs (#​686)

  • e49385b
    (table) Add a Table::segment_size method (#​660)

    It controls how to distribute extra space to an underconstrained table.
    The default, legacy behavior is to leave the extra space unused.  The
    new options are LastTakesRemainder which gets all space to the rightmost
    column that can used it, and EvenDistribution which divides it amongst
    all columns.
    
  • b8f71c0
    (widgets/chart) Add option to set the position of legend (#​378)

  • 5bf4f52
    (uncategorized) Implement From trait for termion to Style related structs (#​692)

    * feat(termion): implement from termion color
    
    * feat(termion): implement from termion style
    
    * feat(termion): implement from termion `Bg` and `Fg`
    
  • d19b266
    (uncategorized) Add Constraint helpers (e.g. from_lengths) (#​641)

    Adds helper methods that convert from iterators of u16 values to the
    specific Constraint type. This makes it easy to create constraints like:
    
    ```rust
    // a fixed layout
    let constraints = Constraint::from_lengths([10, 20, 10]);
    
    // a centered layout
    let constraints = Constraint::from_ratios([(1, 4), (1, 2), (1, 4)]);
    let constraints = Constraint::from_percentages([25, 50, 25]);
    
    // a centered layout with a minimum size
    let constraints = Constraint::from_mins([0, 100, 0]);
    
    // a sidebar / main layout with maximum sizes
    let constraints = Constraint::from_maxes([30, 200]);
    ```
    
Bug Fixes
  • f69d57c
    (rect) Fix underflow in the Rect::intersection method (#​678)

  • 56fc410
    (block) Make inner aware of title positions (#​657)

    Previously, when computing the inner rendering area of a block, all
    titles were assumed to be positioned at the top, which caused the
    height of the inner area to be miscalculated.
    
  • ec7b387
    (doc) Do not access deprecated Cell::symbol field in doc example (#​626)

  • 37c70db
    (table) Add widths parameter to new() (#​664) [breaking]

    This prevents creating a table that doesn't actually render anything.
    
  • 1f88da7
    (table) Fix new clippy lint which triggers on table widths tests (#​630)

    * fix(table): new clippy lint in 1.74.0 triggers on table widths tests
    
  • 36d8c53
    (table) Widths() now accepts AsRef<[Constraint]> (#​628)

    This allows passing an array, slice or Vec of constraints, which is more
    ergonomic than requiring this to always be a slice.
    
    The following calls now all succeed:
    
    ```rust
    Table::new(rows).widths([Constraint::Length(5), Constraint::Length(5)]);
    Table::new(rows).widths(&[Constraint::Length(5), Constraint::Length(5)]);
    
    // widths could also be computed at runtime
    let widths = vec![Constraint::Length(5), Constraint::Length(5)];
    Table::new(rows).widths(widths.clone());
    Table::new(rows).widths(&widths);
    ```
    
  • 34d099c
    (tabs) Fixup tests broken by semantic merge conflict (#​665)

    Two changes without any line overlap caused the tabs tests to break
    
  • e4579f0
    (tabs) Set the default highlight_style (#​635) [breaking]

    Previously the default highlight_style was set to `Style::default()`,
    which meant that the highlight style was the same as the normal style.
    This change sets the default highlight_style to reversed text.
    
  • 28ac55b
    (tabs) Tab widget now supports custom padding (#​629)

    The Tab widget now contains padding_left and and padding_right
    properties. Those values can be set with functions `padding_left()`,
    `padding_right()`, and `padding()` which all accept `Into<Line>`.
    
    Fixes issue https://github.com/ratatui-org/ratatui/issues/502
    
  • df0eb1f
    (terminal) Insert_before() now accepts lines > terminal height and doesn't add an extra blank line (#​596)

    Fixes issue with inserting content with height>viewport_area.height and adds
    the ability to insert content of height>terminal_height
    
    - Adds TestBackend::append_lines() and TestBackend::clear_region() methods to
      support testing the changes
    
  • aaeba27
    (uncategorized) Truncate table when overflow (#​685)

    This prevents a panic when rendering an empty right aligned and rightmost table cell
    
  • ffa78aa
    (uncategorized) Add #[must_use] to Style-moving methods (#​600)

  • a2f2bd5
    (uncategorized) MSRV is now 1.70.0 (#​593)

Refactor
  • f767ea7
    (list) start_corner is now direction (#​673)

    The previous name `start_corner` did not communicate clearly the intent of the method.
    A new method `direction` and a new enum `ListDirection` were added.
    
    `start_corner` is now deprecated
    
  • b82451f
    (examples) Add vim binding (#​688)

  • 0576a8a
    (layout) To natural reading order (#​681)

    Structs and enums at the top of the file helps show the interaction
    between the types without having to find each type in between longer
    impl sections.
    
    Also moved the try_split function into the Layout impl as an associated
    function and inlined the `layout::split()` which just called try_split.
    This makes the code a bit more contained.
    
  • 4be18ab
    (readme) Reference awesome-ratatui instead of wiki (#​689)

    * refactor(readme): link awesome-ratatui instead of wiki
    
    The apps wiki moved to awesome-ratatui
    
    * docs(readme): Update README.md
    
  • 7ef0afc
    (widgets) Remove unnecessary dynamic dispatch and heap allocation (#​597)

  • b282a06
    (uncategorized) Remove items deprecated since 0.10 (#​691) [breaking]

    Remove `Axis::title_style` and `Buffer::set_background` which are deprecated since 0.10
    
  • 7ced7c0
    (uncategorized) Define struct WrappedLine instead of anonymous tuple (#​608)

    It makes the type easier to document, and more obvious for users
    
Documentation
  • fe632d7
    (sparkline) Add documentation (#​648)

  • f4c8de0
    (chart) Document chart module (#​696)

  • 1b8b626
    (examples) Add animation and FPS counter to colors_rgb (#​583)

  • 2169a0d
    (examples) Add example of half block rendering (#​687)

    This is a fun example of how to render big text using half blocks
    
  • 41c44a4
    (frame) Add docs about resize events (#​697)

  • 91c67eb
    (github) Update code owners (#​666)

    onboard @&#8203;Valentin271 as maintainer
    
  • 458fa90
    (lib) Tweak the crate documentation (#​659)

  • 3ec4e24
    (list) Add documentation to the List widget (#​669)

    Adds documentation to the List widget and all its sub components like `ListState` and `ListItem`
    
  • 9f37100
    (readme) Update README.md and fix the bug that demo2 cannot run (#​595)

    Fixes https://github.com/ratatui-org/ratatui/issues/594
    
  • 2a87251
    (security) Add security policy (#​676)

    * docs: Create SECURITY.md
    
    * Update SECURITY.md
    
  • 987f7ee
    (website) Rename book to website (#​661)

  • a15c3b2
    (uncategorized) Remove deprecated table constructor from breaking changes (#​698)

  • 113b4b7
    (uncategorized) Rename template links to remove ratatui from name 📚 (#​690)

  • 211160c
    (uncategorized) Remove simple-tui-rs (#​651)

    This has not been recently and doesn't lead to good code
    
Styling
Miscellaneous Tasks
  • 910ad00
    (rustfmt) Enable format_code_in_doc_comments (#​695)

    This enables more consistently formatted code in doc comments,
    especially since ratatui heavily uses fluent setters.
    
    See https://rust-lang.github.io/rustfmt/?version=v1.6.0#format_code_in_doc_comments
    
  • d118565
    (table) Cleanup docs and builder methods (#​638)

    - Refactor the `table` module for better top to bottom readability by
    putting types first and arranging them in a logical order (Table, Row,
    Cell, other).
    
    - Adds new methods for:
      - `Table::rows`
      - `Row::cells`
      - `Cell::new`
      - `Cell::content`
      - `TableState::new`
      - `TableState::selected_mut`
    
    - Makes `HighlightSpacing::should_add` pub(crate) since it's an internal
      detail.
    
    - Adds tests for all the new methods and simple property tests for all
      the other setter methods.
    
  • dd22e72
    (uncategorized) Correct "builder methods" in docs and add must_use on widgets setters (#​655)

  • 18e19f6
    (uncategorized) Fix breaking changes doc versions (#​639)

    Moves the layout::new change to unreleasedd section and adds the table change
    
  • a58cce2
    (uncategorized) Disable default benchmarking (#​598)

    Disables the default benchmarking behaviour for the lib target to fix unrecognized
    criterion benchmark arguments.
    
    See https://bheisler.github.io/criterion.rs/book/faq.html#cargo-bench-gives-unrecognized-option-errors-for-valid-command-line-options for details
    
Continuous Integration
  • 59b9c32
    (codecov) Adjust threshold and noise settings (#​615)

    Fixes https://github.com/ratatui-org/ratatui/issues/612
    
  • 03401cd
    (uncategorized) Fix untrusted input in pr check workflow (#​680)

Contributors

Thank you so much to everyone that contributed to this release!

Here is the list of contributors who have contributed to ratatui for the first time!

v0.24.0

Compare Source

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

In this version, we've introduced features like window size API, enhanced chart rendering, and more.
The list of *breaking changes* can be found here ⚠️.
Also, we created various tutorials and walkthroughs in Ratatui Book which is available at https://ratatui.rs 🚀

Release highlights: https://ratatui.rs/highlights/v024

Features
  • c6c3f88
    (backend) Implement common traits for WindowSize (#​586)

  • d077903
    (backend) Backend provides window_size, add Size struct (#​276)

    For image (sixel, iTerm2, Kitty...) support that handles graphics in
    terms of `Rect` so that the image area can be included in layouts.
    
    For example: an image is loaded with a known pixel-size, and drawn, but
    the image protocol has no mechanism of knowing the actual cell/character
    area that been drawn on. It is then impossible to skip overdrawing the
    area.
    
    Returning the window size in pixel-width / pixel-height, together with
    columns / rows, it can be possible to account the pixel size of each cell
    / character, and then known the `Rect` of a given image, and also resize
    the image so that it fits exactly in a `Rect`.
    
    Crossterm and termwiz also both return both sizes from one syscall,
    while termion does two.
    
    Add a `Size` struct for the cases where a `Rect`'s `x`/`y` is unused
    (always zero).
    
    `Size` is not "clipped" for `area < u16::max_value()` like `Rect`. This
    is why there are `From` implementations between the two.
    
  • 301366c
    (barchart) Render charts smaller than 3 lines (#​532)

    The bar values are not shown if the value width is equal the bar width
    and the bar is height is less than one line
    
    Add an internal structure `LabelInfo` which stores the reserved height
    for the labels (0, 1 or 2) and also whether the labels will be shown.
    
    Fixes ratatui-org#513
    
  • 32e4619
    (block) Allow custom symbols for borders (#​529) [breaking]

    Adds a new `Block::border_set` method that allows the user to specify
    the symbols used for the border.
    
    Added two new border types: `BorderType::QuadrantOutside` and
    `BorderType::QuadrantInside`. These are used to draw borders using the
    unicode quadrant characters (which look like half block "pixels").
    
    ```
    ▛▀▀▜
    ▌  ▐
    ▙▄▄▟
    
    ▗▄▄▖
    ▐  ▌
    ▝▀▀▘
    ```
    Fixes: https://github.com/ratatui-org/ratatui/issues/528
    
    BREAKING CHANGES:
    - BorderType::to_line_set is renamed to to_border_set
    - BorderType::line_symbols is renamed to border_symbols
    
  • 4541336
    (canvas) Implement half block marker (#​550)

    * feat(canvas): implement half block marker
    
    A useful technique for the terminal is to use half blocks to draw a grid
    of "pixels" on the screen. Because we can set two colors per cell, and
    because terminal cells are about twice as tall as they are wide, we can
    draw a grid of half blocks that looks like a grid of square pixels.
    
    This commit adds a new `HalfBlock` marker that can be used in the Canvas
    widget and the associated HalfBlockGrid.
    
    Also updated demo2 to use the new marker as it looks much nicer.
    
    Adds docs for many of the methods and structs on canvas.
    
    Changes the grid resolution method to return the pixel count
    rather than the index of the last pixel.
    This is an internal detail with no user impact.
    
  • be55a5f
    (examples) Add demo2 example (#​500)

  • 082cbcb
    (frame) Remove generic Backend parameter (#​530) [breaking]

    This change simplifies UI code that uses the Frame type. E.g.:
    
    ```rust
    fn draw<B: Backend>(frame: &mut Frame<B>) {
        // ...
    }
    ```
    
    Frame was generic over Backend because it stored a reference to the
    terminal in the field. Instead it now directly stores the viewport area
    and current buffer. These are provided at creation time and are valid
    for the duration of the frame.
    
    BREAKING CHANGE: Frame is no longer generic over Backend. Code that
    accepted a Frame<Backend> will now need to accept a Frame.
    
  • d67fa2c
    (line) Add Line::raw constructor (#​511)

    * feat(line): add `Line::raw` constructor
    
    There is already `Span::raw` and `Text::raw` methods
    and this commit simply adds `Line::raw` method for symmetry.
    
    Multi-line content is converted to multiple spans with the new line removed
    
  • cbf86da
    (rect) Add is_empty() to simplify some common checks (#​534)

    - add `Rect::is_empty()` that checks whether either height or width == 0
    - refactored `Rect` into layout/rect.rs from layout.rs. No public API change as
       the module is private and the type is re-exported under the `layout` module.
    
  • 15641c8
    (uncategorized) Add buffer_mut method on Frame ✨ (#​548)

Bug Fixes
  • 638d596
    (layout) Use LruCache for layout cache (#​487)

    The layout cache now uses a LruCache with default size set to 16 entries.
    Previously the cache was backed by a HashMap, and was able to grow
    without bounds as a new entry was added for every new combination of
    layout parameters.
    
    - Added a new method (`layout::init_cache(usize)`) that allows the cache
    size to be changed if necessary. This will only have an effect if it is called
    prior to any calls to `layout::split()` as the cache is wrapped in a `OnceLock`
    
  • 8d507c4
    (backend) Add feature flag for underline-color (#​570)

    Windows 7 doesn't support the underline color attribute, so we need to
    make it optional. This commit adds a feature flag for the underline
    color attribute - it is enabled by default, but can be disabled by
    passing `--no-default-features` to cargo.
    
    We could specically check for Windows 7 and disable the feature flag
    automatically, but I think it's better for this check to be done by the
    crossterm crate, since it's the one that actually knows about the
    underlying terminal.
    
    To disable the feature flag in an application that supports Windows 7,
    add the following to your Cargo.toml:
    
    ```toml
    ratatui = { version = "0.24.0", default-features = false, features = ["crossterm"] }
    ```
    
    Fixes https://github.com/ratatui-org/ratatui/issues/555
    
  • c3155a2
    (barchart) Add horizontal labels(#​518)

    Labels were missed in the initial implementation of the horizontal
    mode for the BarChart widget. This adds them.
    
    Fixes https://github.com/ratatui-org/ratatui/issues/499
    
  • c5ea656
    (barchart) Avoid divide by zero in rendering (#​525)

  • c9b8e7c
    (barchart) Render value labels with unicode correctly (#​515)

    An earlier change introduced a bug where the width of value labels with
    unicode characters was incorrectly using the string length in bytes
    instead of the unicode character count. This reverts the earlier change.
    
  • c8ab2d5
    (chart) Use graph style for top line (#​462)

    A bug in the rendering caused the top line of the chart to be rendered
    using the style of the chart, instead of the dataset style. This is
    fixed by only setting the style for the width of the text, and not the
    entire row.
    
  • 0c7d547
    (docs) Don't fail rustdoc due to termion (#​503)

    Windows cannot compile termion, so it is not included in the docs.
    Rustdoc will fail if it cannot find a link, so the docs fail to build
    on windows.
    
    This replaces the link to TermionBackend with one that does not fail
    during checks.
    
    Fixes https://github.com/ratatui-org/ratatui/issues/498
    
  • 0c52ff4
    (gauge) Fix gauge widget colors (#​572)

    The background colors of the gauge had a workaround for the issue we had
    with VHS / TTYD rendering the background color of the gauge. This
    workaround is no longer necessary in the updated versions of VHS / TTYD.
    
    Fixes https://github.com/ratatui-org/ratatui/issues/501
    
  • 11076d0
    (rect) Fix arithmetic overflow edge cases (#​543)

    Fixes https://github.com/ratatui-org/ratatui/issues/258
    
  • 21303f2
    (rect) Prevent overflow in inner() and area() (#​523)

  • ebd3680
    (stylize) Add Stylize impl for String (#​466) [breaking]

    Although the `Stylize` trait is already implemented for `&str` which
    extends to `String`, it is not implemented for `String` itself. This
    commit adds an impl of Stylize that returns a Span<'static> for `String`
    so that code can call Stylize methods on temporary `String`s.
    
    E.g. the following now compiles instead of failing with a compile error
    about referencing a temporary value:
    
        let s = format!("hello {name}!", "world").red();
    
    BREAKING CHANGE: This may break some code that expects to call Stylize
    methods on `String` values and then use the String value later. This
    will now fail to compile because the String is consumed by set_style
    instead of a slice being created and consumed.
    
    This can be fixed by cloning the `String`. E.g.:
    
        let s = String::from("hello world");
        let line = Line::from(vec![s.red(), s.green()]); // fails to compile
        let line = Line::from(vec![s.clone().red(), s.green()]); // works
    
    Fixes https://discord.com/channels/1070692720437383208/1072907135664529508/1148229700821450833
    
Refactor
  • 2fd85af
    (barchart) Simplify internal implementation (#​544)

    Replace `remove_invisible_groups_and_bars` with `group_ticks`
    `group_ticks` calculates the visible bar length in ticks. (A cell contains 8 ticks).
    
    It is used for 2 purposes:
    1. to get the bar length in ticks for rendering
    2. since it delivers only the values of the visible bars, If we zip these values
       with the groups and bars, then we will filter out the invisible groups and bars
    
Documentation
  • 0c68ebe
    (block) Add documentation to Block (#​469)

  • 0fe7385
    (gauge) Add docs for Gauge and LineGauge (#​514)

  • 27c5637
    (readme) Fix links to CONTRIBUTING.md and BREAKING-CHANGES.md (#​577)

  • 1947c58
    (backend) Improve backend module docs (#​489)

  • e098731
    (barchart) Add documentation to BarChart (#​449)

    Add documentation to the `BarChart` widgets and its sub-modules.
    
  • 17797d8
    (canvas) Add support note for Braille marker (#​472)

  • 3cf0b83
    (color) Document true color support (#​477)

    * refactor(style): move Color to separate color mod
    
    * docs(color): document true color support
    
  • e5caf17
    (custom_widget) Make button sticky when clicking with mouse (#​561)

  • ad2dc56
    (examples) Update examples readme (#​576)

    remove VHS bug info, tweak colors_rgb image, update some of the instructions. add demo2
    
  • b61f65b
    (examples) Update theme to Aardvark Blue (#​574)

    This is a nicer theme that makes the colors pop
    
  • 61af0d9
    (examples) Make custom widget example into a button (#​539)

    The widget also now supports mouse
    
  • 6b8725f
    (examples) Add colors_rgb example (#​476)

  • 5c785b2
    (examples) Move example gifs to github (#​460)

    - A new orphan branch named "images" is created to store the example
      images
    
  • ca9bcd3
    (examples) Add descriptions and update theme (#​460)

    - Use the OceanicMaterial consistently in examples
    
  • 080a05b
    (paragraph) Add docs for alignment fn (#​467)

  • 1e20475
    (stylize) Improve docs for style shorthands (#​491)

    The Stylize trait was introduced in 0.22 to make styling less verbose.
    This adds a bunch of documentation comments to the style module and
    types to make this easier to discover.
    
  • dd9a8df
    (table) Add documentation for block and header methods of the Table widget (#​505)

  • 232be80
    (table) Add documentation for Table::new() (#​471)

  • 3bda372
    (tabs) Add documentation to Tabs (#​535)

  • 42f8169
    (terminal) Add docs for terminal module (#​486)

    - moves the impl Terminal block up to be closer to the type definition
    
  • 28e7fd4
    (terminal) Fix doc comment (#​452)

  • 51fdcbe
    (title) Add documentation to title (#​443)

    This adds documentation for Title and Position
    
  • d4976d4
    (widgets) Update the list of available widgets (#​496)

  • 6c7bef8
    (uncategorized) Replace colons with dashes in README.md for consistency (#​566)

  • 88ae348
    (uncategorized) Update Frame docstring to remove reference to generic backend (#​564)

  • 089f8ba
    (uncategorized) Add double quotes to instructions for features (#​560)

  • 346e7b4
    (uncategorized) Add summary to breaking changes (#​549)

  • 401a7a7
    (uncategorized) Improve clarity in documentation for Frame and Terminal 📚 (#​545)

  • e35e413
    (uncategorized) Fix terminal comment (#​547)

  • 8ae4403
    (uncategorized) Fix Terminal docstring (#​546)

  • 9cfb133
    (uncategorized) Document alpha release process (#​542)

    Fixes https://github.com/ratatui-org/ratatui/issues/412
    
  • 4548a9b
    (uncategorized) Add BREAKING-CHANGES.md (#​538)

    Document the breaking changes in each version. This document is
    manually curated by summarizing the breaking changes in the changelog.
    
  • c0991cc
    (uncategorized) Make library and README consistent (#​526)

    * docs: make library and README consistent
    
    Generate the bulk of the README from the library documentation, so that
    they are consistent using cargo-rdme.
    
    - Removed the Contributors section, as it is redundant with the github
      contributors list.
    - Removed the info about the other backends and replaced it with a
      pointer to the documentation.
    - add docsrs example, vhs tape and images that will end up in the README
    
  • 1414fbc
    (uncategorized) Import prelude::* in doc examples (#​490)

    This commit adds `prelude::*` all doc examples and widget::* to those
    that need it. This is done to highlight the use of the prelude and
    simplify the examples.
    
    - Examples in Type and module level comments show all imports and use
      `prelude::*` and `widget::*` where possible.
    - Function level comments hide imports unless there are imports other
      than `prelude::*` and `widget::*`.
    
  • 74c5244
    (uncategorized) Add logo and favicon to docs.rs page (#​473)

  • 927a5d8
    (uncategorized) Fix documentation lint warnings (#​450)

  • eda2fb7
    (uncategorized) Use ratatui 📚 (#​446)

Testing
  • ea70bff
    (barchart) Add benchmarks (#​455)

  • 94af2a2
    (buffer) Allow with_lines to accept Vec<Into> (#​494)

    This allows writing unit tests without having to call set_style on the
    expected buffer.
    
Miscellaneous Tasks
  • 1278131
    (changelog) Make the scopes lowercase in the changelog (#​479)

  • 82b40be
    (ci) Improve checking the PR title (#​464)

    - Use [`action-semantic-pull-request`](https://togithub.com/amannn/action-semantic-pull-request)
    - Allow only reading the PR contents
    - Enable merge group
    
  • a20bd6a
    (deps) Update lru requirement from 0.11.1 to 0.12.0 (#​581)

    Updates the requirements on [lru](https://togithub.com/jeromefroe/lru-rs) to permit the latest version.
    - [Changelog](https://togithub.com/jeromefroe/lru-rs/blob/master/CHANGELOG.md)
    - [Commits](https://togithub.com/jeromefroe/lru-rs/compare/0.11.1...0.12.0)
    
    ---
    updated-dependencies:
    - dependency-name: lru
      dependency-type: direct:production
    ...
    
  • 5213f78
    (deps) Bump actions/checkout from 3 to 4 (#​580)

    Bumps [actions/checkout](https://togithub.com/actions/checkout) from 3 to 4.
    - [Release notes](https://togithub.com/actions/checkout/releases)
    - [Changelog](https://togithub.com/actions/checkout/blob/main/CHANGELOG.md)
    - [Commits](https://togithub.com/actions/checkout/compare/v3...v4)
    
    ---
    updated-dependencies:
    - dependency-name: actions/checkout
      dependency-type: direct:production
      update-type: version-update:semver-major
    ...
    
  • 6cbdb06
    (examples) Refactor some examples (#​578)

    * chore(examples): Simplify timeout calculation with `Duration::saturating_sub`
    
  • 12f9291
    (github) Create dependabot.yml (#​575)

    * chore: Create dependabot.yml
    
    * Update .github/dependabot.yml
    
  • 3a57e76
    (github) Add contact links for issues (#​567)

  • 5498a88
    (spans) Remove deprecated Spans type (#​426)

    The `Spans` type (plural, not singular) was replaced with a more ergonomic `Line` type
    in Ratatui v0.21.0 and marked deprecated byt left for backwards compatibility. This is now
    removed.
    
    - `Line` replaces `Spans`
    - `Buffer::set_line` replaces `Buffer::set_spans`
    
  • fbf1a45
    (uncategorized) Simplify constraints (#​556)

    Use bare arrays rather than array refs / Vecs for all constraint
    examples.
    
  • a7bf4b3
    (uncategorized) Use modern modules syntax (#​492)

    Move xxx/mod.rs to xxx.rs
    
  • af36282
    (uncategorized) Only run check pr action on pull_request_target events (#​485)

  • 322e46f
    (uncategorized) Prevent PR merge with do not merge labels ♻️ (#​484)

  • 983ea7f
    (uncategorized) Fix check for if breaking change label should be added ♻️ (#​483)

  • 384e616
    (uncategorized) Add a check for if breaking change label should be added ♻️ (#​481)

  • 5f6aa30
    (uncategorized) Check documentation lint (#​454)

  • 47ae602
    (uncategorized) Check that PR title matches conventional commit guidelines ♻️ (#​459)

  • 28c6157
    (uncategorized) Add documentation guidelines (#​447)

Continuous Integration
  • 343c6cd
    (lint) Move formatting and doc checks first (#​465)

    Putting the formatting and doc checks first to ensure that more critical
    errors are caught first (e.g. a conventional commit error or typo should
    not prevent the formatting and doc checks from running).
    
  • c95a75c
    (makefile) Remove termion dependency from doc lint (#​470)

    Only build termion on non-windows targets
    
  • b996102
    (makefile) Add format target (#​468)

    - add format target to Makefile.toml that actually fixes the formatting
    - rename fmt target to lint-format
    - rename style-check target to lint-style
    - rename typos target to lint-typos
    - rename check-docs target to lint-docs
    - add section to CONTRIBUTING.md about formatting
    
  • 572df75
    (uncategorized) Put commit id first in changelog (#​463)

  • 878b6fc
    (uncategorized) Ignore benches from code coverage (#​461)

Contributors

Thank you so much to everyone that contributed to this release!

Here is the list of contributors who have contributed to ratatui for the first time!


Configuration

📅 Schedule: Branch creation - "after 8pm,before 6am" in timezone America/Los_Angeles, Automerge - "after 8pm,before 6am" in timezone America/Los_Angeles.

🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.

Rebasing: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox.

🔕 Ignore: Close this PR and you won't be reminded about this update again.


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

This PR has been generated by Renovate Bot.

@oxide-renovate oxide-renovate bot added the dependencies Pull requests that update a dependency file label Oct 28, 2023
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 2 times, most recently from 5f626d4 to 2f056dd Compare November 2, 2023 03:08
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 4 times, most recently from 4e7bd68 to bb494a3 Compare November 14, 2023 04:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch from bb494a3 to 8971854 Compare November 15, 2023 04:07
@oxide-renovate oxide-renovate bot changed the title chore(deps): update rust crate ratatui to 0.24.0 Update Rust crate ratatui to 0.24.0 Nov 17, 2023
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 3 times, most recently from 190312e to 3114d44 Compare November 21, 2023 09:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 2 times, most recently from cf058cc to 44f9e39 Compare November 29, 2023 08:37
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch from 44f9e39 to f5c37ed Compare December 7, 2023 04:07
@oxide-renovate
Copy link
Contributor Author

oxide-renovate bot commented Dec 7, 2023

⚠ Artifact update problem

Renovate failed to update an artifact related to this branch. You probably do not want to merge this PR as-is.

♻ Renovate will retry this branch, including artifacts, only when one of the following happens:

  • any of the package files in this branch needs updating, or
  • the branch becomes conflicted, or
  • you click the rebase/retry checkbox if found above, or
  • you rename this PR's title to start with "rebase!" to trigger it manually

The artifact failure details are included below:

File name: Cargo.lock
Command failed: cargo update --config net.git-fetch-with-cli=true --manifest-path Cargo.toml --package [email protected] --precise 0.25.0
    Updating crates.io index
error: failed to select a version for the requirement `ratatui = "^0.23"`
candidate versions found which didn't match: 0.25.0
location searched: crates.io index
required by package `tui-tree-widget v0.13.0`
    ... which satisfies dependency `tui-tree-widget = "^0.13.0"` (locked to 0.13.0) of package `wicket v0.1.0 (/tmp/renovate/repos/github/oxidecomputer/omicron/wicket)`
    ... which satisfies path dependency `wicket` (locked to 0.1.0) of package `wicket-dbg v0.1.0 (/tmp/renovate/repos/github/oxidecomputer/omicron/wicket-dbg)`
perhaps a crate was updated and forgotten to be re-vendored?

@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 7 times, most recently from a2d7274 to 44a6714 Compare December 13, 2023 04:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 2 times, most recently from 086ae7d to b784b83 Compare December 18, 2023 12:27
@oxide-renovate oxide-renovate bot changed the title Update Rust crate ratatui to 0.24.0 Update Rust crate ratatui to 0.25.0 Dec 18, 2023
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 3 times, most recently from c048a3c to a42b15c Compare December 22, 2023 04:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch from a42b15c to da0e665 Compare December 31, 2023 04:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 7 times, most recently from 6a42308 to a178298 Compare January 11, 2024 04:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch 6 times, most recently from af2c623 to fea12eb Compare January 19, 2024 04:08
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch from fea12eb to 906e478 Compare January 20, 2024 04:07
@oxide-renovate oxide-renovate bot force-pushed the renovate/ratatui-0.x branch from 906e478 to 6bb034f Compare January 24, 2024 04:07
@oxide-renovate oxide-renovate bot changed the title Update Rust crate ratatui to 0.25.0 Update Rust crate ratatui to 0.25.0 - autoclosed Jan 24, 2024
@oxide-renovate oxide-renovate bot closed this Jan 24, 2024
@oxide-renovate oxide-renovate bot deleted the renovate/ratatui-0.x branch January 24, 2024 16:37
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
Projects
None yet
Development

Successfully merging this pull request may close these issues.

0 participants