From 5020e8134f8108dd4dbc012989c0328b2c3a2565 Mon Sep 17 00:00:00 2001 From: nyx Date: Fri, 4 Oct 2024 05:42:58 -0400 Subject: [PATCH 1/8] implement dynamic auto updating word wrapping functionality --- Cargo.lock | 24 ++++++ core/tabs/applications-setup/tab_data.toml | 20 ++--- core/tabs/gaming/tab_data.toml | 2 +- core/tabs/security/tab_data.toml | 2 +- core/tabs/system-setup/tab_data.toml | 6 +- tui/Cargo.toml | 1 + tui/src/floating_text.rs | 90 ++++++++++++++-------- 7 files changed, 96 insertions(+), 49 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 81750251..cc80e267 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -511,6 +511,7 @@ dependencies = [ "rand", "ratatui", "temp-dir", + "textwrap", "tree-sitter-bash", "tree-sitter-highlight", "tui-term", @@ -966,6 +967,12 @@ version = "1.13.2" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "3c5e1a9a646d36c3599cd173a41282daf47c44583ad367b8e6837255952e5c67" +[[package]] +name = "smawk" +version = "0.3.2" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "b7c388c1b5e93756d0c740965c41e8822f866621d41acbdf6336a6a168f8840c" + [[package]] name = "static_assertions" version = "1.1.0" @@ -1026,6 +1033,17 @@ dependencies = [ "libc", ] +[[package]] +name = "textwrap" +version = "0.16.1" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "23d434d3f8967a09480fb04132ebe0a3e088c173e6d0ee7897abbdf4eab0f8b9" +dependencies = [ + "smawk", + "unicode-linebreak", + "unicode-width 0.1.14", +] + [[package]] name = "thiserror" version = "1.0.63" @@ -1136,6 +1154,12 @@ version = "1.0.13" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "e91b56cd4cadaeb79bbf1a5645f6b4f8dc5bde8834ad5894a8db35fda9efa1fe" +[[package]] +name = "unicode-linebreak" +version = "0.1.5" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "3b09c83c3c29d37506a3e260c08c03743a6bb66a9cd432c6934ab501a190571f" + [[package]] name = "unicode-segmentation" version = "1.11.0" diff --git a/core/tabs/applications-setup/tab_data.toml b/core/tabs/applications-setup/tab_data.toml index ef6af7de..89338ad2 100644 --- a/core/tabs/applications-setup/tab_data.toml +++ b/core/tabs/applications-setup/tab_data.toml @@ -11,7 +11,7 @@ task_list = "I" [[data.entries]] name = "Neovim" -description = "Neovim is a refactor, and sometimes redactor, in the tradition of Vim.\nIt is not a rewrite but a continuation and extension of Vim.\nThis command configures neovim from CTT's neovim configuration.\nhttps://github.com/ChrisTitusTech/neovim" +description = "Neovim is a refactor, and sometimes redactor, in the tradition of Vim. It is not a rewrite but a continuation and extension of Vim. This command configures neovim from CTT's neovim configuration. https://github.com/ChrisTitusTech/neovim" script = "Developer-tools/neovim-setup.sh" task_list = "I FM" @@ -188,7 +188,7 @@ task_list = "I" [[data]] name = "Alacritty" -description = "Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows.\nThis command installs and condifures alacritty terminal emulator." +description = "Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows. This command installs and configures alacritty terminal emulator." script = "alacritty-setup.sh" task_list = "I FM" @@ -200,19 +200,19 @@ task_list = "I" [[data]] name = "Bash Prompt" -description = "The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems.\nIt is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful.\nThis command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository.\nhttps://github.com/ChrisTitusTech/mybash" +description = "The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash" script = "mybash-setup.sh" task_list = "I FM" [[data]] name = "Bottles" -description = "Bottles allows Windows software, like applications and games, to run on Linux.\nBottles also provides tools to categorize, organize and optimize your applications." +description = "Bottles allows Windows software, like applications and games, to run on Linux. Bottles also provides tools to categorize, organize and optimize your applications." script = "bottles-setup.sh" task_list = "FI" [[data]] name = "DWM-Titus" -description = "DWM is a dynamic window manager for X.\nIt manages windows in tiled, monocle and floating layouts.\nAll of the layouts can be applied dynamically, optimising the environment for the application in use and the task performed.\nThis command installs and configures DWM and a desktop manager.\nThe list of patches applied can be found in CTT's DWM repository\nhttps://github.com/ChrisTitusTech/dwm-titus" +description = "DWM is a dynamic window manager for X. It manages windows in tiled, monocle and floating layouts. All of the layouts can be applied dynamically, optimising the environment for the application in use and the task performed. This command installs and configures DWM and a desktop manager. The list of patches applied can be found in CTT's DWM repository https://github.com/ChrisTitusTech/dwm-titus" script = "dwmtitus-setup.sh" task_list = "I PFM SS" @@ -224,13 +224,13 @@ task_list = "I SS" [[data]] name = "Fastfetch" -description = "Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily.\nIt is written mainly in C, with performance and customizability in mind.\nThis command installs fastfetch and configures from CTT's mybash repository.\nhttps://github.com/ChrisTitusTech/mybash" +description = "Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily. It is written mainly in C, with performance and customizability in mind. This command installs fastfetch and configures from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash" script = "fastfetch-setup.sh" task_list = "I FM" [[data]] name = "Flatpak / Flathub" -description = "Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns.\nThis command installs Flatpak and adds the Flathub repository" +description = "Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns. This command installs Flatpak and adds the Flathub repository" script = "setup-flatpak.sh" task_list = "I" @@ -242,7 +242,7 @@ task_list = "PFM" [[data]] name = "Kitty" -description = "kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features.\nkitty is written in a mix of C and Python programming languages.\n This command installs and configures kitty." +description = "kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. kitty is written in a mix of C and Python programming languages. This command installs and configures kitty." script = "kitty-setup.sh" task_list = "I FM" @@ -270,7 +270,7 @@ values = [ "linutil" ] [[data]] name = "Rofi" -description = "Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport.\nThis command installs and configures rofi with configuration from CTT's DWM repo.\nhttps://github.com/ChrisTitusTech/dwm-titus" +description = "Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport. This command installs and configures rofi with configuration from CTT's DWM repo. https://github.com/ChrisTitusTech/dwm-titus" script = "rofi-setup.sh" task_list = "I FM" @@ -286,6 +286,6 @@ values = [ "wayland", "Wayland" ] [[data]] name = "ZSH Prompt" -description = "The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh.\nThis command installs ZSH prompt and provides basic configuration." +description = "The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. This command installs ZSH prompt and provides basic configuration." script = "zsh-setup.sh" task_list = "I FM" diff --git a/core/tabs/gaming/tab_data.toml b/core/tabs/gaming/tab_data.toml index 14eebd51..869a4180 100644 --- a/core/tabs/gaming/tab_data.toml +++ b/core/tabs/gaming/tab_data.toml @@ -5,6 +5,6 @@ name = "Diablo II Resurrected" [[data.entries]] name = "Loot Filter" -description = "This is a loot filter for Diablo II Resurrected.\nIt's designed to be a simple, clean, and easy to read loot filter that highlights the most important items.\nWorks on battle.net and single player.\nNo frills, no config, just highlights high runes and other valuable items.\nFor more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter" +description = "This is a loot filter for Diablo II Resurrected. It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items. Works on battle.net and single player. No frills, no config, just highlights high runes and other valuable items. For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter" script = "diablo-ii/d2r-loot-filters.sh" task_list = "FM" diff --git a/core/tabs/security/tab_data.toml b/core/tabs/security/tab_data.toml index 34de8174..ce8d7ac4 100644 --- a/core/tabs/security/tab_data.toml +++ b/core/tabs/security/tab_data.toml @@ -2,6 +2,6 @@ name = "Security" [[data]] name = "Firewall Baselines (CTT)" -description = "Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall.\nThis command installs UFW and configures UFW based on CTT's recommended rules.\nFor more information visit: https://christitus.com/linux-security-mistakes" +description = "Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall. This command installs UFW and configures UFW based on CTT's recommended rules. For more information visit: https://christitus.com/linux-security-mistakes" script = "firewall-baselines.sh" task_list = "I SS" diff --git a/core/tabs/system-setup/tab_data.toml b/core/tabs/system-setup/tab_data.toml index 080c06d9..db4a2c64 100644 --- a/core/tabs/system-setup/tab_data.toml +++ b/core/tabs/system-setup/tab_data.toml @@ -17,13 +17,13 @@ task_list = "SI D" [[data.entries]] name = "Paru AUR Helper" -description = "Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction.\nTo know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers" +description = "Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers" script = "arch/paru-setup.sh" task_list = "I" [[data.entries]] name = "Yay AUR Helper" -description = "Yet Another Yogurt - An AUR Helper Written in Go.\nTo know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers" +description = "Yet Another Yogurt - An AUR Helper Written in Go. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers" script = "arch/yay-setup.sh" task_list = "I" @@ -55,7 +55,7 @@ task_list = "I" [[data.entries]] name = "RPM Fusion" -description = "RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship.\nThat software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit.\nFor more information visit: https://rpmfusion.org/" +description = "RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit. For more information visit: https://rpmfusion.org/" script = "fedora/rpm-fusion-setup.sh" task_list = "MP" diff --git a/tui/Cargo.toml b/tui/Cargo.toml index 662b7a17..ea40460f 100644 --- a/tui/Cargo.toml +++ b/tui/Cargo.toml @@ -28,6 +28,7 @@ rand = { version = "0.8.5", optional = true } linutil_core = { path = "../core", version = "24.9.28" } tree-sitter-highlight = "0.23.0" tree-sitter-bash = "0.23.1" +textwrap = "0.16.1" anstyle = "1.0.8" ansi-to-tui = "6.0.0" zips = "0.1.7" diff --git a/tui/src/floating_text.rs b/tui/src/floating_text.rs index 52e0c50c..8e9efeb8 100644 --- a/tui/src/floating_text.rs +++ b/tui/src/floating_text.rs @@ -20,10 +20,12 @@ use ratatui::{ use ansi_to_tui::IntoText; +use textwrap::wrap; use tree_sitter_bash as hl_bash; use tree_sitter_highlight::{self as hl, HighlightEvent}; use zips::zip_result; +#[derive(Clone)] pub enum FloatingTextMode { Preview, Description, @@ -31,11 +33,13 @@ pub enum FloatingTextMode { } pub struct FloatingText { - pub src: Vec, + pub src: String, + wrapped_lines: Vec, max_line_width: usize, v_scroll: usize, h_scroll: usize, mode_title: &'static str, + mode: FloatingTextMode, } macro_rules! style { @@ -113,12 +117,6 @@ fn get_highlighted_string(s: &str) -> Option { Some(output) } -macro_rules! max_width { - ($($lines:tt)+) => {{ - $($lines)+.iter().fold(0, |accum, val| accum.max(val.len())) - }} -} - #[inline] fn get_lines(s: &str) -> Vec<&str> { s.lines().collect::>() @@ -131,52 +129,54 @@ fn get_lines_owned(s: &str) -> Vec { impl FloatingText { pub fn new(text: String, mode: FloatingTextMode) -> Self { - let src = get_lines(&text) + let max_line_width = 80; + let wrapped_lines = wrap(&text, max_line_width) .into_iter() - .map(|s| s.to_string()) - .collect::>(); - - let max_line_width = max_width!(src); + .map(|cow| cow.into_owned()) + .collect(); Self { - src, - mode_title: Self::get_mode_title(mode), + src: text, + wrapped_lines, + mode_title: Self::get_mode_title(&mode), max_line_width, v_scroll: 0, h_scroll: 0, + mode, } } pub fn from_command(command: &Command, mode: FloatingTextMode) -> Option { - let (max_line_width, src) = match command { - Command::Raw(cmd) => { - // just apply highlights directly - (max_width!(get_lines(cmd)), Some(cmd.clone())) - } + let src = match command { + Command::Raw(cmd) => Some(cmd.clone()), Command::LocalFile { file, .. } => { - // have to read from tmp dir to get cmd src - let raw = std::fs::read_to_string(file) + std::fs::read_to_string(file) .map_err(|_| format!("File not found: {:?}", file)) - .unwrap(); - - (max_width!(get_lines(&raw)), Some(raw)) + .ok() } + Command::None => None, + }?; - // If command is a folder, we don't display a preview - Command::None => (0usize, None), + let max_line_width = 80; + let wrapped_lines = match mode { + FloatingTextMode::Description => wrap(&src, max_line_width) + .into_iter() + .map(|cow| cow.into_owned()) + .collect(), + _ => get_lines_owned(&get_highlighted_string(&src)?), }; - let src = get_lines_owned(&get_highlighted_string(&src?)?); - Some(Self { src, - mode_title: Self::get_mode_title(mode), + wrapped_lines, + mode_title: Self::get_mode_title(&mode), max_line_width, h_scroll: 0, v_scroll: 0, + mode, }) } - fn get_mode_title(mode: FloatingTextMode) -> &'static str { + fn get_mode_title(mode: &FloatingTextMode) -> &'static str { match mode { FloatingTextMode::Preview => "Command Preview", FloatingTextMode::Description => "Command Description", @@ -185,7 +185,7 @@ impl FloatingText { } fn scroll_down(&mut self) { - if self.v_scroll + 1 < self.src.len() { + if self.v_scroll + 1 < self.wrapped_lines.len() { self.v_scroll += 1; } } @@ -207,6 +207,19 @@ impl FloatingText { self.h_scroll += 1; } } + + fn update_wrapping(&mut self, width: usize) { + if self.max_line_width != width { + self.max_line_width = width; + self.wrapped_lines = match self.mode { + FloatingTextMode::Description => wrap(&self.src, width) + .into_iter() + .map(|cow| cow.into_owned()) + .collect(), + _ => get_lines_owned(&get_highlighted_string(&self.src).unwrap_or(self.src.clone())), + }; + } + } } impl FloatContent for FloatingText { @@ -224,13 +237,22 @@ impl FloatContent for FloatingText { // Calculate the inner area to ensure text is not drawn over the border let inner_area = block.inner(area); - let Rect { height, .. } = inner_area; + let Rect { width, height, .. } = inner_area; + + self.update_wrapping(width as usize); + let lines = self - .src + .wrapped_lines .iter() .skip(self.v_scroll) .take(height as usize) - .flat_map(|l| l.into_text().unwrap()) + .flat_map(|l| { + if let FloatingTextMode::Description = self.mode { + vec![Line::raw(l.clone())] + } else { + l.into_text().unwrap().lines + } + }) .map(|line| { let mut skipped = 0; let mut spans = line From bd6154fbf56041b57e8c3bc9d8a7bef645c7c9cb Mon Sep 17 00:00:00 2001 From: nyx Date: Fri, 4 Oct 2024 06:10:41 -0400 Subject: [PATCH 2/8] run fmt --- tui/src/floating_text.rs | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/tui/src/floating_text.rs b/tui/src/floating_text.rs index 8e9efeb8..03d174ff 100644 --- a/tui/src/floating_text.rs +++ b/tui/src/floating_text.rs @@ -148,11 +148,9 @@ impl FloatingText { pub fn from_command(command: &Command, mode: FloatingTextMode) -> Option { let src = match command { Command::Raw(cmd) => Some(cmd.clone()), - Command::LocalFile { file, .. } => { - std::fs::read_to_string(file) - .map_err(|_| format!("File not found: {:?}", file)) - .ok() - } + Command::LocalFile { file, .. } => std::fs::read_to_string(file) + .map_err(|_| format!("File not found: {:?}", file)) + .ok(), Command::None => None, }?; @@ -216,7 +214,9 @@ impl FloatingText { .into_iter() .map(|cow| cow.into_owned()) .collect(), - _ => get_lines_owned(&get_highlighted_string(&self.src).unwrap_or(self.src.clone())), + _ => { + get_lines_owned(&get_highlighted_string(&self.src).unwrap_or(self.src.clone())) + } }; } } @@ -238,7 +238,7 @@ impl FloatContent for FloatingText { // Calculate the inner area to ensure text is not drawn over the border let inner_area = block.inner(area); let Rect { width, height, .. } = inner_area; - + self.update_wrapping(width as usize); let lines = self From eed3967ccb710248e2fdbe1a631ebeb4ad3eb773 Mon Sep 17 00:00:00 2001 From: nyx Date: Fri, 4 Oct 2024 08:38:31 -0400 Subject: [PATCH 3/8] remove dupe space --- core/tabs/applications-setup/tab_data.toml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/tabs/applications-setup/tab_data.toml b/core/tabs/applications-setup/tab_data.toml index 89338ad2..4672a67e 100644 --- a/core/tabs/applications-setup/tab_data.toml +++ b/core/tabs/applications-setup/tab_data.toml @@ -242,7 +242,7 @@ task_list = "PFM" [[data]] name = "Kitty" -description = "kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. kitty is written in a mix of C and Python programming languages. This command installs and configures kitty." +description = "kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. kitty is written in a mix of C and Python programming languages. This command installs and configures kitty." script = "kitty-setup.sh" task_list = "I FM" From 5585a22d83dd55de49d45a7f0e290fb91a60addb Mon Sep 17 00:00:00 2001 From: nyx Date: Thu, 10 Oct 2024 05:59:53 -0400 Subject: [PATCH 4/8] run fmt --- tui/src/floating_text.rs | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tui/src/floating_text.rs b/tui/src/floating_text.rs index 9ffaf1ab..5bf74e20 100644 --- a/tui/src/floating_text.rs +++ b/tui/src/floating_text.rs @@ -317,4 +317,4 @@ impl FloatContent for FloatingText { ]), ) } -} \ No newline at end of file +} From e432865e3b1cd5191dae812f7530450ef23e492e Mon Sep 17 00:00:00 2001 From: nyx Date: Thu, 10 Oct 2024 06:00:36 -0400 Subject: [PATCH 5/8] add remove comments back --- tui/src/floating_text.rs | 23 +++++++++++++++-------- 1 file changed, 15 insertions(+), 8 deletions(-) diff --git a/tui/src/floating_text.rs b/tui/src/floating_text.rs index 5bf74e20..77800e79 100644 --- a/tui/src/floating_text.rs +++ b/tui/src/floating_text.rs @@ -50,14 +50,14 @@ macro_rules! style { } const SYNTAX_HIGHLIGHT_STYLES: [(&str, anstyle::Style); 8] = [ - ("function", style!(220, 220, 170)), - ("string", style!(206, 145, 120)), - ("property", style!(156, 220, 254)), - ("comment", style!(92, 131, 75)), - ("embedded", style!(206, 145, 120)), - ("constant", style!(79, 193, 255)), - ("keyword", style!(197, 134, 192)), - ("number", style!(181, 206, 168)), + ("function", style!(220, 220, 170)), // yellow + ("string", style!(206, 145, 120)), // brown + ("property", style!(156, 220, 254)), // light blue + ("comment", style!(92, 131, 75)), // green + ("embedded", style!(206, 145, 120)), // blue (string expansions) + ("constant", style!(79, 193, 255)), // dark blue + ("keyword", style!(197, 134, 192)), // magenta + ("number", style!(181, 206, 168)), // light green ]; fn get_highlighted_string(s: &str) -> Option { @@ -224,6 +224,7 @@ impl FloatingText { impl FloatContent for FloatingText { fn draw(&mut self, frame: &mut Frame, area: Rect) { + // Define the Block with a border and background color let block = Block::default() .borders(Borders::ALL) .title(self.mode_title.clone()) @@ -231,8 +232,10 @@ impl FloatContent for FloatingText { .title_style(Style::default().reversed()) .style(Style::default()); + // Draw the Block first frame.render_widget(block.clone(), area); + // Calculate the inner area to ensure text is not drawn over the border let inner_area = block.inner(area); let Rect { width, height, .. } = inner_area; @@ -281,11 +284,15 @@ impl FloatContent for FloatingText { }) .collect::>(); + // Create list widget let list = List::new(lines) .block(Block::default()) .highlight_style(Style::default().reversed()); + // Clear the text underneath the floats rendered area frame.render_widget(Clear, inner_area); + + // Render the list inside the bordered area frame.render_widget(list, inner_area); } From e8af79669b59b4e318915a70b090812d41976b20 Mon Sep 17 00:00:00 2001 From: nyx Date: Thu, 10 Oct 2024 06:02:18 -0400 Subject: [PATCH 6/8] fix compilation errors --- tui/src/state.rs | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/tui/src/state.rs b/tui/src/state.rs index 9ed61771..90ed3f56 100644 --- a/tui/src/state.rs +++ b/tui/src/state.rs @@ -2,7 +2,7 @@ use crate::{ confirmation::{ConfirmPrompt, ConfirmStatus}, filter::{Filter, SearchAction}, float::{Float, FloatContent}, - floating_text::FloatingText, + floating_text::{FloatingText, FloatingTextMode}, hint::{create_shortcut_list, Shortcut}, running_command::RunningCommand, theme::Theme, @@ -657,7 +657,7 @@ impl AppState { if let Some(list_node) = self.get_selected_node() { let mut preview_title = "[Preview] - ".to_string(); preview_title.push_str(list_node.name.as_str()); - if let Some(preview) = FloatingText::from_command(&list_node.command, preview_title) { + if let Some(preview) = FloatingText::from_command(&list_node.command, FloatingTextMode::Preview) { self.spawn_float(preview, 80, 80); } } @@ -665,7 +665,7 @@ impl AppState { fn enable_description(&mut self) { if let Some(command_description) = self.get_selected_description() { - let description = FloatingText::new(command_description, "Command Description"); + let description = FloatingText::new(command_description, FloatingTextMode::Description); self.spawn_float(description, 80, 80); } } @@ -731,7 +731,7 @@ impl AppState { fn toggle_task_list_guide(&mut self) { self.spawn_float( - FloatingText::new(ACTIONS_GUIDE.to_string(), "Important Actions Guide"), + FloatingText::new(ACTIONS_GUIDE.to_string(), FloatingTextMode::ActionsGuide), 80, 80, ); From 6c0dedf8fb5391da3b9ca7940d44eed07d8b5b04 Mon Sep 17 00:00:00 2001 From: nyx Date: Thu, 10 Oct 2024 06:03:06 -0400 Subject: [PATCH 7/8] run fmt --- tui/src/state.rs | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/tui/src/state.rs b/tui/src/state.rs index 90ed3f56..49401edd 100644 --- a/tui/src/state.rs +++ b/tui/src/state.rs @@ -657,7 +657,9 @@ impl AppState { if let Some(list_node) = self.get_selected_node() { let mut preview_title = "[Preview] - ".to_string(); preview_title.push_str(list_node.name.as_str()); - if let Some(preview) = FloatingText::from_command(&list_node.command, FloatingTextMode::Preview) { + if let Some(preview) = + FloatingText::from_command(&list_node.command, FloatingTextMode::Preview) + { self.spawn_float(preview, 80, 80); } } From 6fb75c73bf5550235de838174628e362c46afe37 Mon Sep 17 00:00:00 2001 From: nyx Date: Thu, 10 Oct 2024 06:05:13 -0400 Subject: [PATCH 8/8] run docgen --- docs/userguide.md | 62 ++++++++++++----------------------------------- 1 file changed, 15 insertions(+), 47 deletions(-) diff --git a/docs/userguide.md b/docs/userguide.md index 2b7ad82b..714bf511 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -7,10 +7,7 @@ ### Developer Tools - **Github Desktop**: GitHub Desktop is a user-friendly application that simplifies the process of managing Git repositories and interacting with GitHub, providing a graphical interface for tasks like committing, branching, and syncing changes. -- **Neovim**: Neovim is a refactor, and sometimes redactor, in the tradition of Vim. -It is not a rewrite but a continuation and extension of Vim. -This command configures neovim from CTT's neovim configuration. -https://github.com/ChrisTitusTech/neovim +- **Neovim**: Neovim is a refactor, and sometimes redactor, in the tradition of Vim. It is not a rewrite but a continuation and extension of Vim. This command configures neovim from CTT's neovim configuration. https://github.com/ChrisTitusTech/neovim - **Sublime Text**: Sublime Text is a fast, lightweight, and customizable text editor known for its simplicity, powerful features, and wide range of plugins for various programming languages. - **VS Code**: Visual Studio Code (VS Code) is a lightweight, open-source code editor with built-in support for debugging, version control, and extensions for various programming languages and frameworks. - **VS Codium**: VSCodium is a free, open-source version of Visual Studio Code (VS Code) that removes Microsoft-specific telemetry and branding. @@ -43,57 +40,32 @@ https://github.com/ChrisTitusTech/neovim - **Mozilla Firefox**: Mozilla Firefox is a free and open-source web browser developed by the Mozilla Foundation. - **Thorium**: Thorium is a Chromium-based browser focused on privacy and performance. - **Vivaldi**: Vivaldi is a freeware, cross-platform web browser developed by Vivaldi Technologies. -- **Alacritty**: Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows. -This command installs and condifures alacritty terminal emulator. +- **Alacritty**: Alacritty is a modern terminal emulator that comes with sensible defaults, but allows for extensive configuration. By integrating with other applications, rather than reimplementing their functionality, it manages to provide a flexible set of features with high performance. The supported platforms currently consist of BSD, Linux, macOS and Windows. This command installs and configures alacritty terminal emulator. - **Android Debloater**: Universal Android Debloater (UAD) is a tool designed to help users remove bloatware and unnecessary pre-installed applications from Android devices, enhancing performance and user experience. -- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. -It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. -This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. -https://github.com/ChrisTitusTech/mybash -- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux. -Bottles also provides tools to categorize, organize and optimize your applications. -- **DWM-Titus**: DWM is a dynamic window manager for X. -It manages windows in tiled, monocle and floating layouts. -All of the layouts can be applied dynamically, optimising the environment for the application in use and the task performed. -This command installs and configures DWM and a desktop manager. -The list of patches applied can be found in CTT's DWM repository -https://github.com/ChrisTitusTech/dwm-titus +- **Bash Prompt**: The .bashrc file is a script that runs every time a new terminal session is started in Unix-like operating systems. It is used to configure the shell session, set up aliases, define functions, and more, making the terminal easier to use and more powerful. This command configures the key sections and functionalities defined in the .bashrc file from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash +- **Bottles**: Bottles allows Windows software, like applications and games, to run on Linux. Bottles also provides tools to categorize, organize and optimize your applications. +- **DWM-Titus**: DWM is a dynamic window manager for X. It manages windows in tiled, monocle and floating layouts. All of the layouts can be applied dynamically, optimising the environment for the application in use and the task performed. This command installs and configures DWM and a desktop manager. The list of patches applied can be found in CTT's DWM repository https://github.com/ChrisTitusTech/dwm-titus - **Docker**: Docker is an open platform that uses OS-level virtualization to deliver software in packages called containers. -- **Fastfetch**: Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily. -It is written mainly in C, with performance and customizability in mind. -This command installs fastfetch and configures from CTT's mybash repository. -https://github.com/ChrisTitusTech/mybash -- **Flatpak / Flathub**: Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns. -This command installs Flatpak and adds the Flathub repository +- **Fastfetch**: Fastfetch is a neofetch-like tool for fetching system information and displaying it prettily. It is written mainly in C, with performance and customizability in mind. This command installs fastfetch and configures from CTT's mybash repository. https://github.com/ChrisTitusTech/mybash +- **Flatpak / Flathub**: Flatpak is a universal application sandbox for Linux that uses isolated packages from Flathub to prevent conflicts and system alterations, while alleviating dependency concerns. This command installs Flatpak and adds the Flathub repository - **Grub Theme**: Installs ChrisTitusTech's Top 5 Bootloader Themes script to allow for easy customization of GRUB. -- **Kitty**: kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. -kitty is written in a mix of C and Python programming languages. - This command installs and configures kitty. +- **Kitty**: kitty is a free and open-source GPU-accelerated terminal emulator for Linux, macOS, and some BSD distributions, focused on performance and features. kitty is written in a mix of C and Python programming languages. This command installs and configures kitty. - **Linutil Installer**: Installs a distro-specific Linutil package locally. - **Linutil Updater**: Updates your local Linutil crate installation. -- **Rofi**: Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport. -This command installs and configures rofi with configuration from CTT's DWM repo. -https://github.com/ChrisTitusTech/dwm-titus +- **Rofi**: Rofi is a window switcher, run dialog, ssh-launcher and dmenu replacement that started as a clone of simpleswitcher, written by Sean Pringle and later expanded by Dave Davenport. This command installs and configures rofi with configuration from CTT's DWM repo. https://github.com/ChrisTitusTech/dwm-titus - **Waydroid**: Waydroid is an emulator that allows you to run Android apps and games on Linux. -- **ZSH Prompt**: The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. -This command installs ZSH prompt and provides basic configuration. +- **ZSH Prompt**: The Z shell is a Unix shell that can be used as an interactive login shell and as a command interpreter for shell scripting. Zsh is an extended Bourne shell with many improvements, including some features of Bash, ksh, and tcsh. This command installs ZSH prompt and provides basic configuration. ## Gaming ### Diablo II Resurrected -- **Loot Filter**: This is a loot filter for Diablo II Resurrected. -It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items. -Works on battle.net and single player. -No frills, no config, just highlights high runes and other valuable items. -For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter +- **Loot Filter**: This is a loot filter for Diablo II Resurrected. It's designed to be a simple, clean, and easy to read loot filter that highlights the most important items. Works on battle.net and single player. No frills, no config, just highlights high runes and other valuable items. For more information visit: https://github.com/ChrisTitusTech/d2r-loot-filter ## Security -- **Firewall Baselines (CTT)**: Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall. -This command installs UFW and configures UFW based on CTT's recommended rules. -For more information visit: https://christitus.com/linux-security-mistakes +- **Firewall Baselines (CTT)**: Developed to ease iptables firewall configuration, UFW provides a user friendly way to create an IPv4 or IPv6 host-based firewall. This command installs UFW and configures UFW based on CTT's recommended rules. For more information visit: https://christitus.com/linux-security-mistakes ## System Setup @@ -101,19 +73,15 @@ For more information visit: https://christitus.com/linux-security-mistakes ### Arch Linux - **Arch Server Setup**: This command installs a minimal arch server setup under 5 minutes. -- **Paru AUR Helper**: Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction. -To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers -- **Yay AUR Helper**: Yet Another Yogurt - An AUR Helper Written in Go. -To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers +- **Paru AUR Helper**: Paru is your standard pacman wrapping AUR helper with lots of features and minimal interaction. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers +- **Yay AUR Helper**: Yet Another Yogurt - An AUR Helper Written in Go. To know more about AUR helpers visit: https://wiki.archlinux.org/title/AUR_helpers ### Fedora - **Configure DNF**: Optimizes DNF for parallel downloads - **Multimedia Codecs**: This script is designed to install multimedia codecs, and to ensure RPM Fusion repositories are installed. - **Nvidia Proprietary Drivers**: This script is designed to download the proprietary NVIDIA drivers in Fedora. -- **RPM Fusion**: RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. -That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit. -For more information visit: https://rpmfusion.org/ +- **RPM Fusion**: RPM Fusion provides software that the Fedora Project or Red Hat doesn't want to ship. That software is provided as precompiled RPMs for all current Fedora versions and current Red Hat Enterprise Linux or clones versions; you can use the RPM Fusion repositories with tools like yum and PackageKit. For more information visit: https://rpmfusion.org/ - **Virtualization**: Enables Virtualization through dnf - **Build Prerequisites**: This script is designed to handle the installation of various software dependencies across different Linux distributions - **Full System Cleanup**: This script is designed to remove unnecessary packages, clean old cache files, remove temporary files, and to empty the trash.