Merge pull request #27 from yassinebridi/file-by-file-replace

File by file, and line by line replace

Author: yassinebridi

Cargo.lock

@@ -1,6 +1,6 @@
 [package]
 name = "serpl"
-version = "0.2.1"
+version = "0.3.0"
 edition = "2021"
 description = "A simple terminal UI for search and replace, ala VS Code"
 repository = "https://github.com/yassinebridi/serpl"

Cargo.toml

@@ -21,11 +21,12 @@ https://github.com/yassinebridi/serpl/assets/18403595/348506704-73336074-bfaf-4a
    - [Replace Input](#replace-input)
    - [Search Results Pane](#search-results-pane)
    - [Preview Pane](#preview-pane)
-5. [Neovim Integration using toggleterm](#neovim-integration-using-toggleterm)
-6. [License](#license)
-7. [Contributing](#contributing)
-8. [Acknowledgements](#acknowledgements)
-9. [Similar Projects](#similar-projects)
+5. [Quick Hints](#quick-hints)
+6. [Neovim Integration using toggleterm](#neovim-integration-using-toggleterm)
+7. [License](#license)
+8. [Contributing](#contributing)
+9. [Acknowledgements](#acknowledgements)
+10. [Similar Projects](#similar-projects)
 
 ## Features
 
@@ -115,24 +116,25 @@ Default key bindings can be customized through the `config.json` file.
 
 #### Default Key Bindings
 
-| Key Combination              | Action                            |
-| ---------------------------- | --------------------------------- |
-| `Ctrl + c`                   | Quit                              |
-| `Ctrl + b`                   | Help                              |
-| `Tab`                        | Switch between tabs               |
-| `Backtab`                    | Switch to previous tabs           |
-| `Ctrl + o`                   | Process replace                   |
-| `Ctrl + n`                   | Toggle search and replace modes   |
-| `Enter`                      | Execute search (for large folders)|
-| `g` / `Left` / `h`           | Go to top of the list             |
-| `G` / `Right` / `l`          | Go to bottom of the list          |
-| `j` / `Down`                 | Move to the next item             |
-| `k` / `Up`                   | Move to the previous item         |
-| `d`                          | Delete selected file or line      |
-| `Esc`                        | Exit the current pane or dialog   |
-| `Enter` (in dialogs) / `y`   | Confirm action                    |
-| `Esc` (in dialogs) / `n`     | Cancel action                     |
-| `h`, `l`, `Tab` (in dialogs) | Navigate dialog options           |
+| Key Combination              | Action                                    |
+| ---------------------------- | ----------------------------------------- |
+| `Ctrl + c`                   | Quit                                      |
+| `Ctrl + b`                   | Help                                      |
+| `Tab`                        | Switch between tabs                       |
+| `Backtab`                    | Switch to previous tabs                   |
+| `Ctrl + o`                   | Process replace for all files             |
+| `r`                          | Process replace for selected file or line |
+| `Ctrl + n`                   | Toggle search and replace modes           |
+| `Enter`                      | Execute search (for large folders)        |
+| `g` / `Left` / `h`           | Go to top of the list                     |
+| `G` / `Right` / `l`          | Go to bottom of the list                  |
+| `j` / `Down`                 | Move to the next item                     |
+| `k` / `Up`                   | Move to the previous item                 |
+| `d`                          | Delete selected file or line              |
+| `Esc`                        | Exit the current pane or dialog           |
+| `Enter` (in dialogs) / `y`   | Confirm action                            |
+| `Esc` (in dialogs) / `n`     | Cancel action                             |
+| `h`, `l`, `Tab` (in dialogs) | Navigate dialog options                   |
 
 ### Configuration
 
@@ -214,7 +216,13 @@ You can customize the key bindings by modifying the configuration file in the fo
 ### Search Input
 
 - Input field for entering search keywords.
-- Toggle search modes (Simple, Match Case, Whole Word, Regex, AST Grep).
+- Toggle search modes (Simple, Match Case, Match Whole Word, Match Case Whole Word, Regex, AST Grep).
+  - Simple: Search all occurrences of the keyword.
+  - Match Case: Search occurrences with the same case as the keyword.
+  - Match Whole Word: Search occurrences that match the keyword exactly.
+  - Match Case Whole Word: Search occurrences that match the keyword exactly with the same case.
+  - Regex: Search occurrences using a regular expression.
+  - AST Grep: Search occurrences using AST Grep.
 
 > [!TIP] 
 > If current directory is considerebly large, you have to click `Enter` to start the search.
@@ -223,6 +231,9 @@ You can customize the key bindings by modifying the configuration file in the fo
 
 - Input field for entering replacement text.
 - Toggle replace modes (Simple, Preserve Case, AST Grep).
+  - Simple: Replace all occurrences of the keyword.
+  - Preserve Case: Replace occurrences while preserving the case of the keyword.
+  - AST Grep: Replace occurrences using AST Grep.
 
 ### Search Results Pane
 
@@ -235,6 +246,14 @@ You can customize the key bindings by modifying the configuration file in the fo
 - Display of the selected file with highlighted search results, and context.
 - Navigation to view different matches within the file.
 - Option to delete individual lines containing matches.
+
+## Quick Hints
+- Use the `Ctrl + b` key combination to display the help dialog.
+- Use the `Ctrl + o` key combination to process the replace for all files.
+- Use the `r` key to process the replace for the selected file or line.
+- Use the `Ctrl + n` key combination to toggle between search and replace modes.
+- Use the `g`, `G`, `j`, and `k` keys to navigate through the search results.
+- Use the `d` key to delete the selected file or line.
 
 ## Neovim Integration using toggleterm
 

README.md

@@ -47,7 +47,7 @@ impl HelpDialog {
   // }
 
   fn global_keybindings() -> String {
-    "- q: Quit\n- Ctrl-c: Quit\n- Ctrl-b: Help dialog\n- Cltr-o: Process Replace\n- Ctrl-n: Loop through search and replace modes\n- Enter: Select/Deselect file\n- d: delete file/delete line from the replace process".to_string()
+    "- q: Quit\n- Ctrl-c: Quit\n- Ctrl-b: Help dialog\n- Cltr-o: Process Replace For All Files\n- Ctrl-n: Loop through search and replace modes\n- Enter: Select/Deselect file\n- d: delete file/delete line from the replace process\n- r: Replace Selected File Or Line".to_string()
   }
 
   fn navigation_keybindings() -> String {

src/components/help_dialog.rs

@@ -21,6 +21,7 @@ use crate::{
     action::Action,
     state::{FocusedScreen, ReplaceTextKind, SearchResultState, SearchTextKind, State, SubMatch},
     thunk::ThunkAction,
+    utils::{apply_replace, get_search_regex},
   },
   tabs::Tab,
 };
@@ -99,12 +100,25 @@ impl Preview {
     }
   }
 
+  fn replace_selected_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);
+      let file_index = selected_result_state.index.unwrap_or(0);
+      let replace_line_thunk = AppAction::Thunk(ThunkAction::ProcessLineReplace(file_index, line_index));
+      self.command_tx.as_ref().unwrap().send(replace_line_thunk).unwrap();
+    }
+  }
+
+  // disable too_many_arguments clippy
+  #[allow(clippy::too_many_arguments)]
   fn format_match_lines<'a>(
     &self,
     full_match: &'a str,
     submatches: &[SubMatch],
-    replace_text: &'a String,
+    replace_text: &'a str,
     replacement: &'a Option<String>,
+    search_kind: &SearchTextKind,
+    replace_kind: &ReplaceTextKind,
     is_ast_grep: bool,
   ) -> Vec<Line<'a>> {
     let mut lines = Vec::new();
@@ -150,14 +164,31 @@ impl Preview {
 
               spans.push(Span::raw(common_suffix));
             }
-          } else if replace_text.is_empty() {
-            spans.push(Span::styled(matched_text, Style::default().bg(Color::Blue)));
           } else {
-            spans.push(Span::styled(
-              matched_text,
-              Style::default().fg(Color::LightRed).add_modifier(Modifier::CROSSED_OUT),
-            ));
-            spans.push(Span::styled(replace_text, Style::default().fg(Color::White).bg(Color::Green)));
+            let re = get_search_regex(matched_text, search_kind);
+
+            for cap in re.captures_iter(line) {
+              let m = cap.get(0).unwrap();
+              let start = m.start();
+              let end = m.end();
+
+              if start > last_end {
+                spans.push(Span::raw(&line[last_end..start]));
+              }
+
+              if replace_text.is_empty() {
+                spans.push(Span::styled(matched_text, Style::default().bg(Color::Blue)));
+              } else {
+                let replacement = apply_replace(matched_text, replace_text, replace_kind);
+                spans.push(Span::styled(
+                  matched_text,
+                  Style::default().fg(Color::White).bg(Color::LightRed).add_modifier(Modifier::CROSSED_OUT),
+                ));
+                spans.push(Span::styled(replacement, Style::default().fg(Color::White).bg(Color::Green)));
+              }
+
+              last_end = end;
+            }
           }
 
           last_end = end;
@@ -235,6 +266,10 @@ impl Component for Preview {
           self.previous();
           Ok(None)
         },
+        (KeyCode::Char('r'), _) => {
+          self.replace_selected_line(&state.selected_result);
+          Ok(None)
+        },
         (KeyCode::Enter, _) | (KeyCode::Esc, _) => {
           let action = AppAction::Action(Action::SetActiveTab { tab: Tab::SearchResult });
           self.command_tx.as_ref().unwrap().send(action).unwrap();
@@ -292,6 +327,8 @@ impl Component for Preview {
         &result.submatches,
         &state.replace_text.text,
         &result.replacement,
+        &state.search_text.kind,
+        &state.replace_text.kind,
         is_ast_grep,
       );
       for (i, formatted_line) in formatted_lines.clone().into_iter().enumerate() {

src/components/preview.rs

@@ -58,6 +58,9 @@ impl Replace {
     if replace_text_kind == ReplaceTextKind::AstGrep {
       let search_text_action = AppAction::Action(Action::SetSearchTextKind { kind: SearchTextKind::AstGrep });
       self.command_tx.as_ref().unwrap().send(search_text_action).unwrap();
+    } else if replace_text_kind != ReplaceTextKind::AstGrep {
+      let search_text_action = AppAction::Action(Action::SetSearchTextKind { kind: SearchTextKind::Simple });
+      self.command_tx.as_ref().unwrap().send(search_text_action).unwrap();
     }
 
     let process_search_thunk = AppAction::Thunk(ThunkAction::ProcessSearch);

src/components/replace.rs

@@ -85,6 +85,9 @@ impl Search {
     if search_text_kind == SearchTextKind::AstGrep {
       let replace_text_action = AppAction::Action(Action::SetReplaceTextKind { kind: ReplaceTextKind::AstGrep });
       self.command_tx.as_ref().unwrap().send(replace_text_action).unwrap();
+    } else if state.replace_text.kind == ReplaceTextKind::AstGrep {
+      let replace_text_action = AppAction::Action(Action::SetReplaceTextKind { kind: ReplaceTextKind::Simple });
+      self.command_tx.as_ref().unwrap().send(replace_text_action).unwrap();
     }
 
     let process_search_thunk = AppAction::Thunk(ThunkAction::ProcessSearch);

src/components/search.rs

@@ -180,6 +180,15 @@ impl SearchResult {
     self.match_counts.push(total_matches_str);
     self.match_counts.last().unwrap()
   }
+
+  fn replace_single_file(&mut self, state: &State) {
+    if let Some(selected_index) = self.state.selected() {
+      if selected_index < state.search_result.list.len() {
+        let process_single_file_replace_thunk = AppAction::Thunk(ThunkAction::ProcessSingleFileReplace(selected_index));
+        self.command_tx.as_ref().unwrap().send(process_single_file_replace_thunk).unwrap();
+      }
+    }
+  }
 }
 
 impl Component for SearchResult {
@@ -216,6 +225,10 @@ impl Component for SearchResult {
           self.previous(state);
           Ok(None)
         },
+        (KeyCode::Char('r'), _) => {
+          self.replace_single_file(state);
+          Ok(None)
+        },
         (KeyCode::Enter, _) => {
           let action = AppAction::Action(Action::SetActiveTab { tab: Tab::Preview });
           self.command_tx.as_ref().unwrap().send(action).unwrap();

src/components/search_result.rs

@@ -55,10 +55,10 @@ impl Component for SmallHelp {
   fn draw(&mut self, f: &mut Frame<'_>, area: Rect, state: &State) -> Result<()> {
     let layout = get_layout(area);
     let content = match state.focused_screen {
-      FocusedScreen::SearchInput => "Help: <Ctrl-b> | Search: <Enter> | Switch to Replace: <Tab> | Toggle search mode: <Ctrl-n>",
-      FocusedScreen::ReplaceInput => "Help: <Ctrl-b> | Replace: <C-o> | Switch to Search List: <Tab> | Toggle replace mode: <Ctrl-n>",
-      FocusedScreen::SearchResultList => "Help: <Ctrl-b> | Open File: <Enter> | Switch to Search: <Tab> | Next: <j> | Previous: <k> | Top: <g> | Bottom: <G> | Delete file: <d>",
-      FocusedScreen::Preview => "Help: <Ctrl-b> | Back to list: <Enter> | Switch to Search: <Tab> | Next: <j> | Previous: <k> | Top: <g> | Bottom: <G> | Delete line: <d>",
+      FocusedScreen::SearchInput => "Help: <Ctrl-b> | Search: <Enter> | Toggle search mode: <Ctrl-n>",
+      FocusedScreen::ReplaceInput => "Help: <Ctrl-b> | Replace: <C-o> | Toggle replace mode: <Ctrl-n>",
+      FocusedScreen::SearchResultList => "Help: <Ctrl-b> | Open File: <Enter> | Replace File: <r> | Next: <j> | Previous: <k> | Top: <g> | Bottom: <G> | Delete file: <d>",
+      FocusedScreen::Preview => "Help: <Ctrl-b> | Back to list: <Enter> | Replace Line: <r> | Next: <j> | Previous: <k> | Top: <g> | Bottom: <G> | Delete line: <d>",
       FocusedScreen::ConfirmReplaceDialog => "Confirm Replace: <Enter> | Cancel Replace: <Esc>, Left: <h>, Right: <l>, Loop: <Tab>",
       FocusedScreen::ConfirmGitDirectoryDialog => "Confirm Replace: <Enter> | Cancel Replace: <Esc>, Left: <h>, Right: <l>, Loop: <Tab>",
       FocusedScreen::HelpDialog => "Close Help: <Esc> | Next Tab: <Right> | Previous Tab: <Left>",

src/components/small_help.rs

@@ -2,6 +2,7 @@ pub mod action;
 pub mod reducer;
 pub mod state;
 pub mod thunk;
+pub mod utils;
 
 #[derive(Debug)]
 pub enum ActionOrThunk {