From 77962e2a5cea167bd6a932b1da79133bb1f74b70 Mon Sep 17 00:00:00 2001 From: afonsofrancof Date: Mon, 23 Sep 2024 03:31:52 +0100 Subject: [PATCH 01/23] Made popup title generic. Preview title is now the command name --- tui/src/floating_text.rs | 28 +++++++--------------------- tui/src/hint.rs | 8 ++++---- tui/src/running_command.rs | 4 ++-- tui/src/state.rs | 34 ++++++++++++++++------------------ 4 files changed, 29 insertions(+), 45 deletions(-) diff --git a/tui/src/floating_text.rs b/tui/src/floating_text.rs index 2cd63824..772c1c6b 100644 --- a/tui/src/floating_text.rs +++ b/tui/src/floating_text.rs @@ -27,18 +27,12 @@ use tree_sitter_bash as hl_bash; use tree_sitter_highlight::{self as hl, HighlightEvent}; use zips::zip_result; -pub enum FloatingTextMode { - Preview, - Description, - ActionsGuide, -} - pub struct FloatingText { pub src: Vec, max_line_width: usize, v_scroll: usize, h_scroll: usize, - mode_title: &'static str, + mode_title: String, } macro_rules! style { @@ -133,7 +127,7 @@ fn get_lines_owned(s: &str) -> Vec { } impl FloatingText { - pub fn new(text: String, mode: FloatingTextMode) -> Self { + pub fn new(text: String, title: &str) -> Self { let src = get_lines(&text) .into_iter() .map(|s| s.to_string()) @@ -142,14 +136,14 @@ impl FloatingText { let max_line_width = max_width!(src); Self { src, - mode_title: Self::get_mode_title(mode), + mode_title: title.to_string(), max_line_width, v_scroll: 0, h_scroll: 0, } } - pub fn from_command(command: &Command, mode: FloatingTextMode) -> Option { + pub fn from_command(command: &Command, title: String) -> Option { let (max_line_width, src) = match command { Command::Raw(cmd) => { // just apply highlights directly @@ -172,21 +166,13 @@ impl FloatingText { Some(Self { src, - mode_title: Self::get_mode_title(mode), + mode_title: title, max_line_width, h_scroll: 0, v_scroll: 0, }) } - fn get_mode_title(mode: FloatingTextMode) -> &'static str { - match mode { - FloatingTextMode::Preview => "Command Preview", - FloatingTextMode::Description => "Command Description", - FloatingTextMode::ActionsGuide => "Important Actions Guide", - } - } - fn scroll_down(&mut self) { if self.v_scroll + 1 < self.src.len() { self.v_scroll += 1; @@ -217,7 +203,7 @@ impl FloatContent for FloatingText { // Define the Block with a border and background color let block = Block::default() .borders(Borders::ALL) - .title(self.mode_title) + .title(self.mode_title.clone()) .title_alignment(ratatui::layout::Alignment::Center) .title_style(Style::default().reversed()) .style(Style::default()); @@ -295,7 +281,7 @@ impl FloatContent for FloatingText { fn get_shortcut_list(&self) -> ShortcutList { ShortcutList { - scope_name: self.mode_title, + scope_name: self.mode_title.clone(), hints: vec![ Shortcut::new(vec!["j", "Down"], "Scroll down"), Shortcut::new(vec!["k", "Up"], "Scroll up"), diff --git a/tui/src/hint.rs b/tui/src/hint.rs index e59eab5a..a6cbeb35 100644 --- a/tui/src/hint.rs +++ b/tui/src/hint.rs @@ -11,7 +11,7 @@ use crate::state::{AppState, Focus}; pub const SHORTCUT_LINES: usize = 2; pub struct ShortcutList { - pub scope_name: &'static str, + pub scope_name: String, pub hints: Vec, } @@ -114,7 +114,7 @@ fn get_list_item_shortcut(state: &AppState) -> Vec { pub fn draw_shortcuts(state: &AppState, frame: &mut Frame, area: Rect) { match state.focus { Focus::Search => ShortcutList { - scope_name: "Search bar", + scope_name: "Search bar".to_string(), hints: vec![Shortcut::new(vec!["Enter"], "Finish search")], }, @@ -146,13 +146,13 @@ pub fn draw_shortcuts(state: &AppState, frame: &mut Frame, area: Rect) { hints.push(Shortcut::new(vec!["Shift-Tab"], "Previous tab")); hints.push(Shortcut::new(vec!["g"], "Important actions guide")); ShortcutList { - scope_name: "Command list", + scope_name: "Command list".to_string(), hints, } } Focus::TabList => ShortcutList { - scope_name: "Tab list", + scope_name: "Tab list".to_string(), hints: vec![ Shortcut::new(vec!["q", "CTRL-c"], "Exit linutil"), Shortcut::new(vec!["l", "Right", "Enter"], "Focus action list"), diff --git a/tui/src/running_command.rs b/tui/src/running_command.rs index e1d4b0a0..598236cb 100644 --- a/tui/src/running_command.rs +++ b/tui/src/running_command.rs @@ -123,12 +123,12 @@ impl FloatContent for RunningCommand { fn get_shortcut_list(&self) -> ShortcutList { if self.is_finished() { ShortcutList { - scope_name: "Finished command", + scope_name: "Finished command".to_string(), hints: vec![Shortcut::new(vec!["Enter", "q"], "Close window")], } } else { ShortcutList { - scope_name: "Running command", + scope_name: "Running command".to_string(), hints: vec![Shortcut::new(vec!["CTRL-c"], "Kill the command")], } } diff --git a/tui/src/state.rs b/tui/src/state.rs index 4aee0aaa..46238716 100644 --- a/tui/src/state.rs +++ b/tui/src/state.rs @@ -1,7 +1,7 @@ use crate::{ filter::{Filter, SearchAction}, float::{Float, FloatContent}, - floating_text::{FloatingText, FloatingTextMode}, + floating_text::FloatingText, hint::{draw_shortcuts, SHORTCUT_LINES}, running_command::RunningCommand, theme::Theme, @@ -415,11 +415,11 @@ impl AppState { } } fn toggle_selection(&mut self) { - if let Some(command) = self.get_selected_command() { - if self.selected_commands.contains(&command) { - self.selected_commands.retain(|c| c != &command); + if let Some(list_node) = self.get_selected_list_node() { + if self.selected_commands.contains(&list_node.command) { + self.selected_commands.retain(|c| c != &list_node.command); } else { - self.selected_commands.push(command); + self.selected_commands.push(list_node.command); } } } @@ -470,12 +470,8 @@ impl AppState { } None } - pub fn get_selected_command(&self) -> Option { - self.get_selected_node().map(|node| node.command.clone()) - } - fn get_selected_description(&self) -> Option { - self.get_selected_node() - .map(|node| node.description.clone()) + pub fn get_selected_list_node(&self) -> Option { + self.get_selected_node().cloned() } pub fn go_to_selected_dir(&mut self) { let mut selected_index = self.selection.selected().unwrap_or(0); @@ -524,15 +520,17 @@ impl AppState { !self.at_root() && selected_index == 0 } fn enable_preview(&mut self) { - if let Some(command) = self.get_selected_command() { - if let Some(preview) = FloatingText::from_command(&command, FloatingTextMode::Preview) { + if let Some(list_node) = self.get_selected_list_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) { self.spawn_float(preview, 80, 80); } } } fn enable_description(&mut self) { - if let Some(command_description) = self.get_selected_description() { - let description = FloatingText::new(command_description, FloatingTextMode::Description); + if let Some(list_node) = self.get_selected_list_node() { + let description = FloatingText::new(list_node.description, "Command Description"); self.spawn_float(description, 80, 80); } } @@ -540,8 +538,8 @@ impl AppState { fn handle_enter(&mut self) { if self.selected_item_is_cmd() { if self.selected_commands.is_empty() { - if let Some(cmd) = self.get_selected_command() { - self.selected_commands.push(cmd); + if let Some(list_node) = self.get_selected_list_node() { + self.selected_commands.push(list_node.command); } } let command = RunningCommand::new(self.selected_commands.clone()); @@ -576,7 +574,7 @@ impl AppState { fn toggle_task_list_guide(&mut self) { self.spawn_float( - FloatingText::new(ACTIONS_GUIDE.to_string(), FloatingTextMode::ActionsGuide), + FloatingText::new(ACTIONS_GUIDE.to_string(), "Important Actions Guide"), 80, 80, ); From 89bbc52712553274f1826889dc9398e654657102 Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Sun, 29 Sep 2024 14:17:28 +0530 Subject: [PATCH 02/23] Remove quotes for packages --- core/tabs/system-setup/compile-setup.sh | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/core/tabs/system-setup/compile-setup.sh b/core/tabs/system-setup/compile-setup.sh index 6345fc97..74a96a41 100755 --- a/core/tabs/system-setup/compile-setup.sh +++ b/core/tabs/system-setup/compile-setup.sh @@ -15,30 +15,30 @@ installDepend() { else printf "%b\n" "${GREEN}Multilib is already enabled.${RC}" fi - "$AUR_HELPER" -S --needed --noconfirm "$DEPENDENCIES" + "$AUR_HELPER" -S --needed --noconfirm $DEPENDENCIES ;; apt-get|nala) COMPILEDEPS='build-essential' "$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" dpkg --add-architecture i386 "$ESCALATION_TOOL" "$PACKAGER" update - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$COMPILEDEPS" + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $COMPILEDEPS ;; dnf) COMPILEDEPS='@development-tools' "$ESCALATION_TOOL" "$PACKAGER" update "$ESCALATION_TOOL" "$PACKAGER" config-manager --set-enabled powertools - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" $COMPILEDEPS + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $COMPILEDEPS "$ESCALATION_TOOL" "$PACKAGER" install -y glibc-devel.i686 libgcc.i686 ;; zypper) COMPILEDEPS='patterns-devel-base-devel_basis' "$ESCALATION_TOOL" "$PACKAGER" refresh - "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install "$DEPENDENCIES" "$COMPILEDEPS" + "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install $DEPENDENCIES $COMPILEDEPS "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install libgcc_s1-gcc7-32bit glibc-devel-32bit ;; *) - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES ;; esac } From c3312dcc742775ca85c46ba40683c79776fee9a7 Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Mon, 30 Sep 2024 14:36:49 +0530 Subject: [PATCH 03/23] Fix gaming setup deps --- core/tabs/system-setup/gaming-setup.sh | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/core/tabs/system-setup/gaming-setup.sh b/core/tabs/system-setup/gaming-setup.sh index 86ad21aa..92c666c7 100755 --- a/core/tabs/system-setup/gaming-setup.sh +++ b/core/tabs/system-setup/gaming-setup.sh @@ -23,7 +23,7 @@ installDepend() { ncurses lib32-ncurses vulkan-icd-loader lib32-vulkan-icd-loader ocl-icd lib32-ocl-icd libva lib32-libva \ gst-plugins-base-libs lib32-gst-plugins-base-libs sdl2" - $AUR_HELPER -S --needed --noconfirm "$DEPENDENCIES" "$DISTRO_DEPS" + $AUR_HELPER -S --needed --noconfirm $DEPENDENCIES $DISTRO_DEPS ;; apt-get|nala) DISTRO_DEPS="libasound2 libsdl2 wine64 wine32" @@ -33,24 +33,24 @@ installDepend() { "$ESCALATION_TOOL" "$PACKAGER" install -y software-properties-common "$ESCALATION_TOOL" apt-add-repository contrib -y "$ESCALATION_TOOL" "$PACKAGER" update - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" "$DISTRO_DEPS" + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES $DISTRO_DEPS ;; dnf) if [ "$(rpm -E %fedora)" -le 41 ]; then "$ESCALATION_TOOL" "$PACKAGER" install ffmpeg ffmpeg-libs -y - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES else printf "%b\n" "${CYAN}Fedora < 41 detected. Installing rpmfusion repos.${RC}" "$ESCALATION_TOOL" "$PACKAGER" install https://mirrors.rpmfusion.org/free/fedora/rpmfusion-free-release-"$(rpm -E %fedora)".noarch.rpm https://mirrors.rpmfusion.org/nonfree/fedora/rpmfusion-nonfree-release-"$(rpm -E %fedora)".noarch.rpm -y "$ESCALATION_TOOL" "$PACKAGER" config-manager --enable fedora-cisco-openh264 -y - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES fi ;; zypper) - "$ESCALATION_TOOL" "$PACKAGER" -n install "$DEPENDENCIES" + "$ESCALATION_TOOL" "$PACKAGER" -n install $DEPENDENCIES ;; *) - "$ESCALATION_TOOL" "$PACKAGER" install -y "$DEPENDENCIES" + "$ESCALATION_TOOL" "$PACKAGER" install -y $DEPENDENCIES ;; esac } @@ -59,7 +59,7 @@ installAdditionalDepend() { case "$PACKAGER" in pacman) DISTRO_DEPS='steam lutris goverlay' - "$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm "$DISTRO_DEPS" + "$ESCALATION_TOOL" "$PACKAGER" -S --needed --noconfirm $DISTRO_DEPS ;; apt-get|nala) version=$(git -c 'versionsort.suffix=-' ls-remote --tags --sort='v:refname' https://github.com/lutris/lutris | From 05d869ef7491dc034d371bc12b5c1508936d481f Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 3 Oct 2024 00:05:31 +0200 Subject: [PATCH 04/23] fix: pacman orphan package removal --- core/tabs/system-setup/system-cleanup.sh | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/core/tabs/system-setup/system-cleanup.sh b/core/tabs/system-setup/system-cleanup.sh index 198a9d68..3d376ba5 100644 --- a/core/tabs/system-setup/system-cleanup.sh +++ b/core/tabs/system-setup/system-cleanup.sh @@ -23,7 +23,8 @@ cleanup_system() { ;; pacman) "$ESCALATION_TOOL" "$PACKAGER" -Sc --noconfirm - "$ESCALATION_TOOL" "$PACKAGER" -Rns "$(pacman -Qtdq)" --noconfirm + # -Rns will return 1 if there are no packages provided + "$PACKAGER" -Qtdq | "$ESCALATION_TOOL" "$PACKAGER" -Rns --noconfirm -- &> /dev/null 2>&1 || true ;; *) printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" From a911fe1c168daff791b9a61d4e261ce423bd2988 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 3 Oct 2024 00:14:06 +0200 Subject: [PATCH 05/23] missclick :( --- core/tabs/system-setup/system-cleanup.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/tabs/system-setup/system-cleanup.sh b/core/tabs/system-setup/system-cleanup.sh index 3d376ba5..cc14d0a4 100644 --- a/core/tabs/system-setup/system-cleanup.sh +++ b/core/tabs/system-setup/system-cleanup.sh @@ -24,7 +24,7 @@ cleanup_system() { pacman) "$ESCALATION_TOOL" "$PACKAGER" -Sc --noconfirm # -Rns will return 1 if there are no packages provided - "$PACKAGER" -Qtdq | "$ESCALATION_TOOL" "$PACKAGER" -Rns --noconfirm -- &> /dev/null 2>&1 || true + "$PACKAGER" -Qtdq | "$ESCALATION_TOOL" "$PACKAGER" -Rns --noconfirm - > /dev/null 2>&1 || true ;; *) printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" From 1c775048cb43733c2200b0f6d7f58767ef787de2 Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Thu, 3 Oct 2024 11:43:48 +0530 Subject: [PATCH 06/23] Add vhs github action --- .github/workflows/linutil.yml | 22 ++++++++++++---------- docs/assets/preview.tape | 9 +++++---- 2 files changed, 17 insertions(+), 14 deletions(-) diff --git a/.github/workflows/linutil.yml b/.github/workflows/linutil.yml index e6d464da..4c58a08b 100644 --- a/.github/workflows/linutil.yml +++ b/.github/workflows/linutil.yml @@ -89,22 +89,24 @@ jobs: version: ${{ env.version }} GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} - - name: Install vhs + - name: Setup Preview run: | - wget 'https://github.com/charmbracelet/vhs/releases/download/v0.8.0/vhs_0.8.0_amd64.deb' - sudo apt install -y ffmpeg - sudo snap install ttyd --classic - sudo dpkg -i 'vhs_0.8.0_amd64.deb' + echo "$(pwd)/build" >> $GITHUB_PATH + + - name: Generate preview + uses: charmbracelet/vhs-action@v2.1.0 + with: + path: "docs/assets/preview.tape" + install-fonts: "true" - - name: Build the preview + - name: Move preview run: | - export PATH="$(pwd)/build:$PATH" - vhs docs/assets/preview.tape -o docs/assets/preview.gif + mv preview.gif docs/assets/preview.gif - - name: Upload the preview + - name: Upload preview uses: stefanzweifel/git-auto-commit-action@v5 with: commit_message: Preview for ${{ env.version }} file_pattern: "docs/assets/preview.gif" add_options: "--force" - if: success() + if: success() \ No newline at end of file diff --git a/docs/assets/preview.tape b/docs/assets/preview.tape index ca2b59d7..66b1c359 100644 --- a/docs/assets/preview.tape +++ b/docs/assets/preview.tape @@ -61,13 +61,14 @@ Require linutil Require sh Set Shell "bash" -Set FontSize 32 -Set Width 3200 -Set Height 1800 +Set FontFamily "JetBrainsMono Nerd Font" +Set FontSize 24 +Set Width 1920 +Set Height 1080 Sleep 1s -Type "linutil -t compatible" Sleep 1s Enter +Type "linutil" Sleep 1s Enter Sleep 5s From e8fbd9e56ec348f3e54aa4a2d21d9bdb2c2983e8 Mon Sep 17 00:00:00 2001 From: Guru Swarupa <112751363+guruswarupa@users.noreply.github.com> Date: Thu, 3 Oct 2024 12:49:23 +0530 Subject: [PATCH 07/23] set resolution fix --- core/tabs/utils/tab_data.toml | 26 ++++++++++++++++---------- 1 file changed, 16 insertions(+), 10 deletions(-) diff --git a/core/tabs/utils/tab_data.toml b/core/tabs/utils/tab_data.toml index 7cfc3ed7..ba7c0e1b 100644 --- a/core/tabs/utils/tab_data.toml +++ b/core/tabs/utils/tab_data.toml @@ -16,60 +16,66 @@ values = [":0", ":1", ":2", ":3", ":4", ":5", ":6", ":7", ":8", ":9"] [[data.entries]] name = "Auto Detect Displays" -description = "This utility is designed to detect and apply recommended configuration for monitors connected with your system" +description = "This script is designed to detect and apply recommended configuration for monitors connected with your system" script = "monitor-control/auto_detect_displays.sh" [[data.entries]] name = "Change Orientation" -description = "This utility is designed to change the orientation of monitors in your system" +description = "This script is designed to change the orientation of monitors in your system" script = "monitor-control/change_orientation.sh" [[data.entries]] name = "Disable Monitor" -description = "This utility is designed to disable a monitor in your system" +description = "This script is designed to disable a monitor in your system" script = "monitor-control/disable_monitor.sh" [[data.entries]] name = "Duplicate Displays" -description = "This utility is designed to duplicate display among multi-monitor setup in your system" +description = "This script is designed to duplicate display among multi-monitor setup in your system" script = "monitor-control/duplicate_displays.sh" [[data.entries]] name = "Enable Monitor" -description = "This utility is designed to enable a monitor in your system" +description = "This script is designed to enable a monitor in your system" script = "monitor-control/enable_monitor.sh" [[data.entries]] name = "Extend Displays" -description = "This utility is designed to extend display among multi-monitor setup in your system" +description = "This script is designed to extend display among multi-monitor setup in your system" script = "monitor-control/extend_displays.sh" [[data.entries]] name = "Manage Arrangement" -description = "This utility is designed to arrange monitors in multi-monitor setup in your system" +description = "This script is designed to arrange monitors in multi-monitor setup in your system" script = "monitor-control/manage_arrangement.sh" [[data.entries]] name = "Reset Scaling" -description = "This utility is designed to reset scaling of a monitor in your system" +description = "This script is designed to reset scaling of a monitor in your system" script = "monitor-control/reset_scaling.sh" matches = true [[data.entries]] name = "Scale Monitors" -description = "This utility is designed to change the scaling of monitors in your system" +description = "This script is designed to change the scaling of monitors in your system" script = "monitor-control/scale_monitor.sh" [[data.entries]] name = "Set Brightness" script = "monitor-control/set_brightness.sh" +description = "This script is designed to change the Brightness of monitors connected to your system" matches = true [[data.entries]] name = "Set Primary Monitor" -description = "This utility is designed to set a Primary monitor in your system" +description = "This script is designed to set a Primary monitor in your system" script = "monitor-control/set_primary_monitor.sh" +[[data.entries]] +name = "Set Resolution" +description = "This script is designed to change the resolution of monitors connected to your system" +script = "monitor-control/set_resolutions.sh" + [[data]] name = "User Account Manager" From 2f4f703fe666add40b5f84db8a501fc95bd755e1 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Thu, 3 Oct 2024 12:13:46 +0200 Subject: [PATCH 08/23] suggestions by @nnyyxxxx Co-authored-by: nyx --- core/tabs/system-setup/system-cleanup.sh | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/core/tabs/system-setup/system-cleanup.sh b/core/tabs/system-setup/system-cleanup.sh index cc14d0a4..0a625913 100644 --- a/core/tabs/system-setup/system-cleanup.sh +++ b/core/tabs/system-setup/system-cleanup.sh @@ -23,8 +23,7 @@ cleanup_system() { ;; pacman) "$ESCALATION_TOOL" "$PACKAGER" -Sc --noconfirm - # -Rns will return 1 if there are no packages provided - "$PACKAGER" -Qtdq | "$ESCALATION_TOOL" "$PACKAGER" -Rns --noconfirm - > /dev/null 2>&1 || true + "$ESCALATION_TOOL" "$PACKAGER" -Rns $(pacman -Qtdq) --noconfirm > /dev/null 2>&1 ;; *) printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" From ec720050367512889f030d218f0bf07d0af70dc9 Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Thu, 3 Oct 2024 23:54:32 +0530 Subject: [PATCH 09/23] Remove install fonts vhs action downloads jetbrains mono nf by default --- .github/workflows/linutil.yml | 1 - 1 file changed, 1 deletion(-) diff --git a/.github/workflows/linutil.yml b/.github/workflows/linutil.yml index 4c58a08b..53c43d02 100644 --- a/.github/workflows/linutil.yml +++ b/.github/workflows/linutil.yml @@ -97,7 +97,6 @@ jobs: uses: charmbracelet/vhs-action@v2.1.0 with: path: "docs/assets/preview.tape" - install-fonts: "true" - name: Move preview run: | From 6bec5f82837978a58f476dd6cc602d8aa568c984 Mon Sep 17 00:00:00 2001 From: Carter Canedy Date: Tue, 24 Sep 2024 09:08:05 -0700 Subject: [PATCH 10/23] make shellcheck emit all errors found and check for tab indentation --- .github/workflows/shellcheck.yml | 43 +++++++++++++++++++++++++------- 1 file changed, 34 insertions(+), 9 deletions(-) diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml index e91ad941..b8d03ab8 100644 --- a/.github/workflows/shellcheck.yml +++ b/.github/workflows/shellcheck.yml @@ -14,17 +14,42 @@ jobs: - uses: actions/checkout@v4 - run: git fetch origin ${{ github.base_ref }} - - name: Download and set up shellcheck + - name: Download, setup, and run ShellCheck + shell: bash {0} run : | - wget https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz - tar -xf shellcheck-v0.10.0.linux.x86_64.tar.xz - cd shellcheck-v0.10.0 - chmod +x shellcheck + SC_URL="https://github.com/koalaman/shellcheck/releases/download/v0.10.0/shellcheck-v0.10.0.linux.x86_64.tar.xz" + curl -fsSL "$SC_URL" | tar -Jx + chmod +x "./shellcheck-v0.10.0/shellcheck" - - name: Run shellcheck - run: | - for file in $(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs); do + error=0 + files_to_check=$(git diff --name-only origin/${{ github.base_ref }} HEAD core/tabs) + + for file in $files_to_check; do if [[ "$file" == *.sh ]] && [[ -f "$file" ]]; then - ./shellcheck-v0.10.0/shellcheck -S error "$file" + sc_output=$(./shellcheck-v0.10.0/shellcheck -fgcc -Serror "$file") + iter_safe_parsed_errors=$(echo -e "$sc_output" | sed -n 's/\(.\+\)\:\([0-9]\+\)\:\([0-9]\+\)\: \(.*\)/::error file=\1,line=\2,col=\3::\4/p' | sed 's/ /:space:/g') + + for error in $iter_safe_parsed_errors; do + echo "$error" | sed 's/:space:/ /g' + error=1 + done + + tabs_detected=$(grep -nP '^\t+\S+' "$file") + + # fast fail on the action runner would fail immediately if there weren't any tabs found + # this check makes sure that we don't continue if there's something really weird going on + if [ "$?" = "2" ]; then + echo "::error file=$file::There was a critical while grepping $file, aborting" + exit 1 + fi + + iter_safe_parsed_tabs_detected=$(echo "$tabs_detected" | sed -n 's,\([0-9]\+\).*,::error file='"$file"'\,line=\1::Found tab indentations,p' | sed 's/ /:space:/g') + + for error in $iter_safe_parsed_tabs_detected; do + echo "$error" | sed 's/:space:/ /g' + error=1 + done fi done + + exit $error From 73f6e24396e8392bf64f18857f18bbebf696f10f Mon Sep 17 00:00:00 2001 From: Carter Canedy Date: Wed, 2 Oct 2024 12:59:04 -0700 Subject: [PATCH 11/23] expand tabs with spaces --- .../Developer-tools/sublime-setup.sh | 62 +++++++++---------- core/tabs/system-setup/arch/server-setup.sh | 8 +-- start.sh | 4 +- 3 files changed, 37 insertions(+), 37 deletions(-) diff --git a/core/tabs/applications-setup/Developer-tools/sublime-setup.sh b/core/tabs/applications-setup/Developer-tools/sublime-setup.sh index 0bbe87b7..16c03497 100644 --- a/core/tabs/applications-setup/Developer-tools/sublime-setup.sh +++ b/core/tabs/applications-setup/Developer-tools/sublime-setup.sh @@ -3,37 +3,37 @@ . ../../common-script.sh installSublime() { - if ! command_exists sublime; then - printf "%b\n" "${YELLOW}Installing Sublime...${RC}" - case "$PACKAGER" in - apt-get|nala) - curl -fsSL https://download.sublimetext.com/sublimehq-pub.gpg | "$ESCALATION_TOOL" apt-key add - - echo "deb https://download.sublimetext.com/ apt/stable/" | "$ESCALATION_TOOL" tee /etc/apt/sources.list.d/sublime-text.list - "$ESCALATION_TOOL" "$PACKAGER" update - "$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text - ;; - zypper) - "$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg - "$ESCALATION_TOOL" "$PACKAGER" addrepo -g -f https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo - "$ESCALATION_TOOL" "$PACKAGER" refresh - "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install sublime-text - ;; - pacman) - "$AUR_HELPER" -S --needed --noconfirm sublime-text-4 - ;; - dnf) - "$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg - "$ESCALATION_TOOL" "$PACKAGER" config-manager --add-repo https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo - "$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text - ;; - *) - printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" - exit 1 - ;; - esac - else - printf "%b\n" "${GREEN}Sublime is already installed.${RC}" - fi + if ! command_exists sublime; then + printf "%b\n" "${YELLOW}Installing Sublime...${RC}" + case "$PACKAGER" in + apt-get|nala) + curl -fsSL https://download.sublimetext.com/sublimehq-pub.gpg | "$ESCALATION_TOOL" apt-key add - + echo "deb https://download.sublimetext.com/ apt/stable/" | "$ESCALATION_TOOL" tee /etc/apt/sources.list.d/sublime-text.list + "$ESCALATION_TOOL" "$PACKAGER" update + "$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text + ;; + zypper) + "$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg + "$ESCALATION_TOOL" "$PACKAGER" addrepo -g -f https://download.sublimetext.com/rpm/dev/x86_64/sublime-text.repo + "$ESCALATION_TOOL" "$PACKAGER" refresh + "$ESCALATION_TOOL" "$PACKAGER" --non-interactive install sublime-text + ;; + pacman) + "$AUR_HELPER" -S --needed --noconfirm sublime-text-4 + ;; + dnf) + "$ESCALATION_TOOL" rpm -v --import https://download.sublimetext.com/sublimehq-rpm-pub.gpg + "$ESCALATION_TOOL" "$PACKAGER" config-manager --add-repo https://download.sublimetext.com/rpm/stable/x86_64/sublime-text.repo + "$ESCALATION_TOOL" "$PACKAGER" install -y sublime-text + ;; + *) + printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" + exit 1 + ;; + esac + else + printf "%b\n" "${GREEN}Sublime is already installed.${RC}" + fi } diff --git a/core/tabs/system-setup/arch/server-setup.sh b/core/tabs/system-setup/arch/server-setup.sh index 4ae0afd6..e2600205 100755 --- a/core/tabs/system-setup/arch/server-setup.sh +++ b/core/tabs/system-setup/arch/server-setup.sh @@ -466,7 +466,7 @@ if [[ $TOTAL_MEM -lt 8000000 ]]; then mkswap /mnt/opt/swap/swapfile swapon /mnt/opt/swap/swapfile # The line below is written to /mnt/ but doesn't contain /mnt/, since it's just / for the system itself. - echo "/opt/swap/swapfile none swap sw 0 0" >> /mnt/etc/fstab # Add swap to fstab, so it KEEPS working after installation. + echo "/opt/swap/swapfile none swap sw 0 0" >> /mnt/etc/fstab # Add swap to fstab, so it KEEPS working after installation. fi gpu_type=$(lspci | grep -E "VGA|3D|Display") @@ -493,8 +493,8 @@ nc=$(grep -c ^processor /proc/cpuinfo) echo -ne " ------------------------------------------------------------------------- You have " $nc" cores. And - changing the makeflags for " $nc" cores. Aswell as - changing the compression settings. + changing the makeflags for " $nc" cores. Aswell as + changing the compression settings. ------------------------------------------------------------------------- " TOTAL_MEM=$(cat /proc/meminfo | grep -i 'memtotal' | grep -o '[[:digit:]]*') @@ -670,4 +670,4 @@ sed -i 's/^%wheel ALL=(ALL:ALL) NOPASSWD: ALL/# %wheel ALL=(ALL:ALL) NOPASSWD: A # Add sudo rights sed -i 's/^# %wheel ALL=(ALL) ALL/%wheel ALL=(ALL) ALL/' /etc/sudoers sed -i 's/^# %wheel ALL=(ALL:ALL) ALL/%wheel ALL=(ALL:ALL) ALL/' /etc/sudoers -EOF \ No newline at end of file +EOF diff --git a/start.sh b/start.sh index fd69cbec..3c412fb6 100755 --- a/start.sh +++ b/start.sh @@ -14,8 +14,8 @@ check() { exit 1 fi - unset exit_code - unset message + unset exit_code + unset message } findArch() { From 0e14d3a9dbbbf1291c0ef9956ffb7bd81fe7a7c2 Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Fri, 4 Oct 2024 16:09:41 +0530 Subject: [PATCH 12/23] Add command_exists for snap --- core/tabs/system-setup/remove-snaps.sh | 44 ++++++++++++++------------ 1 file changed, 23 insertions(+), 21 deletions(-) diff --git a/core/tabs/system-setup/remove-snaps.sh b/core/tabs/system-setup/remove-snaps.sh index 6ea82934..03913ba7 100644 --- a/core/tabs/system-setup/remove-snaps.sh +++ b/core/tabs/system-setup/remove-snaps.sh @@ -3,27 +3,29 @@ . ../common-script.sh removeSnaps() { - case "$PACKAGER" in - pacman) - "$ESCALATION_TOOL" "$PACKAGER" -Rns snapd - ;; - apt-get|nala) - "$ESCALATION_TOOL" "$PACKAGER" autoremove --purge snapd - if [ "$ID" = ubuntu ]; then - "$ESCALATION_TOOL" apt-mark hold snapd - fi - ;; - dnf) - "$ESCALATION_TOOL" "$PACKAGER" remove snapd - ;; - zypper) - "$ESCALATION_TOOL" "$PACKAGER" remove snapd - ;; - *) - printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" - exit 1 - ;; - esac + if command_exists snap; then + case "$PACKAGER" in + pacman) + "$ESCALATION_TOOL" "$PACKAGER" -Rns snapd + ;; + apt-get|nala) + "$ESCALATION_TOOL" "$PACKAGER" autoremove --purge snapd + if [ "$ID" = ubuntu ]; then + "$ESCALATION_TOOL" apt-mark hold snapd + fi + ;; + dnf|zypper) + "$ESCALATION_TOOL" "$PACKAGER" remove snapd + ;; + *) + printf "%b\n" "${RED}Unsupported package manager: ""$PACKAGER""${RC}" + exit 1 + ;; + esac + printf "%b\n" "${GREEN}Successfully removed snaps...${RC}" + else + printf "%b\n" "${GREEN}Snap is not installed...${RC}" + fi } checkEnv From d462f41c8cb4a3f6283acb61889b7de85ce9501c Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Fri, 4 Oct 2024 16:36:06 +0530 Subject: [PATCH 13/23] Update core/tabs/system-setup/remove-snaps.sh Co-authored-by: Nyx <144965845+nnyyxxxx@users.noreply.github.com> --- core/tabs/system-setup/remove-snaps.sh | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/core/tabs/system-setup/remove-snaps.sh b/core/tabs/system-setup/remove-snaps.sh index 03913ba7..871679b5 100644 --- a/core/tabs/system-setup/remove-snaps.sh +++ b/core/tabs/system-setup/remove-snaps.sh @@ -24,7 +24,7 @@ removeSnaps() { esac printf "%b\n" "${GREEN}Successfully removed snaps...${RC}" else - printf "%b\n" "${GREEN}Snap is not installed...${RC}" + printf "%b\n" "${GREEN}Snapd is not installed...${RC}" fi } From 976d708c7f3fa15c23c7561d719913529ddd3e7a Mon Sep 17 00:00:00 2001 From: JEEVITHA KANNAN K S Date: Fri, 4 Oct 2024 22:59:28 +0530 Subject: [PATCH 14/23] Apply suggestions from code review Co-authored-by: Adam Perkowski --- core/tabs/system-setup/remove-snaps.sh | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/core/tabs/system-setup/remove-snaps.sh b/core/tabs/system-setup/remove-snaps.sh index 871679b5..a46ef323 100644 --- a/core/tabs/system-setup/remove-snaps.sh +++ b/core/tabs/system-setup/remove-snaps.sh @@ -22,9 +22,9 @@ removeSnaps() { exit 1 ;; esac - printf "%b\n" "${GREEN}Successfully removed snaps...${RC}" + printf "%b\n" "${GREEN}Successfully removed snaps.${RC}" else - printf "%b\n" "${GREEN}Snapd is not installed...${RC}" + printf "%b\n" "${GREEN}Snapd is not installed.${RC}" fi } From af9453cc17dcf9bb69335ab1985b3295e7fac0e0 Mon Sep 17 00:00:00 2001 From: cartercanedy <99052281+cartercanedy@users.noreply.github.com> Date: Sat, 5 Oct 2024 19:45:06 -0700 Subject: [PATCH 15/23] fix grammar --- .github/workflows/shellcheck.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/shellcheck.yml b/.github/workflows/shellcheck.yml index b8d03ab8..6b1ad429 100644 --- a/.github/workflows/shellcheck.yml +++ b/.github/workflows/shellcheck.yml @@ -39,7 +39,7 @@ jobs: # fast fail on the action runner would fail immediately if there weren't any tabs found # this check makes sure that we don't continue if there's something really weird going on if [ "$?" = "2" ]; then - echo "::error file=$file::There was a critical while grepping $file, aborting" + echo "::error file=$file::There was a critical error while grepping $file, aborting" exit 1 fi From 1e92f48c61be1a0419fee4b0275a92db98d9e359 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 8 Oct 2024 15:59:21 -0500 Subject: [PATCH 16/23] Bump tree-sitter-highlight from 0.23.0 to 0.24.2 (#780) Bumps [tree-sitter-highlight](https://github.com/tree-sitter/tree-sitter) from 0.23.0 to 0.24.2. - [Release notes](https://github.com/tree-sitter/tree-sitter/releases) - [Changelog](https://github.com/tree-sitter/tree-sitter/blob/master/CHANGELOG.md) - [Commits](https://github.com/tree-sitter/tree-sitter/compare/v0.23.0...v0.24.2) --- updated-dependencies: - dependency-name: tree-sitter-highlight dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Cargo.lock | 28 ++++++++++++++++++---------- tui/Cargo.toml | 2 +- 2 files changed, 19 insertions(+), 11 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 81750251..4de535e9 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -165,9 +165,9 @@ dependencies = [ [[package]] name = "cc" -version = "1.1.18" +version = "1.1.28" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b62ac837cdb5cb22e10a256099b4fc502b1dfe560cb282963a974d7abd80e476" +checksum = "2e80e3b6a3ab07840e1cae9b0666a63970dc28e8ed5ffbcdacbfc760c281bfc1" dependencies = [ "shlex", ] @@ -972,6 +972,12 @@ version = "1.1.0" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "a2eb9349b6444b326872e140eb1cf5e7c522154d69e7a0ffb0fb81c06b37543f" +[[package]] +name = "streaming-iterator" +version = "0.1.9" +source = "registry+https://github.com/rust-lang/crates.io-index" +checksum = "2b2231b7c3057d5e4ad0156fb3dc807d900806020c5ffa3ee6ff2c8c76fb8520" + [[package]] name = "strsim" version = "0.11.1" @@ -1028,18 +1034,18 @@ dependencies = [ [[package]] name = "thiserror" -version = "1.0.63" +version = "1.0.64" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "c0342370b38b6a11b6cc11d6a805569958d54cfa061a29969c3b5ce2ea405724" +checksum = "d50af8abc119fb8bb6dbabcfa89656f46f84aa0ac7688088608076ad2b459a84" dependencies = [ "thiserror-impl", ] [[package]] name = "thiserror-impl" -version = "1.0.63" +version = "1.0.64" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "a4558b58466b9ad7ca0f102865eccc95938dca1a74a856f2b57b6629050da261" +checksum = "08904e7672f5eb876eaaf87e0ce17857500934f4981c4a0ab2b4aa98baac7fc3" dependencies = [ "proc-macro2", "quote", @@ -1082,13 +1088,14 @@ dependencies = [ [[package]] name = "tree-sitter" -version = "0.23.0" +version = "0.24.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "20f4cd3642c47a85052a887d86704f4eac272969f61b686bdd3f772122aabaff" +checksum = "23b84f60031bf8245b563a80c92c1034e557a914f7958f474bc0afa2eed78b98" dependencies = [ "cc", "regex", "regex-syntax", + "streaming-iterator", "tree-sitter-language", ] @@ -1104,12 +1111,13 @@ dependencies = [ [[package]] name = "tree-sitter-highlight" -version = "0.23.0" +version = "0.24.2" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "395d7a477a4504fd7d5e4d003e0dd41bd5b9c4985d53592a943a8354ec452dae" +checksum = "5c727fb31f816c09fc54dc0e971d101318926866f7261b2acb820e84a61bf52d" dependencies = [ "lazy_static", "regex", + "streaming-iterator", "thiserror", "tree-sitter", ] diff --git a/tui/Cargo.toml b/tui/Cargo.toml index 662b7a17..a7f892b5 100644 --- a/tui/Cargo.toml +++ b/tui/Cargo.toml @@ -26,7 +26,7 @@ temp-dir = "0.1.14" unicode-width = "0.2.0" rand = { version = "0.8.5", optional = true } linutil_core = { path = "../core", version = "24.9.28" } -tree-sitter-highlight = "0.23.0" +tree-sitter-highlight = "0.24.2" tree-sitter-bash = "0.23.1" anstyle = "1.0.8" ansi-to-tui = "6.0.0" From cab73530fefe65a1ddcea4fe0329427f0807b61b Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Tue, 8 Oct 2024 16:00:01 -0500 Subject: [PATCH 17/23] Bump clap from 4.5.18 to 4.5.19 (#781) Bumps [clap](https://github.com/clap-rs/clap) from 4.5.18 to 4.5.19. - [Release notes](https://github.com/clap-rs/clap/releases) - [Changelog](https://github.com/clap-rs/clap/blob/master/CHANGELOG.md) - [Commits](https://github.com/clap-rs/clap/compare/clap_complete-v4.5.18...clap_complete-v4.5.19) --- updated-dependencies: - dependency-name: clap dependency-type: direct:production update-type: version-update:semver-patch ... Signed-off-by: dependabot[bot] Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --- Cargo.lock | 8 ++++---- tui/Cargo.toml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/Cargo.lock b/Cargo.lock index 4de535e9..35864b5c 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -194,9 +194,9 @@ dependencies = [ [[package]] name = "clap" -version = "4.5.18" +version = "4.5.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "b0956a43b323ac1afaffc053ed5c4b7c1f1800bacd1683c353aabbb752515dd3" +checksum = "7be5744db7978a28d9df86a214130d106a89ce49644cbc4e3f0c22c3fba30615" dependencies = [ "clap_builder", "clap_derive", @@ -204,9 +204,9 @@ dependencies = [ [[package]] name = "clap_builder" -version = "4.5.18" +version = "4.5.19" source = "registry+https://github.com/rust-lang/crates.io-index" -checksum = "4d72166dd41634086d5803a47eb71ae740e61d84709c36f3c34110173db3961b" +checksum = "a5fbc17d3ef8278f55b282b2a2e75ae6f6c7d4bb70ed3d0382375104bfafdb4b" dependencies = [ "anstream", "anstyle", diff --git a/tui/Cargo.toml b/tui/Cargo.toml index a7f892b5..ea777ffd 100644 --- a/tui/Cargo.toml +++ b/tui/Cargo.toml @@ -15,7 +15,7 @@ default = ["tips"] tips = ["rand"] [dependencies] -clap = { version = "4.5.18", features = ["derive"] } +clap = { version = "4.5.19", features = ["derive"] } crossterm = "0.28.1" ego-tree = { workspace = true } oneshot = "0.1.8" From e6172ccec79f98a39f5985676e7bb7262bea573e Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Tue, 8 Oct 2024 23:02:34 +0200 Subject: [PATCH 18/23] =?UTF-8?q?=F0=9F=93=83=20fix(grub-theme):=20theme?= =?UTF-8?q?=20backup=20(#740)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * dir backup * - * suggestions by @nnyyxxxx Co-authored-by: nyx --------- Co-authored-by: nyx --- core/tabs/applications-setup/grub-theme.sh | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/core/tabs/applications-setup/grub-theme.sh b/core/tabs/applications-setup/grub-theme.sh index d0b35420..9b79b39b 100644 --- a/core/tabs/applications-setup/grub-theme.sh +++ b/core/tabs/applications-setup/grub-theme.sh @@ -4,8 +4,12 @@ themeinstall(){ mkdir -p "$HOME/.local/share" - cd "$HOME/.local/share" && git clone "https://github.com/ChrisTitusTech/Top-5-Bootloader-Themes" - cd "$HOME/.local/share/Top-5-Bootloader-Themes" + cd "$HOME/.local/share" + if [ -d 'Top-5-Bootloader-Themes' ]; then + rm -rf 'Top-5-Bootloader-Themes' + fi + git clone "https://github.com/ChrisTitusTech/Top-5-Bootloader-Themes" + cd "Top-5-Bootloader-Themes" "$ESCALATION_TOOL" ./install.sh } From 01d571fc9e5cd2f2be6dfde1cab018eb9dbc6636 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Tue, 8 Oct 2024 23:12:47 +0200 Subject: [PATCH 19/23] =?UTF-8?q?=F0=9F=93=94=20docs:=20auto=20generation?= =?UTF-8?q?=20(#784)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * remove contributing guidelines duplicate `docs/contributing.md` is now auto generated * Commit Contributing Guidelines * core `xtask` functionality * almost there * write panic * almost almost there * there. * remove empty descriptions * better contributing.md comment * Commit Contributing Guidelines * remove entries without descriptions --------- Co-authored-by: adamperkowski --- .cargo/config.toml | 2 + .github/mkdocs.yml | 4 +- .github/workflows/github-pages.yml | 11 ++ .github/workflows/xtask.yml | 56 +++++++ Cargo.lock | 7 + Cargo.toml | 4 +- docs/{contribute.md => contributing.md} | 16 +- docs/userguide.md | 196 ++++++++++++++++-------- xtask/Cargo.toml | 8 + xtask/src/docgen.rs | 60 ++++++++ xtask/src/main.rs | 40 +++++ xtask/src/path.rs | 12 ++ 12 files changed, 344 insertions(+), 72 deletions(-) create mode 100644 .cargo/config.toml create mode 100644 .github/workflows/xtask.yml rename docs/{contribute.md => contributing.md} (82%) create mode 100644 xtask/Cargo.toml create mode 100644 xtask/src/docgen.rs create mode 100644 xtask/src/main.rs create mode 100644 xtask/src/path.rs diff --git a/.cargo/config.toml b/.cargo/config.toml new file mode 100644 index 00000000..35049cbc --- /dev/null +++ b/.cargo/config.toml @@ -0,0 +1,2 @@ +[alias] +xtask = "run --package xtask --" diff --git a/.github/mkdocs.yml b/.github/mkdocs.yml index b0453a8e..9f7e0038 100644 --- a/.github/mkdocs.yml +++ b/.github/mkdocs.yml @@ -6,7 +6,7 @@ nav: - Introduction: 'index.md' - User Guide: 'userguide.md' - Contributing: - - Contributing Guide: 'contribute.md' + - Contributing Guide: 'contributing.md' - Roadmap: 'roadmap.md' - Documentation: - Known Issues: 'KnownIssues.md' @@ -86,4 +86,4 @@ plugins: minify_html: true htmlmin_opts: remove_comments: true - cache_safe: true \ No newline at end of file + cache_safe: true diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml index 0bd2d476..b76b092d 100644 --- a/.github/workflows/github-pages.yml +++ b/.github/workflows/github-pages.yml @@ -20,6 +20,17 @@ jobs: with: fetch-depth: '0' # Fetch all commit history for all branches as well as tags. + - name: Copy Contributing Guidelines + run: | + echo "\n\n$(cat .github/CONTRIBUTING.md)" > 'docs/contributing.md' + + - uses: stefanzweifel/git-auto-commit-action@v5 + with: + commit_message: Commit Contributing Guidelines + file_pattern: "docs/contributing.md" + add_options: '--force' + if: success() + - name: Setup Python uses: actions/setup-python@v5 with: diff --git a/.github/workflows/xtask.yml b/.github/workflows/xtask.yml new file mode 100644 index 00000000..8c1d4b4e --- /dev/null +++ b/.github/workflows/xtask.yml @@ -0,0 +1,56 @@ +name: XTasks + +on: + pull_request: + paths: + - "xtask" + - "Cargo.toml" + - "Cargo.lock" + - ".cargo" + - "core/tabs" + push: + paths: + - "xtask" + - "Cargo.toml" + - "Cargo.lock" + - ".cargo" + - "core/tabs" + +env: + CARGO_TERM_COLOR: always + +jobs: + docgen: + name: DocGen + runs-on: ubuntu-latest + + steps: + - name: Checkout sources + uses: actions/checkout@v4 + + - name: Install Rust + uses: dtolnay/rust-toolchain@stable + + - name: Cache Cargo registry + uses: actions/cache@v4 + with: + path: ~/.cargo/registry + key: ${{ runner.os }}-cargo-registry-${{ hashFiles('**/Cargo.lock') }} + restore-keys: ${{ runner.os }}-cargo-registry- + + - name: Cache Cargo index + uses: actions/cache@v4 + with: + path: ~/.cargo/git + key: ${{ runner.os }}-cargo-index-${{ hashFiles('**/Cargo.lock') }} + restore-keys: ${{ runner.os }}-cargo-index- + + - name: Run cargo xtask docgen + run: cargo xtask docgen + + - name: Check uncommitted documentation changes + run: | + git diff + git diff-files --quiet \ + || (echo "Run 'cargo xtask docgen' and push the changes" \ + && exit 1) diff --git a/Cargo.lock b/Cargo.lock index 35864b5c..266ed837 100644 --- a/Cargo.lock +++ b/Cargo.lock @@ -1418,6 +1418,13 @@ version = "0.0.19" source = "registry+https://github.com/rust-lang/crates.io-index" checksum = "d135d17ab770252ad95e9a872d365cf3090e3be864a34ab46f48555993efc904" +[[package]] +name = "xtask" +version = "24.9.28" +dependencies = [ + "linutil_core", +] + [[package]] name = "zerocopy" version = "0.7.35" diff --git a/Cargo.toml b/Cargo.toml index cf43a012..ef31b2a9 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -1,12 +1,14 @@ [workspace.package] license = "MIT" version = "24.9.28" +edition = "2021" [workspace.dependencies] ego-tree = "0.6.2" [workspace] -members = ["tui", "core"] +members = ["tui", "core", "xtask"] +default-members = ["tui", "core"] resolver = "2" [patch.crates-io] diff --git a/docs/contribute.md b/docs/contributing.md similarity index 82% rename from docs/contribute.md rename to docs/contributing.md index e47f8172..4e20b7b7 100644 --- a/docs/contribute.md +++ b/docs/contributing.md @@ -1,4 +1,4 @@ -# How to Contribute? +\n\n# Contributing Guidelines for Linutil Thank you for considering contributing to Linutil! We appreciate your effort in helping improve this project. To ensure that your contributions align with the goals and quality standards of Linutil, please follow these guidelines: @@ -40,22 +40,28 @@ cd linutil - **Make small, targeted PRs**: Focus on one feature or fix per pull request. This makes it easier to review and increases the likelihood of acceptance. - **Avoid combining unrelated changes**: PRs that tackle multiple unrelated issues are harder to review and might be rejected because of a single problem. -## 8. Code Review and Feedback +## 8. Understand and Test the Code You Write + +- **Review your code**: Before submitting your changes, take the time to review your code for readability, efficiency and performance. Consider how your changes affect the project. +- **Avoid using LLMs**: Don't submit AI-generated code without reviewing and testing it first. Ensure that any code you submit is thoroughly understood and meets the project's standards. +- **Testing Requirements**: Failure to conduct testing after multiple requests may result in the closure of your Pull Request. + +## 9. Code Review and Feedback - **Expect feedback**: PRs will undergo code review. Be open to feedback and willing to make adjustments as needed. - **Participate in reviews**: If you feel comfortable, review other contributors' PRs as well. Peer review is a great way to learn and ensure high-quality contributions. -## 9. Contributing Is More Than Just Code +## 10. Contributing Is More Than Just Code - **Test the tool**: Running tests and providing feedback on how the tool works in different environments is a valuable contribution. - **Write well-formed issues**: Clearly describe bugs or problems you encounter, providing as much detail as possible, including steps to reproduce the issue. - **Propose reasonable feature requests**: When suggesting new features, ensure they fit within the scope, style, and design of the project. Provide clear reasoning and use cases. -## 10. Documentation +## 11. Documentation - **Update the documentation**: If your change affects the functionality, please update the relevant documentation files to reflect this. -## 11. License +## 12. License - **Agree to the license**: By contributing to Linutil, you agree that your contributions will be licensed under the project's MIT license. diff --git a/docs/userguide.md b/docs/userguide.md index ede99331..a4ee3c84 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -1,81 +1,149 @@ + # Walkthrough ---- - -## System Setup - -- **System Update**: Starts a system-wide update. -- **Compile Setup**: Installs tools and dependencies for compiling software. -- **Gaming Setup**: Configures Steam, Lutris, etc. -- **Global Theming**: Sets up and manages global themes. -- **Remove Snaps**: Removes snap packages. -- **TTY Fonts**: This Script will set the default TTY font to Terminus size 32 Bold - -### Arch Setup - -- **Paru Setup**: Installs the Paru AUR helper. -- **Yay Setup**: Installs the Yay AUR helper. -- **Server Setup**: Installs Arch Linux. - -### Fedora Setup - -- **RPM Fusion Setup**: Adds RPM Fusion free and nonfree repositories. -- **Multimedia Codecs**: Installs multimedia codecs and updates multimedia-related packages. Requires RPM Fusion repositories to be set up first. -- **NVIDIA Proprietary Driver Setup**: Installs proprietary NVIDIA drivers for GPUs from 2014 or later. -- **Virtualization Setup**: Installs virtualization tools. -- **Configure DNF**: Optimizes DNF for better speeds. ## Applications Setup -- **Flathub**: Installs Flatpak and Flathub. -- **Alacritty Setup**: Installs and configures Alacritty for you. -- **DwmTitus Setup**: Sets up the Dwm window manager. -- **Kitty Setup**: Installs and configures Kitty for you. -- **Rofi Setup**: Installs the Rofi application/script launcher. -- **Zsh Setup**: Installs and configures Zsh for you. -- **Fastfetch Setup**: Installs and configures Fastfetch. -- **Linutil Updater**: Updates the Linutil AUR / Crates.io Package. -- **Linutil Installer**: Installs Linutil via Crates.io or AUR. -- **Office Suite Setup**: Installs various office suites and PDF viewers (OnlyOffice, LibreOffice, WPS Office, FreeOffice, Evince, Okular, PDF Studio Viewer, PDF Studio). ### Developer Tools -- **Meld Setup**: Installs Meld, a visual diff and merge tool. -- **Ngrok Setup**: Installs Ngrok, a tool for creating secure tunnels to localhost. -- **Neovim Setup**: Installs and configures Neovim, a Vim-based text editor. -- **VS Code Setup**: Installs Visual Studio Code, a popular text editor. -- **Sublime Setup**: Installs Sublime Text, a nice text editor for code and markup. -- **VS Codium Setup**: Installs VS Codium, an open-source build of VS Code. -- **GitHub Desktop Setup**: Installs GitHub Desktop, a GUI for Git and GitHub. +- **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 +- **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. +- **Meld**: Meld is a visual diff and merge tool that helps compare files, directories, and version-controlled projects. +- **Ngrok**: Ngrok is a tool that creates secure, temporary tunnels to expose local servers to the internet for testing and development. -## Security Features +### Communication Apps -- **Firewall Baselines**: Sets up firewall rules. +- **Discord**: Discord is a versatile communication platform for gamers and communities, offering voice, video, and text chat features. +- **Jitsi**: Jitsi Meet is an open-source video conferencing tool that allows users to host and join secure meetings directly from their web browsers without the need for downloads. +- **Signal**: Signal is a privacy-focused messaging app that provides end-to-end encryption for secure text, voice, and video communication. +- **Slack**: Slack is a collaboration platform designed for team communication, featuring channels, direct messaging, file sharing, and integrations with various productivity tools. +- **Telegram**: Telegram is a cloud-based messaging app known for its speed and security, offering features like group chats, channels, and end-to-end encrypted calls. +- **Zoom**: Zoom is a widely-used video conferencing platform that allows users to host virtual meetings, webinars, and online collaboration with features like screen sharing and recording. +- **Thunderbird**: Thunderbird is a free, open-source email client that offers powerful features like customizable email management, a built-in calendar, and extensive add-ons for enhanced functionality. + +### Office Suites + + +### PDF Suites + + +### Web Browsers + +- **Brave**: Brave is a free and open-source web browser developed by Brave Software, Inc. based on the Chromium web browser. +- **Chromium**: Chromium is an open-source web browser project started by Google, to provide the source code for the proprietary Google Chrome browser. +- **Google Chrome**: Google Chrome is a fast, secure, and free web browser, built for the modern web. +- **LibreWolf**: LibreWolf is a fork of Firefox, focused on privacy, security, and freedom. +- **Lynx**: Lynx is a highly configurable text-based web browser for use on cursor-addressable character cell terminals. +- **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. +- **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 +- **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 +- **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. +- **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 +- **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. + +## 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 + +## 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 + +## System Setup + + +### 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 + +### 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/ +- **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. +- **Full System Update**: This command updates your system to the latest packages available for your distro +- **Gaming Dependencies**: This script is designed to handle the installation of gaming dependencies across different Linux distributions +- **Global Theme**: This script is designed to handle the installation and configuration of global theming +- **Remove Snaps**: This script is designed to remove snap +- **TTY Fonts**: This Script will set the default TTY font to Terminus size 32 Bold ## Utilities -- **Wifi Control**: Controls WiFi settings. -- **Numlock Control**: Sets up Numlock on boot. -- **Bluetooth Control**: Controls Bluetooth settings. -### Monitor control +### Monitor Control -- **Reset Scaling**: Resets monitor scaling to native resolution. -- **Scale Monitor**: Scales smaller monitors to the highest resolution of a bigger monitor. -- **Enable Monitor**: Enables a selected monitor. -- **Disable Monitor**: Disables a selected monitor. -- **Set Brightness**: Adjusts brightness for a selected monitor. -- **Set Resolutions**: Sets resolutions for connected monitors. -- **Change Orientation**: Changes the orientation of a selected monitor. -- **Extend Displays**: Extends displays to the right. -- **Duplicate Displays**: Duplicates displays. -- **Manage Arrangement**: Manages the arrangement of multiple monitors. -- **Set Primary Monitor**: Sets a selected monitor as the main display. -- **Auto Detect Displays**: Sets common resolution. +- **Auto Detect Displays**: This utility is designed to detect and apply recommended configuration for monitors connected with your system +- **Change Orientation**: This utility is designed to change the orientation of monitors in your system +- **Disable Monitor**: This utility is designed to disable a monitor in your system +- **Duplicate Displays**: This utility is designed to duplicate display among multi-monitor setup in your system +- **Enable Monitor**: This utility is designed to enable a monitor in your system +- **Extend Displays**: This utility is designed to extend display among multi-monitor setup in your system +- **Manage Arrangement**: This utility is designed to arrange monitors in multi-monitor setup in your system +- **Reset Scaling**: This utility is designed to reset scaling of a monitor in your system +- **Scale Monitors**: This utility is designed to change the scaling of monitors in your system +- **Set Primary Monitor**: This utility is designed to set a Primary monitor in your system ### User Account Manager -- **Add User**: Creates a new user account. -- **Delete User**: Deletes an existing user account. -- **Add to Group**: Adds a user to specified groups. -- **Remove from Group**: Removes a user from specified groups. -- **Change Password**: Changes the password for a user account. +- **Auto Mount Drive**: This utility is designed to help with automating the process of mounting a drive on to your system. +- **Bluetooth Manager**: This utility is designed to manage bluetooth in your system +- **Numlock on Startup**: This utility is designed to configure auto enabling of numlock on boot +- **Ollama**: This utility is designed to manage ollama in your system +- **Service Manager**: This utility is designed to manage services in your system +- **WiFi Manager**: This utility is designed to manage wifi in your system diff --git a/xtask/Cargo.toml b/xtask/Cargo.toml new file mode 100644 index 00000000..277057d9 --- /dev/null +++ b/xtask/Cargo.toml @@ -0,0 +1,8 @@ +[package] +name = "xtask" +version.workspace = true +license.workspace = true +edition.workspace = true + +[dependencies] +linutil_core = { path = "../core" } diff --git a/xtask/src/docgen.rs b/xtask/src/docgen.rs new file mode 100644 index 00000000..992b83aa --- /dev/null +++ b/xtask/src/docgen.rs @@ -0,0 +1,60 @@ +use std::fs; + +use linutil_core::Command; + +use crate::path; +use crate::DynError; + +pub const USER_GUIDE: &str = "userguide.md"; + +pub fn userguide() -> Result { + let mut md = String::new(); + md.push_str("\n# Walkthrough\n"); + + let tabs = linutil_core::get_tabs(false).1; + + for tab in tabs { + #[cfg(debug_assertions)] + println!("Tab: {}", tab.name); + + md.push_str(&format!("\n## {}\n\n", tab.name)); + + for entry in tab.tree { + if entry.command == Command::None { + #[cfg(debug_assertions)] + println!(" Directory: {}", entry.name); + + if entry.name != "root".to_string() { + md.push_str(&format!("\n### {}\n\n", entry.name)); + } + + /* let current_dir = &entry.name; + + if *current_dir != "root".to_string() { + md.push_str(&format!( + "\n
{}\n\n", + current_dir + )); + } */ // Commenting this for now, might be a good idea later + } else { + if !entry.description.is_empty() { + #[cfg(debug_assertions)] + println!(" Entry: {}", entry.name); + #[cfg(debug_assertions)] + println!(" Description: {}", entry.description); + + md.push_str(&format!("- **{}**: {}\n", entry.name, entry.description)); + } /* else { + md.push_str(&format!("- **{}**\n", entry.name)); + } */ // https://github.com/ChrisTitusTech/linutil/pull/753 + } + } + } + + Ok(md) +} + +pub fn write(file: &str, data: &str) { + let path = path::docs().join(file); + fs::write(path, data).unwrap_or_else(|_| panic!("Could not write to {}", file)); +} diff --git a/xtask/src/main.rs b/xtask/src/main.rs new file mode 100644 index 00000000..fecab8c8 --- /dev/null +++ b/xtask/src/main.rs @@ -0,0 +1,40 @@ +mod docgen; +mod path; + +use std::{env, error::Error}; + +type DynError = Box; + +pub mod tasks { + use crate::docgen::USER_GUIDE; + use crate::docgen::{userguide, write}; + use crate::DynError; + + pub fn docgen() -> Result<(), DynError> { + write(USER_GUIDE, &userguide()?); + Ok(()) + } + + pub fn print_help() { + println!( + " +Usage: `cargo xtask ` + + Tasks: + docgen: Generate Markdown files. +" + ); + } +} + +fn main() -> Result<(), DynError> { + let task = env::args().nth(1); + match task { + None => tasks::print_help(), + Some(t) => match t.as_str() { + "docgen" => tasks::docgen()?, + invalid => return Err(format!("Invalid task: {}", invalid).into()), + }, + }; + Ok(()) +} diff --git a/xtask/src/path.rs b/xtask/src/path.rs new file mode 100644 index 00000000..9a3c6230 --- /dev/null +++ b/xtask/src/path.rs @@ -0,0 +1,12 @@ +use std::path::{Path, PathBuf}; + +pub fn project_root() -> PathBuf { + Path::new(env!("CARGO_MANIFEST_DIR")) + .parent() + .unwrap() + .to_path_buf() +} + +pub fn docs() -> PathBuf { + project_root().join("docs/") +} From 55b5838cb568fe2e380ba61c123f9caeb9d324be Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Tue, 8 Oct 2024 23:14:16 +0200 Subject: [PATCH 20/23] =?UTF-8?q?=F0=9F=93=94=20docs:=20add=20a=20manpage?= =?UTF-8?q?=20(#783)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📔 docs: add a manpage * 📦️ include `linutil.1` in `linutil_tui` * oopsie... * `©` -> `(c)` --- man/linutil.1 | 65 ++++++++++++++++++++++++++++++++++++++++++++++++++ tui/Cargo.toml | 2 +- 2 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 man/linutil.1 diff --git a/man/linutil.1 b/man/linutil.1 new file mode 100644 index 00000000..d31cf879 --- /dev/null +++ b/man/linutil.1 @@ -0,0 +1,65 @@ +.\" manpage for Linutil +.TH "linutil" "1" "October 2024" "" "Linutil Manual" + +.SH NAME +linutil \- Chris Titus Tech's Linux Toolbox + +.SH SYNOPSIS +\fBlinutil [OPTIONS]\fR + +.SH DESCRIPTION +Linutil is a distro-agnostic toolbox designed to simplify everyday Linux tasks. +.br +It helps you set up applications and optimize your system for specific use cases. The utility is actively developed in Rust, providing performance and reliability. + +.SH LIVE VERSION +To get started with the live version, pick which branch you would like to use, then run the command in your terminal: +.TP +\fBStable Branch\fR +curl -fsSL https://christitus.com/linux | sh +.TP +\fBDevelopement branch\fR +curl -fsSL https://christitus.com/linuxdev | sh + +.SH OPTIONS +.TP +\fB\-t\fR, \fB\-\-theme\fR \fI\fR +Set the theme to use in the TUI. +.br +Possible values: +\fIdefault\fR, +\fIcompatible\fR. +.br +Defaults to \fIdefault\fR. + +.TP +\fB\-\-override\-validation\fR +Show all available entries, disregarding compatibility checks. (\fBUNSAFE\fR) + +.TP +\fB\-h\fR, \fB\-\-help\fR +Print help. + +.SH SUPPORT +If you find Linutil helpful, please consider giving it a star on GitHub to show your support! +https://github.com/ChrisTitusTech/linutil + +.SH DOCUMENTATION +For comprehensive information on how to use Linutil, visit the Official Linutil Documentation. +https://christitustech.github.io/linutil + +.SH AUTHOR +Written by Adam Perkowski. + + +.SH REPORTING BUGS +Since the project is still in active development, you may encounter some issues. +.br +Please consider submitting feedback if you do. +https://github.com/ChrisTitusTech/linutil/issues + +.SH COPYRIGHT +Copyright (c) 2024 Chris Titus. +.br +MIT License. +https://opensource.org/license/MIT diff --git a/tui/Cargo.toml b/tui/Cargo.toml index ea777ffd..40d3c357 100644 --- a/tui/Cargo.toml +++ b/tui/Cargo.toml @@ -7,7 +7,7 @@ edition = "2021" license.workspace = true repository = "https://github.com/ChrisTitusTech/linutil/tree/main/tui" version.workspace = true -include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt"] +include = ["src/*.rs", "Cargo.toml", "build.rs", "cool_tips.txt", "../man/linutil.1"] build = "build.rs" [features] From e9d2e88bc3fae15657a52dbaf88f2b216ff921eb Mon Sep 17 00:00:00 2001 From: Chris Titus Date: Tue, 8 Oct 2024 16:39:27 -0500 Subject: [PATCH 21/23] docs update --- docs/userguide.md | 22 ++++++++++++---------- 1 file changed, 12 insertions(+), 10 deletions(-) diff --git a/docs/userguide.md b/docs/userguide.md index a4ee3c84..2b7ad82b 100644 --- a/docs/userguide.md +++ b/docs/userguide.md @@ -128,16 +128,18 @@ For more information visit: https://rpmfusion.org/ ### Monitor Control -- **Auto Detect Displays**: This utility is designed to detect and apply recommended configuration for monitors connected with your system -- **Change Orientation**: This utility is designed to change the orientation of monitors in your system -- **Disable Monitor**: This utility is designed to disable a monitor in your system -- **Duplicate Displays**: This utility is designed to duplicate display among multi-monitor setup in your system -- **Enable Monitor**: This utility is designed to enable a monitor in your system -- **Extend Displays**: This utility is designed to extend display among multi-monitor setup in your system -- **Manage Arrangement**: This utility is designed to arrange monitors in multi-monitor setup in your system -- **Reset Scaling**: This utility is designed to reset scaling of a monitor in your system -- **Scale Monitors**: This utility is designed to change the scaling of monitors in your system -- **Set Primary Monitor**: This utility is designed to set a Primary monitor in your system +- **Auto Detect Displays**: This script is designed to detect and apply recommended configuration for monitors connected with your system +- **Change Orientation**: This script is designed to change the orientation of monitors in your system +- **Disable Monitor**: This script is designed to disable a monitor in your system +- **Duplicate Displays**: This script is designed to duplicate display among multi-monitor setup in your system +- **Enable Monitor**: This script is designed to enable a monitor in your system +- **Extend Displays**: This script is designed to extend display among multi-monitor setup in your system +- **Manage Arrangement**: This script is designed to arrange monitors in multi-monitor setup in your system +- **Reset Scaling**: This script is designed to reset scaling of a monitor in your system +- **Scale Monitors**: This script is designed to change the scaling of monitors in your system +- **Set Brightness**: This script is designed to change the Brightness of monitors connected to your system +- **Set Primary Monitor**: This script is designed to set a Primary monitor in your system +- **Set Resolution**: This script is designed to change the resolution of monitors connected to your system ### User Account Manager From 3c40bb9a842a7527784c8466382fb1aeb8ba4c36 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Tue, 8 Oct 2024 23:40:15 +0200 Subject: [PATCH 22/23] =?UTF-8?q?=F0=9F=93=83=20fix(zsh-setup):=20check=20?= =?UTF-8?q?if=20`/etc/zsh/zshenv`=20exists=20(#771)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * 📃 fix(zsh-setup): check if `/etc/zsh/zshenv` exists * 📃 fix(zsh-setup): create `/env/zsh` dir Co-authored-by: nnyyxxxx --------- Co-authored-by: nnyyxxxx --- core/tabs/applications-setup/zsh-setup.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/core/tabs/applications-setup/zsh-setup.sh b/core/tabs/applications-setup/zsh-setup.sh index 01a93c8a..a85b9240 100644 --- a/core/tabs/applications-setup/zsh-setup.sh +++ b/core/tabs/applications-setup/zsh-setup.sh @@ -44,6 +44,7 @@ RPROMPT='%F{15}(%F{166}%D{%H:%M}%F{15})%f' EOL # Ensure /etc/zsh/zshenv sets ZDOTDIR to the user's config directory + [ ! -f /etc/zsh/zshenv ] && "$ESCALATION_TOOL" mkdir -p /etc/zsh && "$ESCALATION_TOOL" touch /etc/zsh/zshenv echo "export ZDOTDIR=\"$HOME/.config/zsh\"" | "$ESCALATION_TOOL" tee -a /etc/zsh/zshenv } From 79eb7525529c405cf4cd05ee28a5aba520e81f53 Mon Sep 17 00:00:00 2001 From: Adam Perkowski Date: Wed, 9 Oct 2024 00:12:40 +0200 Subject: [PATCH 23/23] =?UTF-8?q?=F0=9F=93=94=20hotfix(ci):=20`docs/`=20in?= =?UTF-8?q?=20the=20xtasks=20CI=20(#785)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/workflows/xtask.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/xtask.yml b/.github/workflows/xtask.yml index 8c1d4b4e..fab93937 100644 --- a/.github/workflows/xtask.yml +++ b/.github/workflows/xtask.yml @@ -8,6 +8,7 @@ on: - "Cargo.lock" - ".cargo" - "core/tabs" + - "docs" push: paths: - "xtask" @@ -15,6 +16,7 @@ on: - "Cargo.lock" - ".cargo" - "core/tabs" + - "docs" env: CARGO_TERM_COLOR: always