Skip to content

Commit 29ff8e8

Browse files
committed
[core, tui] Fix doc links errors, update Cargo.lock, update CHANGELOG.md
`yaml-rust` crate is unmaintained 1) `syntect` author won't update this dep to a fork of it due to lack of trust concerns with this new fork: trishume/syntect#526 2) cargo-deny produces this output: error[unmaintained]: yaml-rust is unmaintained. ┌─ /home/nazmul/github/r3bl-open-core/Cargo.lock:295:1 │ 295 │ yaml-rust 0.4.5 registry+https://github.com/rust-lang/crates.io-index │ --------------------------------------------------------------------- unmaintained advisory detected │ = ID: RUSTSEC-2024-0320 = Advisory: https://rustsec.org/advisories/RUSTSEC-2024-0320 = The maintainer seems [unreachable](chyh1990/yaml-rust#197). Many issues and pull requests have been submitted over the years without any [response](chyh1990/yaml-rust#160). ## Alternatives Consider switching to the actively maintained `yaml-rust2` fork of the original project: - [yaml-rust2](https://github.com/Ethiraric/yaml-rust2) - [yaml-rust2 @ crates.io](https://crates.io/crates/yaml-rust2)) = Announcement: rustsec/advisory-db#1921 = Solution: No safe upgrade is available! = yaml-rust v0.4.5 └── syntect v5.1.0 └── r3bl_tui v0.5.2 └── r3bl-cmdr v0.0.11
1 parent fccf70e commit 29ff8e8

File tree

10 files changed

+83
-31
lines changed

10 files changed

+83
-31
lines changed

CHANGELOG.md

+62-1
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,14 @@
44
<!-- TOC -->
55

66
- [r3bl-cmdr](#r3bl-cmdr)
7+
- [Next Release](#next-release)
78
- [v0.0.11 2024-01-14](#v0011-2024-01-14)
89
- [v0.0.10 2024-01-02](#v0010-2024-01-02)
910
- [v0.0.9 2023-12-31](#v009-2023-12-31)
1011
- [v0.0.8 2023-12-22](#v008-2023-12-22)
1112
- [r3bl_tuify](#r3bl_tuify)
13+
- [v0.1.26 2024-04-15](#v0126-2024-04-15)
14+
- [v0.1.25 2024-01-14](#v0125-2024-01-14)
1215
- [v0.1.24 2023-12-31](#v0124-2023-12-31)
1316
- [v0.1.23 2023-12-22](#v0123-2023-12-22)
1417
- [v0.1.22 2023-12-20](#v0122-2023-12-20)
@@ -18,6 +21,8 @@
1821
- [v0.1.18 2023-10-17](#v0118-2023-10-17)
1922
- [v0.1.17 2023-10-14](#v0117-2023-10-14)
2023
- [r3bl_tui](#r3bl_tui)
24+
- [v0.5.3 2024-04-15](#v053-2024-04-15)
25+
- [v0.5.2 2024-01-14](#v052-2024-01-14)
2126
- [v0.5.1 2024-01-09](#v051-2024-01-09)
2227
- [v0.5.0 2023-12-31](#v050-2023-12-31)
2328
- [v0.4.0 2023-12-22](#v040-2023-12-22)
@@ -30,6 +35,7 @@
3035
- [v0.3.2 2023-03-06](#v032-2023-03-06)
3136
- [v0.3.1 2023-03-06](#v031-2023-03-06)
3237
- [r3bl_rs_utils_core](#r3bl_rs_utils_core)
38+
- [v0.9.13 2024-04-15](#v0913-2024-04-15)
3339
- [v0.9.12 2024-01-07](#v0912-2024-01-07)
3440
- [v0.9.11 2024-01-02](#v0911-2024-01-02)
3541
- [v0.9.10 2023-12-22](#v0910-2023-12-22)
@@ -46,6 +52,8 @@
4652
- [v0.9.7 2023-10-21](#v097-2023-10-21)
4753
- [v0.9.6 2023-10-17](#v096-2023-10-17)
4854
- [v0.9.5 2023-10-14](#v095-2023-10-14)
55+
- [r3bl_terminal_async](#r3bl_terminal_async)
56+
- [v0.3.0 2024-04-15](#v030-2024-04-15)
4957
- [r3bl_ansi_color](#r3bl_ansi_color)
5058
- [v0.6.9 2023-10-21](#v069-2023-10-21)
5159
- [v0.6.8 2023-10-16](#v068-2023-10-16)
@@ -74,6 +82,17 @@
7482
## `r3bl-cmdr`
7583
<a id="markdown-r3bl-cmdr" name="r3bl-cmdr"></a>
7684

85+
### Next Release
86+
<a id="markdown-next-release" name="next-release"></a>
87+
88+
- Changed:
89+
- Use the latest deps:
90+
- `r3bl_tui` version `0.5.3`.
91+
- `r3bl_rs_utils_core` version `0.9.13`.
92+
- Fixed:
93+
- TBD: markdown parser issues
94+
- TBD: editor issues
95+
7796
### v0.0.11 (2024-01-14)
7897
<a id="markdown-v0.0.11-2024-01-14" name="v0.0.11-2024-01-14"></a>
7998

@@ -134,7 +153,18 @@
134153
## `r3bl_tuify`
135154
<a id="markdown-r3bl_tuify" name="r3bl_tuify"></a>
136155

156+
### v0.1.26 (2024-04-15)
157+
<a id="markdown-v0.1.26-2024-04-15" name="v0.1.26-2024-04-15"></a>
158+
159+
- Updated:
160+
- Make `clip_string_to_width_with_ellipsis` pub so that other crates can use it (eg:
161+
`r3bl_terminal_async`).
162+
- Change the names of enums to be more readable.
163+
- `IsTTYResult::IsTTY` -> `TTYResult::IsInteractive`.
164+
- `IsTTYResult::IsNotTTY` -> `TTYResult::IsNotInteractive`.
165+
137166
### v0.1.25 (2024-01-14)
167+
<a id="markdown-v0.1.25-2024-01-14" name="v0.1.25-2024-01-14"></a>
138168

139169
- Updated:
140170
- Dependency updated `reedline` version `0.28.0`, `r3bl_rs_utils_core` version `0.9.12`.
@@ -228,7 +258,15 @@
228258
## `r3bl_tui`
229259
<a id="markdown-r3bl_tui" name="r3bl_tui"></a>
230260

261+
### v0.5.3 (2024-04-15)
262+
<a id="markdown-v0.5.3-2024-04-15" name="v0.5.3-2024-04-15"></a>
263+
264+
- Updated:
265+
- Dependency changes inherited from `r3bl_rs_utils_core` version `0.9.13`.
266+
- Lots of clippy fixes.
267+
231268
### v0.5.2 (2024-01-14)
269+
<a id="markdown-v0.5.2-2024-01-14" name="v0.5.2-2024-01-14"></a>
232270

233271
- Updated:
234272
- Dependency updated `reedline` version `0.28.0`, `r3bl_rs_utils_core` version `0.9.12`.
@@ -449,10 +487,18 @@
449487
## `r3bl_rs_utils_core`
450488
<a id="markdown-r3bl_rs_utils_core" name="r3bl_rs_utils_core"></a>
451489

490+
### v0.9.13 (2024-04-15)
491+
<a id="markdown-v0.9.13-2024-04-15" name="v0.9.13-2024-04-15"></a>
492+
493+
- Changed:
494+
- Removed `syntect` dep.
495+
- Rename `Style` to `TuiStyle`.
496+
- Lots of cargo clippy fixes.
497+
452498
### v0.9.12 (2024-01-07)
453499
<a id="markdown-v0.9.12-2024-01-07" name="v0.9.12-2024-01-07"></a>
454500

455-
Added:
501+
- Added:
456502
- Add `generate_friendly_random_id()` to generate human readable and friendly IDs.
457503

458504
### v0.9.11 (2024-01-02)
@@ -565,6 +611,21 @@ Added:
565611
- Dependency on `simplelog` is replaced w/ `r3bl_simple_logger` (which is in the
566612
`r3bl_rs_utils` repo workspace as `simple_logger`).
567613

614+
## `r3bl_terminal_async`
615+
<a id="markdown-r3bl_terminal_async" name="r3bl_terminal_async"></a>
616+
617+
### v0.3.0 (2024-04-15)
618+
<a id="markdown-v0.3.0-2024-04-15" name="v0.3.0-2024-04-15"></a>
619+
620+
This is the first release of this crate.
621+
622+
- Added:
623+
- A new crate in this repo that allows for async terminal input and output. This is
624+
useful for building TUIs that are async and can handle input and output in parallel.
625+
To build apps that are not full TUI, this is a great option to create interactive CLIs
626+
and REPLs that are fully async and multithreaded (with input and output) with a really
627+
powerful (multi) line editor and prompt.
628+
568629
## `r3bl_ansi_color`
569630
<a id="markdown-r3bl_ansi_color" name="r3bl_ansi_color"></a>
570631

Cargo.lock

+8-17
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

tui/src/lib.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -429,7 +429,7 @@
429429
//! 2. [App] - This is where you write your code. You pass in a [App] to the [TerminalWindow] to
430430
//! bootstrap your TUI app. You can just use [App] to build your app, if it is a simple one & you
431431
//! don't really need any sophisticated layout or styling. But if you want layout and styling,
432-
//! now we have to deal with [FlexBox], [Component], and [r3bl_rs_utils_core::Style].
432+
//! now we have to deal with [FlexBox], [Component], and [r3bl_rs_utils_core::TuiStyle].
433433
//!
434434
//! # Layout and styling
435435
//! <a id="markdown-layout-and-styling" name="layout-and-styling"></a>

tui/src/tui/color_wheel/tui_styled_text.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ use crate::*;
2323
#[derive(Debug, Clone, Default)]
2424
pub struct TuiStyledText(pub TuiStyle, pub UnicodeString);
2525

26-
/// Use [styled_texts!] macro for easier construction.
26+
/// Use [tui_styled_texts!] macro for easier construction.
2727
pub type TuiStyledTexts = List<TuiStyledText>;
2828

2929
mod tui_styled_text_impl {

tui/src/tui/lolcat/lolcat_impl.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ impl Debug for Lolcat {
5757
impl Lolcat {
5858
/// This function does not respect [r3bl_ansi_color::global_color_support::detect()]
5959
/// (it will always colorize to truecolor regardless of terminal limitations). Use
60-
/// [ColorWheel] if you want to respect
60+
/// [crate::ColorWheel] if you want to respect
6161
/// [r3bl_ansi_color::global_color_support::detect].
6262
pub fn colorize_to_styled_texts(&mut self, input: &UnicodeString) -> TuiStyledTexts {
6363
let mut acc = TuiStyledTexts::default();

tui/src/tui/syntax_highlighting/intermediate_types.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
//! strings).
2929
//! 2. This intermediate type is [clipped](StyleUSSpanLine::clip) to the visible area of the editor
3030
//! component (based on scroll state in viewport). And finally that is converted to a
31-
//! [crate::StyledTexts].
31+
//! [crate::TuiStyledTexts].
3232
3333
use r3bl_rs_utils_core::*;
3434

@@ -134,7 +134,7 @@ impl StyleUSSpanLine {
134134
}
135135

136136
/// Clip the text (in one line) in this range: [ `start_col` .. `end_col` ]. Each line is
137-
/// represented as a [List] of ([Style], [US])`s.
137+
/// represented as a [List] of ([TuiStyle], [US])`s.
138138
pub fn clip(
139139
&self,
140140
scroll_offset_col_index: ChUnit,

tui/src/tui/syntax_highlighting/md_parser_syn_hi/mod.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919
//! 1. [crate::md_parser] - Responsible for parsing markdown into a [crate::MdDocument] data
2020
//! structure.
2121
//! 2. [crate::syntax_highlighting] - Responsible for converting a [crate::MdDocument] into a list
22-
//! of tuples of [r3bl_rs_utils_core::Style] and [String].
22+
//! of tuples of [r3bl_rs_utils_core::TuiStyle] and [String].
2323
//! 3. [crate::editor] - Responsible for displaying the [crate::MdDocument] to the user.
2424
2525
// Attach.

tui/src/tui/syntax_highlighting/syntect_to_styled_text_conversion.rs

+1-1
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@
2626
//!
2727
//! This requires the conversion code to perform the following steps:
2828
//! 1. Convert the syntect [SyntectStyleStrSpanLine] into a [StyleUSSpanLine].
29-
//! 2. Then convert [StyleUSSpanLine] into a [StyledTexts].
29+
//! 2. Then convert [StyleUSSpanLine] into a [TuiStyledTexts].
3030
3131
use syntect::parsing::SyntaxSet;
3232

tui/src/tui/terminal_lib_backends/crossterm_backend/offscreen_buffer_paint_impl.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -69,9 +69,9 @@ impl OffscreenBufferPaint for OffscreenBufferPaintImplCrossterm {
6969
/// Process each [PixelChar] in [OffscreenBuffer] and generate a [RenderOp] for it. Return a
7070
/// [RenderOps] containing all the [RenderOp]s.
7171
///
72-
/// > Note that each [PixelChar] gets the full [Style] embedded in it (not just a part of it
72+
/// > Note that each [PixelChar] gets the full [TuiStyle] embedded in it (not just a part of it
7373
/// > that is different than the previous char). This means that it is possible to quickly
74-
/// > "diff" between 2 of them, since the [Style] is part of the [PixelChar]. This is important
74+
/// > "diff" between 2 of them, since the [TuiStyle] is part of the [PixelChar]. This is important
7575
/// > for selective re-rendering of the [OffscreenBuffer].
7676
///
7777
/// Here's the algorithm used in this function using pseudo-code:

tui/src/tui/terminal_lib_backends/render_op.rs

+4-4
Original file line numberDiff line numberDiff line change
@@ -251,20 +251,20 @@ pub enum RenderOp {
251251

252252
ClearScreen,
253253

254-
/// Directly set the fg color for crossterm w/out using [Style].
254+
/// Directly set the fg color for crossterm w/out using [TuiStyle].
255255
SetFgColor(TuiColor),
256256

257-
/// Directly set the bg color for crossterm w/out using [Style].
257+
/// Directly set the bg color for crossterm w/out using [TuiStyle].
258258
SetBgColor(TuiColor),
259259

260260
ResetColor,
261261

262-
/// Translate [Style] into fg and bg colors for crossterm. Note that this does not
262+
/// Translate [TuiStyle] into fg and bg colors for crossterm. Note that this does not
263263
/// apply attributes (bold, italic, underline, strikethrough, etc). If you need to
264264
/// apply attributes, use [RenderOp::PaintTextWithAttributes] instead.
265265
ApplyColors(Option<TuiStyle>),
266266

267-
/// Translate [Style] into *only* attributes for crossterm (bold, italic, underline,
267+
/// Translate [TuiStyle] into *only* attributes for crossterm (bold, italic, underline,
268268
/// strikethrough, etc) and not colors. If you need to apply color, use
269269
/// [RenderOp::ApplyColors] instead.
270270
///

0 commit comments

Comments
 (0)