Merge pull request #4 from yassinebridi/1-configurable-project-root

1 configurable project root

Author: yassinebridi

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "serpl"
-version = "0.1.2"
+version = "0.1.4"
 edition = "2021"
 description = "VS Code like search and replace TUI"
 repository = "https://github.com/yassinebridi/serpl"

Cargo.toml

@@ -1,4 +1,4 @@
-use std::sync::Arc;
+use std::{path::PathBuf, sync::Arc};
 
 use color_eyre::eyre::Result;
 use crossterm::event::KeyEvent;
@@ -46,10 +46,11 @@ pub struct App {
   pub should_suspend: bool,
   pub mode: Mode,
   pub last_tick_key_events: Vec<KeyEvent>,
+  pub project_root: PathBuf,
 }
 
 impl App {
-  pub fn new(tick_rate: f64, frame_rate: f64) -> Result<Self> {
+  pub fn new(project_root: PathBuf) -> Result<Self> {
     let config = Config::new()?;
     let mode = Mode::Normal;
 
@@ -81,17 +82,22 @@ impl App {
       config,
       mode,
       last_tick_key_events: Vec::new(),
+      project_root,
     })
   }
 
   pub async fn run(&mut self) -> Result<()> {
-    let initial_state = State::new();
+    log::info!("Starting app..");
+    // log project root
+    log::info!("Project root: {:?}", self.project_root);
+    let initial_state = State::new(self.project_root.clone());
+    log::info!("Initial state: {:?}", initial_state);
     let store = Store::new_with_state(reducer, initial_state).wrap(ThunkMiddleware).await;
 
     let (action_tx, mut action_rx) = mpsc::unbounded_channel();
     let (redux_action_tx, mut redux_action_rx) = mpsc::unbounded_channel::<AppAction>();
 
-    let mut tui = tui::Tui::new()?.tick_rate(self.tick_rate).frame_rate(self.frame_rate);
+    let mut tui = tui::Tui::new()?;
     // tui.mouse(true);
     tui.enter()?;
 

src/app.rs

@@ -7,15 +7,6 @@ use crate::utils::version;
 #[derive(Parser, Debug)]
 #[command(author, version = version(), about)]
 pub struct Cli {
-  #[arg(short, long, value_name = "FLOAT", help = "Tick rate, i.e. number of ticks per second", default_value_t = 1.0)]
-  pub tick_rate: f64,
-
-  #[arg(
-    short,
-    long,
-    value_name = "FLOAT",
-    help = "Frame rate, i.e. number of frames per second",
-    default_value_t = 4.0
-  )]
-  pub frame_rate: f64,
+  #[arg(short, long, value_name = "PATH", help = "Path to the project root", default_value = ".")]
+  pub project_root: PathBuf,
 }

src/cli.rs

@@ -61,6 +61,18 @@ impl Preview {
     }
   }
 
+  fn top(&mut self, state: &State) {
+    if !self.non_divider_lines.is_empty() {
+      self.lines_state.select(Some(self.non_divider_lines[0]));
+    }
+  }
+
+  fn bottom(&mut self, state: &State) {
+    if !self.non_divider_lines.is_empty() {
+      self.lines_state.select(Some(self.non_divider_lines[self.non_divider_lines.len() - 1]));
+    }
+  }
+
   fn delete_line(&mut self, selected_result_state: &SearchResultState) {
     if let Some(selected_index) = self.lines_state.selected() {
       let line_index = self.non_divider_lines.iter().position(|&index| index == selected_index).unwrap_or(0);
@@ -84,20 +96,29 @@ impl Component for Preview {
 
   fn handle_key_events(&mut self, key: KeyEvent, state: &State) -> Result<Option<AppAction>> {
     if state.active_tab == Tab::Preview {
-      match key.code {
-        KeyCode::Char('d') => {
+      match (key.code, key.modifiers) {
+        (KeyCode::Char('d'), _) => {
           self.delete_line(&state.selected_result);
           Ok(None)
         },
-        KeyCode::Char('j') | KeyCode::Down => {
+        (KeyCode::Char('g'), _) => {
+          self.top(state);
+          Ok(None)
+        },
+        (KeyCode::Char('G'), _) => {
+          self.bottom(state);
+          Ok(None)
+        },
+
+        (KeyCode::Char('j'), _) | (KeyCode::Down, _) => {
           self.next();
           Ok(None)
         },
-        KeyCode::Char('k') | KeyCode::Up => {
+        (KeyCode::Char('k'), _) | (KeyCode::Up, _) => {
           self.previous();
           Ok(None)
         },
-        KeyCode::Enter | KeyCode::Esc => {
+        (KeyCode::Enter, _) | (KeyCode::Esc, _) => {
           let action = AppAction::Action(Action::SetActiveTab { tab: Tab::SearchResult });
           self.command_tx.as_ref().unwrap().send(action).unwrap();
           Ok(None)

src/components/preview.rs

@@ -1,7 +1,7 @@
 use std::{collections::HashMap, time::Duration};
 
 use color_eyre::eyre::Result;
-use crossterm::event::{KeyCode, KeyEvent};
+use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
 use ratatui::{
   prelude::*,
   widgets::{block::Title, *},
@@ -20,7 +20,7 @@ use crate::{
     state::{ReplaceTextKind, State},
     thunk::ThunkAction,
   },
-  tabs::Tab,
+  tabs::Tab, utils::is_git_repo,
 };
 
 #[derive(Default)]
@@ -58,9 +58,15 @@ impl Component for Replace {
 
   fn handle_key_events(&mut self, key: KeyEvent, state: &State) -> Result<Option<AppAction>> {
     if state.active_tab == Tab::Replace {
-      match key.code {
-        KeyCode::Tab | KeyCode::BackTab => Ok(None),
-        KeyCode::Enter => {
+      match (key.code, key.modifiers) {
+        (KeyCode::Char('p'), KeyModifiers::CONTROL) => {
+          let replace_text_kind = match state.replace_text.kind {
+            ReplaceTextKind::Simple => ReplaceTextKind::PreserveCase,
+            ReplaceTextKind::PreserveCase => ReplaceTextKind::Simple,
+          };
+          Ok(None)
+        },
+        (KeyCode::Char('n'), KeyModifiers::CONTROL) => {
           let replace_text_kind = match state.replace_text.kind {
             ReplaceTextKind::Simple => ReplaceTextKind::PreserveCase,
             ReplaceTextKind::PreserveCase => ReplaceTextKind::Simple,
@@ -69,7 +75,10 @@ impl Component for Replace {
           Ok(None)
         },
         _ => {
-          self.handle_input(key);
+          let is_git_folder = is_git_repo(state.project_root.clone());
+          if is_git_folder {
+            self.handle_input(key);
+          }
           Ok(None)
         },
       }

src/components/replace.rs

@@ -5,7 +5,7 @@ use std::{
 };
 
 use color_eyre::eyre::Result;
-use crossterm::event::{KeyCode, KeyEvent};
+use crossterm::event::{KeyCode, KeyEvent, KeyModifiers};
 use ratatui::{
   layout::Position,
   prelude::*,
@@ -29,6 +29,7 @@ use crate::{
   },
   ripgrep::RipgrepOutput,
   tabs::Tab,
+  utils::is_git_repo,
 };
 
 #[derive(Default)]
@@ -68,9 +69,9 @@ impl Component for Search {
 
   fn handle_key_events(&mut self, key: KeyEvent, state: &State) -> Result<Option<AppAction>> {
     if state.active_tab == Tab::Search {
-      match key.code {
-        KeyCode::Tab | KeyCode::BackTab => Ok(None),
-        KeyCode::Enter => {
+      match (key.code, key.modifiers) {
+        (KeyCode::Tab, _) | (KeyCode::BackTab, _) => Ok(None),
+        (KeyCode::Char('p'), KeyModifiers::CONTROL) => {
           let search_text_kind = match state.search_text.kind {
             SearchTextKind::Simple => SearchTextKind::MatchCase,
             SearchTextKind::MatchCase => SearchTextKind::MatchWholeWord,
@@ -81,10 +82,28 @@ impl Component for Search {
           self.change_kind(search_text_kind);
           Ok(None)
         },
-        _ => {
+        (KeyCode::Char('n'), KeyModifiers::CONTROL) => {
+          let search_text_kind = match state.search_text.kind {
+            SearchTextKind::Simple => SearchTextKind::Regex,
+            SearchTextKind::MatchCase => SearchTextKind::Simple,
+            SearchTextKind::MatchWholeWord => SearchTextKind::MatchCase,
+            SearchTextKind::MatchCaseWholeWord => SearchTextKind::MatchWholeWord,
+            SearchTextKind::Regex => SearchTextKind::MatchCaseWholeWord,
+          };
+          self.change_kind(search_text_kind);
+          Ok(None)
+        },
+        (KeyCode::Enter, _) => {
           self.handle_input(key);
           Ok(None)
         },
+        _ => {
+          let is_git_folder = is_git_repo(state.project_root.clone());
+          if is_git_folder {
+            self.handle_input(key);
+          }
+          Ok(None)
+        },
       }
     } else {
       Ok(None)

src/components/search.rs

@@ -90,6 +90,43 @@ impl SearchResult {
     self.command_tx.as_ref().unwrap().send(action).unwrap();
   }
 
+  fn top(&mut self, state: &State) {
+    if state.search_result.list.is_empty() {
+      return;
+    }
+
+    self.state.select(Some(0));
+    let selected_result = state.search_result.list.first().unwrap();
+    let action = AppAction::Action(Action::SetSelectedResult {
+      result: SearchResultState {
+        index: selected_result.index,
+        path: selected_result.path.clone(),
+        matches: selected_result.matches.clone(),
+        total_matches: selected_result.total_matches,
+      },
+    });
+    self.command_tx.as_ref().unwrap().send(action).unwrap();
+  }
+
+  fn bottom(&mut self, state: &State) {
+    if state.search_result.list.is_empty() {
+      return;
+    }
+
+    let i = state.search_result.list.len() - 1;
+    self.state.select(Some(i));
+    let selected_result = state.search_result.list.get(i).unwrap();
+    let action = AppAction::Action(Action::SetSelectedResult {
+      result: SearchResultState {
+        index: selected_result.index,
+        path: selected_result.path.clone(),
+        matches: selected_result.matches.clone(),
+        total_matches: selected_result.total_matches,
+      },
+    });
+    self.command_tx.as_ref().unwrap().send(action).unwrap();
+  }
+
   fn calculate_total_matches(&mut self, search_result_state: &SearchResultState) -> &str {
     let total_matches: usize = search_result_state.matches.iter().map(|m| m.submatches.len()).sum();
     let total_matches_str = total_matches.to_string();
@@ -119,20 +156,28 @@ impl Component for SearchResult {
 
   fn handle_key_events(&mut self, key: KeyEvent, state: &State) -> Result<Option<AppAction>> {
     if state.active_tab == Tab::SearchResult {
-      match key.code {
-        KeyCode::Char('d') => {
+      match (key.code, key.modifiers) {
+        (KeyCode::Char('d'), _) => {
           self.delete_file(&state.selected_result);
           Ok(None)
         },
-        KeyCode::Char('j') => {
+        (KeyCode::Char('g'), _) => {
+          self.top(state);
+          Ok(None)
+        },
+        (KeyCode::Char('G'), _) => {
+          self.bottom(state);
+          Ok(None)
+        },
+        (KeyCode::Char('j'), _) => {
           self.next(state);
           Ok(None)
         },
-        KeyCode::Char('k') => {
+        (KeyCode::Char('k'), _) => {
           self.previous(state);
           Ok(None)
         },
-        KeyCode::Enter => {
+        (KeyCode::Enter, _) => {
           let action = AppAction::Action(Action::SetActiveTab { tab: Tab::Preview });
           self.command_tx.as_ref().unwrap().send(action).unwrap();
           Ok(None)
@@ -155,13 +200,15 @@ impl Component for SearchResult {
       block
     };
 
+    let project_root = state.project_root.to_string_lossy();
     let list_items: Vec<ListItem> = state
       .search_result
       .list
       .iter()
       .map(|s| {
         let text = Line::from(vec![
-          Span::raw(&s.path),
+          // Display the relative path
+          Span::raw(s.path.strip_prefix(format!("{}/", project_root).as_str()).unwrap_or(&s.path)),
           Span::raw(" ("),
           Span::styled(s.total_matches.to_string(), Style::default().fg(Color::Yellow)),
           Span::raw(")"),

src/components/search_result.rs

@@ -51,13 +51,15 @@ impl Component for SmallHelp {
   fn draw(&mut self, f: &mut Frame<'_>, area: Rect, state: &State) -> Result<()> {
     let layout = get_layout(area);
     let content = if state.active_tab == Tab::Search {
-      "Search mode: [Ctrl + s] to search, [Ctrl + r] to replace, [Ctrl + g] to switch to normal mode"
+      "Search: <Enter> search, <Tab> switch replace, <Ctrl-n> toggle search mode"
     } else if state.active_tab == Tab::Replace {
-      "Replace mode: [Ctrl + s] to search, [Ctrl + r] to replace, [Ctrl + g] to switch to normal mode"
+      "Replace: <C-o> replace, <Tab> switch search list, <Ctrl-n> toggle search mode"
     } else if state.active_tab == Tab::SearchResult {
-      "Search result mode: [Enter] to open file, [Ctrl + s] to search, [Ctrl + r] to replace, [Ctrl + g] to switch to normal mode"
+      "Search List: <Enter> open file, <Tab> switch search, <j> go next, <k> go previous, <g> go top, <G> go bottom, <d> delete file"
+    } else if state.active_tab == Tab::Preview {
+      "Preview: <Enter> go back to list, <Tab> switch search, <j> go next, <k> go previous, <g> go top, <G> go bottom, <d> delete line"
     } else {
-      "Preview mode: [Ctrl + s] to search, [Ctrl + r] to replace, [Ctrl + g] to switch to normal mode"
+      "<Ctrl-C> exit"
     };
 
     let small_help = SmallHelpWidget::new(content.to_string(), Color::Blue, Alignment::Left);

src/components/small_help.rs

@@ -34,7 +34,7 @@ async fn tokio_main() -> Result<()> {
   initialize_panic_handler()?;
 
   let args = Cli::parse();
-  let mut app = App::new(args.tick_rate, args.frame_rate)?;
+  let mut app = App::new(args.project_root)?;
   app.run().await?;
 
   Ok(())

src/main.rs

@@ -143,7 +143,7 @@ pub fn reducer(state: State, action: Action) -> State {
     },
     Action::ChangeMode { mode } => State { mode, ..state },
     Action::SetGlobalLoading { global_loading } => State { global_loading, ..state },
-    Action::ResetState => State::new(),
+    Action::ResetState => State::new(state.project_root.clone()),
     Action::SetNotification { message, show, ttl, color } => {
       State { notification: NotificationState { message, show, ttl, color }, ..state }
     },

src/redux/reducer.rs

@@ -20,6 +20,7 @@ pub struct State {
   pub global_loading: bool,
   pub notification: NotificationState,
   pub dialog: Option<Dialog>,
+  pub project_root: PathBuf,
 }
 
 #[derive(Default, Deserialize, Serialize, Debug, Clone, PartialEq)]
@@ -119,7 +120,10 @@ pub struct SubMatch {
 }
 
 impl State {
-  pub fn new() -> Self {
-    Self::default()
+  pub fn new(project_root: PathBuf) -> Self {
+    Self {
+      project_root,
+      ..Default::default()
+    }
   }
 }