Merge branch 'main' into ui-minimum-size

ChrisTitusTech · web-flow · commit 61ac38481b89 · 2024-09-16T16:29:37.000-05:00
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
diff --git a/.github/mkdocs.yml b/.github/mkdocs.yml
@@ -5,7 +5,9 @@ docs_dir: '../docs'
 nav:
   - Introduction: 'index.md'
   - User Guide: 'userguide.md'
-  - Contributing Guide: 'contribute.md'
+  - Contributing:
+      - Contributing Guide: 'contribute.md'
+      - Roadmap: 'roadmap.md'
   - Documentation:
       - Known Issues: 'KnownIssues.md'
   - FAQ: 'faq.md'
diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml
@@ -1,5 +1,3 @@
-name-template: '$RESOLVED_VERSION'
-tag-template: '$RESOLVED_VERSION'
 tag-prefix: ""
 categories:
   - title: '🚀 Features'
@@ -21,10 +19,6 @@ template: |
 
   $CHANGES
 
-  ## Contributors
-
-  $CONTRIBUTORS
-
 change-title-escapes: '\<*_&"'''
 autolabeler:
   - label: 'documentation'
@@ -57,4 +51,6 @@ replacers:
   - search: /`/g
     replace: ''
 exclude-labels:
-  - 'skip-changelog'
+  - 'skip-changelog'
+
+filter-by-commitish: true
diff --git a/.github/workflows/cargo-lock.yml b/.github/workflows/cargo-lock.yml
diff --git a/.github/workflows/github-pages.yml b/.github/workflows/github-pages.yml
@@ -3,10 +3,11 @@ name: GitHub Pages Deploy
 on:
   push:
     paths:
-      - 'mkdocs.yml'
+      - '.github/mkdocs.yml'
+      - '.github/requirements.txt'
       - 'docs/**'
       - 'overrides/**'
-      - 'CONTRIBUTING.md'
+      - '.github/CONTRIBUTING.md'
   workflow_dispatch:
 
 jobs:
@@ -29,4 +30,6 @@ jobs:
         run: pip install -r .github/requirements.txt
 
       - name: Build & Deploy using mkdocs
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
         run: mkdocs gh-deploy --force -f .github/mkdocs.yml
diff --git a/.github/workflows/linutil.yml b/.github/workflows/linutil.yml
@@ -3,6 +3,7 @@ name: LinUtil Release
 on:
   push:
     branches: ["main"]
+  workflow_dispatch:
 
 permissions:
   contents: write
@@ -59,3 +60,39 @@ jobs:
           file_pattern: "build/linutil"
           add_options: '--force'
         if: success()
+
+      - name: Extract Version
+        id: extract_version
+        run: |
+          version=$(date +"%Y.%m.%d")
+          echo "version=$version" >> $GITHUB_ENV
+        shell: bash
+
+      - name: Generate Release Notes
+        id: generate_notes
+        uses: release-drafter/release-drafter@v6
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          config-name: release-drafter.yml
+          version: ${{ env.version }}
+
+      - name: Create and Upload Release
+        id: create_release
+        uses: softprops/action-gh-release@v2
+        with:
+          tag_name: ${{ env.version }}
+          name: Pre-Release ${{ env.version }}
+          body: |
+            ${{ steps.generate_notes.outputs.body }}
+            
+            ![GitHub Downloads (specific asset, specific tag)](https://img.shields.io/github/downloads/ChrisTitusTech/linutil/${{ env.version }}/linutil)
+          append_body: false
+          files: |
+            ./build/linutil
+            ./start.sh
+            ./startdev.sh
+          prerelease: true
+        env:
+          version: ${{ env.version }}
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
diff --git a/.github/workflows/pr-labels.yaml b/.github/workflows/pr-labels.yaml
@@ -0,0 +1,50 @@
+name: Manage labels based on PR body
+
+on:
+  pull_request:
+    types: [opened, edited, reopened, synchronize]
+
+jobs:
+  manage-labels:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Analyze PR Body and manage labels
+        run: |
+          body="${{ github.event.pull_request.body }}"
+          labels_to_add=()
+          labels_to_remove=()
+          declare -A label_checks=(
+            ["New feature"]="enhancement"
+            ["Bug fix|Hotfix|Security patch"]="bug"
+            ["Documentation update"]="documentation"
+            ["Refactoring"]="refactor"
+            ["UI/UX improvement"]="UI/UX"
+          )
+          for key in "${!label_checks[@]}"; do
+            if echo "$body" | grep -q "\- \[x\] $key"; then
+              labels_to_add+=("${label_checks[$key]}")
+            else
+              labels_to_remove+=("${label_checks[$key]}")
+            fi
+          done
+          echo "LABELS_TO_ADD=${labels_to_add[*]}" >> $GITHUB_ENV
+          echo "LABELS_TO_REMOVE=${labels_to_remove[*]}" >> $GITHUB_ENV
+      - name: Add labels if necessary
+        if: env.LABELS_TO_ADD != ''
+        run: |
+          for label in ${{ env.LABELS_TO_ADD }}; do
+            curl -s -X POST \
+              -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+              -H "Accept: application/vnd.github.v3+json" \
+              -d "{\"labels\": [\"$label\"]}" \
+              https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels
+          done
+      - name: Remove labels if necessary
+        if: env.LABELS_TO_REMOVE != ''
+        run: |
+          for label in ${{ env.LABELS_TO_REMOVE }}; do
+            curl -s -X DELETE \
+              -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \
+              -H "Accept: application/vnd.github.v3+json" \
+              https://api.github.com/repos/${{ github.repository }}/issues/${{ github.event.pull_request.number }}/labels/$label
+          done
diff --git a/.github/workflows/pre-release.yaml b/.github/workflows/pre-release.yaml
diff --git a/.gitignore b/.gitignore
@@ -2,3 +2,4 @@
 /build
 rust/target
 rust/build
+/build/linutil
diff --git a/README.md b/README.md
@@ -31,7 +31,9 @@ For comprehensive information on how to use Linutil, visit the [Linutil Official
 
 ## 🛠 Contributing
 
-We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](CONTRIBUTING.md) to understand how to make the most effective and efficient contributions.
+We welcome contributions from the community! Before you start, please review our [Contributing Guidelines](.github/CONTRIBUTING.md) to understand how to make the most effective and efficient contributions.
+
+[Official LinUtil Roadmap](https://christitustech.github.io/linutil/roadmap)
 
 ## 🏅 Thanks to All Contributors
 
diff --git a/build/linutil b/build/linutil
diff --git a/docs/roadmap.md b/docs/roadmap.md
diff --git a/tabs/gaming/tab_data.toml b/tabs/gaming/tab_data.toml
@@ -1,7 +1,7 @@
 name = "Gaming"
 
 [[data]]
-name = "Diablo II Ressurected"
+name = "Diablo II Resurrected"
 
 [[data.entries]]
 name = "Loot Filter Install"
diff --git a/tui/src/float.rs b/tui/src/float.rs
@@ -64,9 +64,7 @@ impl Float {
     // Returns true if the floating window is finished.
     pub fn handle_key_event(&mut self, key: &KeyEvent) -> bool {
         match key.code {
-            KeyCode::Enter | KeyCode::Char('p') | KeyCode::Esc | KeyCode::Char('q')
-                if self.content.is_finished() =>
-            {
+            KeyCode::Enter | KeyCode::Char('p') | KeyCode::Esc if self.content.is_finished() => {
                 true
             }
             _ => self.content.handle_key_event(key),
diff --git a/tui/src/main.rs b/tui/src/main.rs
@@ -14,7 +14,6 @@ use std::{
 use crate::theme::Theme;
 use clap::Parser;
 use crossterm::{
-    cursor::RestorePosition,
     event::{self, DisableMouseCapture, Event, KeyEventKind},
     style::ResetColor,
     terminal::{disable_raw_mode, enable_raw_mode, EnterAlternateScreen, LeaveAlternateScreen},
@@ -38,7 +37,7 @@ struct Args {
     override_validation: bool,
 }
 
-fn main() -> std::io::Result<()> {
+fn main() -> io::Result<()> {
     let args = Args::parse();
 
     let mut state = AppState::new(args.theme, args.override_validation);
@@ -55,8 +54,8 @@ fn main() -> std::io::Result<()> {
     terminal.backend_mut().execute(LeaveAlternateScreen)?;
     terminal.backend_mut().execute(DisableMouseCapture)?;
     terminal.backend_mut().execute(ResetColor)?;
-    terminal.backend_mut().execute(RestorePosition)?;
     terminal.show_cursor()?;
+
     Ok(())
 }
 
diff --git a/tui/src/state.rs b/tui/src/state.rs
@@ -6,7 +6,7 @@ use crate::{
     running_command::RunningCommand,
     theme::Theme,
 };
-use crossterm::event::{KeyCode, KeyEvent, KeyEventKind};
+use crossterm::event::{KeyCode, KeyEvent, KeyEventKind, KeyModifiers};
 use ego_tree::NodeId;
 use linutil_core::{Command, ListNode, Tab};
 use ratatui::{
@@ -230,6 +230,7 @@ impl AppState {
 
         draw_shortcuts(self, frame, vertical[1]);
     }
+
     pub fn handle_key(&mut self, key: &KeyEvent) -> bool {
         // This should be defined first to allow closing
         // the application even when not drawable ( If terminal is small )
@@ -250,30 +251,43 @@ impl AppState {
                     self.focus = Focus::List;
                 }
             }
+
             Focus::Search => match self.filter.handle_key(key) {
                 SearchAction::Exit => self.exit_search(),
                 SearchAction::Update => self.update_items(),
                 _ => {}
             },
+
+            _ if key.code == KeyCode::Char('q')
+                || key.code == KeyCode::Char('c')
+                    && key.modifiers.contains(KeyModifiers::CONTROL) =>
+            {
+                return false;
+            }
+
             Focus::TabList => match key.code {
                 KeyCode::Enter | KeyCode::Char('l') | KeyCode::Right | KeyCode::Tab => {
                     self.focus = Focus::List
                 }
+
                 KeyCode::Char('j') | KeyCode::Down
                     if self.current_tab.selected().unwrap() + 1 < self.tabs.len() =>
                 {
                     self.current_tab.select_next();
                     self.refresh_tab();
                 }
+
                 KeyCode::Char('k') | KeyCode::Up => {
                     self.current_tab.select_previous();
                     self.refresh_tab();
                 }
+
                 KeyCode::Char('/') => self.enter_search(),
                 KeyCode::Char('t') => self.theme.next(),
                 KeyCode::Char('T') => self.theme.prev(),
                 _ => {}
             },
+
             Focus::List if key.kind != KeyEventKind::Release => match key.code {
                 KeyCode::Char('j') | KeyCode::Down => self.selection.select_next(),
                 KeyCode::Char('k') | KeyCode::Up => self.selection.select_previous(),
@@ -292,23 +306,27 @@ impl AppState {
                 KeyCode::Char('T') => self.theme.prev(),
                 _ => {}
             },
-            _ => {}
+
+            _ => (),
         };
         true
     }
+
     fn update_items(&mut self) {
         self.filter.update_items(
             &self.tabs,
             self.current_tab.selected().unwrap(),
             *self.visit_stack.last().unwrap(),
         );
     }
+
     /// Checks ehther the current tree node is the root node (can we go up the tree or no)
     /// Returns `true` if we can't go up the tree (we are at the tree root)
     /// else returns `false`
     pub fn at_root(&self) -> bool {
         self.visit_stack.len() == 1
     }
+
     fn enter_parent_directory(&mut self) {
         self.visit_stack.pop();
         self.selection.select(Some(0));
