Improve Find/Replace shortcuts (#10297)

This PR changes ways the Find/Replace functionality in the Buffer/Project Search is accessible via shortcuts. It makes those panels work the same way as in VS Code and Sublime Text. The details are described in the issue: [Make Find/Replace easier to use](https://github.com/zed-industries/zed/issues/9142) There's a difficulty with the Linux keybindings: VS Code uses on MacOS (this PR replicates it): | Action | Buffer Search | Project Search | | --- | --- | --- | | Find | `cmd-f` | `cmd-shift-f` | | Replace | `cmd-alt-f` | `cmd-shift-h` | VS Code uses on Linux (this PR replicates all but one): | Action | Buffer Search | Project Search | | --- | --- | --- | | Find | `ctrl-f` | `ctrl-shift-f` | | Replace | `ctrl-h` ❗ | `ctrl-shift-h` | The problem is that `ctrl-h` is already taken by the `editor::Backspace` action in Zed on Linux. There's two options here: 1. Change keybinding for `editor::Backspace` on Linux to something else, and use `ctrl-h` for the "replace in buffer" action. 2. Use some other keybinding on Linux in Zed. This PR introduces `ctrl-r` for this purpose, though I'm not sure it's the best choice. What do you think? fixes #9142 Release Notes: - Improved access to "Find/Replace in Buffer" and "Find/Replace in Files" via shortcuts (#9142). Optionally, include screenshots / media showcasing your addition that can be included in the release notes. - N/A

Andrew Lygin committed 2 years ago

Commit 935e0d51 parent cc367d48 files · +103 −28Browse files

Unified · Split

8 files

assets/keymaps/default-linux.json +14 −5
assets/keymaps/default-macos.json +13 −3
crates/quick_action_bar/src/quick_action_bar.rs +2 −2
crates/search/src/buffer_search.rs +32 −5
crates/search/src/project_search.rs +24 −10
crates/search/src/search.rs +1 −0
crates/workspace/src/pane.rs +16 −2
crates/zed/src/zed/app_menus.rs +1 −1

assets/keymaps/default-linux.json+14−5

       "ctrl-0": "zed::ResetBufferFontSize",
       "ctrl-,": "zed::OpenSettings",
       "ctrl-q": "zed::Quit",
-      "ctrl-h": "zed::Hide",
+      "alt-f9": "zed::Hide",
       "f11": "zed::ToggleFullScreen"
     }
   },
       "escape": "editor::Cancel",
       "backspace": "editor::Backspace",
       "shift-backspace": "editor::Backspace",
-      "ctrl-h": "editor::Backspace",
       "delete": "editor::Delete",
       "ctrl-d": "editor::Delete",
       "tab": "editor::Tab",
       "ctrl-shift-enter": "editor::NewlineBelow",
       "ctrl-enter": "editor::NewlineAbove",
       "alt-z": "editor::ToggleSoftWrap",
-      "ctrl-f": [
+      "ctrl-f": "buffer_search::Deploy",
+      "ctrl-h": [
         "buffer_search::Deploy",
         {
-          "focus": true
+          "replace_enabled": true
         }
       ],
       // "cmd-e": [
       "enter": "search::SelectNextMatch",
       "shift-enter": "search::SelectPrevMatch",
       "alt-enter": "search::SelectAllMatches",
-      "alt-tab": "search::CycleMode"
+      "alt-tab": "search::CycleMode",
+      "ctrl-f": "search::FocusSearch",
+      "ctrl-h": "search::ToggleReplace"
     }
   },
   {
     "bindings": {
       "escape": "project_search::ToggleFocus",
       "alt-tab": "search::CycleMode",
+      "ctrl-shift-f": "search::FocusSearch",
       "ctrl-shift-h": "search::ToggleReplace",
       "alt-ctrl-g": "search::ActivateRegexMode",
       "alt-ctrl-x": "search::ActivateTextMode"
       "ctrl-j": "workspace::ToggleBottomDock",
       "ctrl-alt-y": "workspace::CloseAllDocks",
       "ctrl-shift-f": "pane::DeploySearch",
+      "ctrl-shift-h": [
+        "pane::DeploySearch",
+        {
+          "replace_enabled": true
+        }
+      ],
       "ctrl-k ctrl-s": "zed::OpenKeymap",
       "ctrl-k ctrl-t": "theme_selector::Toggle",
       "ctrl-shift-t": "project_symbols::Toggle",

assets/keymaps/default-macos.json+13−3

       "cmd-shift-enter": "editor::NewlineAbove",
       "cmd-enter": "editor::NewlineBelow",
       "alt-z": "editor::ToggleSoftWrap",
-      "cmd-f": [
+      "cmd-f": "buffer_search::Deploy",
+      "cmd-alt-f": [
         "buffer_search::Deploy",
         {
-          "focus": true
+          "replace_enabled": true
         }
       ],
       "cmd-e": [
       "enter": "search::SelectNextMatch",
       "shift-enter": "search::SelectPrevMatch",
       "alt-enter": "search::SelectAllMatches",
-      "alt-tab": "search::CycleMode"
+      "alt-tab": "search::CycleMode",
+      "cmd-f": "search::FocusSearch",
+      "cmd-alt-f": "search::ToggleReplace"
     }
   },
   {
     "bindings": {
       "escape": "project_search::ToggleFocus",
       "alt-tab": "search::CycleMode",
+      "cmd-shift-f": "search::FocusSearch",
       "cmd-shift-h": "search::ToggleReplace",
       "alt-cmd-g": "search::ActivateRegexMode",
       "alt-cmd-x": "search::ActivateTextMode"
       "cmd-j": "workspace::ToggleBottomDock",
       "alt-cmd-y": "workspace::CloseAllDocks",
       "cmd-shift-f": "pane::DeploySearch",
+      "cmd-shift-h": [
+        "pane::DeploySearch",
+        {
+          "replace_enabled": true
+        }
+      ],
       "cmd-k cmd-s": "zed::OpenKeymap",
       "cmd-k cmd-t": "theme_selector::Toggle",
       "cmd-t": "project_symbols::Toggle",

crates/quick_action_bar/src/quick_action_bar.rs+2−2

@@ -91,13 +91,13 @@ impl Render for QuickActionBar { · 90 unmodified lines
91	"toggle buffer search",	91	"toggle buffer search",
92	IconName::MagnifyingGlass,	92	IconName::MagnifyingGlass,
93	!self.buffer_search_bar.read(cx).is_dismissed(),	93	!self.buffer_search_bar.read(cx).is_dismissed(),
94	Box::new(buffer_search::Deploy { focus: false }),	94	Box::new(buffer_search::Deploy::find()),
95	"Buffer Search",	95	"Buffer Search",
96	{	96	{
97	let buffer_search_bar = self.buffer_search_bar.clone();	97	let buffer_search_bar = self.buffer_search_bar.clone();
98	move \|_, cx\| {	98	move \|_, cx\| {
99	buffer_search_bar.update(cx, \|search_bar, cx\| {	99	buffer_search_bar.update(cx, \|search_bar, cx\| {
100	search_bar.toggle(&buffer_search::Deploy { focus: true }, cx)	100	search_bar.toggle(&buffer_search::Deploy::find(), cx)
101	});	101	});
102	}	102	}
103	},	103	},

crates/search/src/buffer_search.rs+32−5

 use crate::{
     mode::{next_mode, SearchMode},
     search_bar::render_nav_button,
-    ActivateRegexMode, ActivateTextMode, CycleMode, NextHistoryQuery, PreviousHistoryQuery,
+    ActivateRegexMode, ActivateTextMode, CycleMode, FocusSearch, NextHistoryQuery,
-    ReplaceAll, ReplaceNext, SearchOptions, SelectAllMatches, SelectNextMatch, SelectPrevMatch,
+    PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions, SelectAllMatches,
-    ToggleCaseSensitive, ToggleReplace, ToggleWholeWord,
+    SelectNextMatch, SelectPrevMatch, ToggleCaseSensitive, ToggleReplace, ToggleWholeWord,
 };
 use any_vec::AnyVec;
 use collections::HashMap;
 const MAX_INPUT_WIDTH_REMS: f32 = 30.;
 const MAX_BUFFER_SEARCH_HISTORY_SIZE: usize = 50;
+const fn true_value() -> bool {
+    true
+}
 #[derive(PartialEq, Clone, Deserialize)]
 pub struct Deploy {
+    #[serde(default = "true_value")]
     pub focus: bool,
+    #[serde(default)]
+    pub replace_enabled: bool,
 }
 impl_actions!(buffer_search, [Deploy]);
 actions!(buffer_search, [Dismiss, FocusEditor]);
+impl Deploy {
+    pub fn find() -> Self {
+        Self {
+            focus: true,
+            replace_enabled: false,
+        }
+    }
+}
 pub enum Event {
     UpdateLocation,
 }
 impl BufferSearchBar {
     pub fn register(registrar: &mut impl SearchActionsRegistrar) {
+        registrar.register_handler(ForDeployed(|this, _: &FocusSearch, cx| {
+            this.query_editor.focus_handle(cx).focus(cx);
+        }));
         registrar.register_handler(ForDeployed(|this, action: &ToggleCaseSensitive, cx| {
             if this.supported_options().case {
                 this.toggle_case_sensitive(action, cx);
     pub fn deploy(&mut self, deploy: &Deploy, cx: &mut ViewContext<Self>) -> bool {
         if self.show(cx) {
             self.search_suggested(cx);
+            self.replace_enabled = deploy.replace_enabled;
             if deploy.focus {
-                self.select_query(cx);
+                let mut handle = self.query_editor.focus_handle(cx).clone();
-                let handle = self.query_editor.focus_handle(cx);
+                let mut select_query = true;
+                if deploy.replace_enabled && handle.is_focused(cx) {
+                    handle = self.replacement_editor.focus_handle(cx).clone();
+                    select_query = false;
+                };
+                if select_query {
+                    self.select_query(cx);
+                }
                 cx.focus(&handle);
             }
             return true;

crates/search/src/project_search.rs+24−10

 use crate::{
-    mode::SearchMode, ActivateRegexMode, ActivateTextMode, CycleMode, NextHistoryQuery,
+    mode::SearchMode, ActivateRegexMode, ActivateTextMode, CycleMode, FocusSearch,
-    PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions, SelectNextMatch, SelectPrevMatch,
+    NextHistoryQuery, PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions,
-    ToggleCaseSensitive, ToggleIncludeIgnored, ToggleReplace, ToggleWholeWord,
+    SelectNextMatch, SelectPrevMatch, ToggleCaseSensitive, ToggleIncludeIgnored, ToggleReplace,
+    ToggleWholeWord,
 };
 use anyhow::Context as _;
 use collections::{HashMap, HashSet};
 pub fn init(cx: &mut AppContext) {
     cx.set_global(ActiveSettings::default());
     cx.observe_new_views(|workspace: &mut Workspace, _cx| {
+        register_workspace_action(workspace, move |search_bar, _: &FocusSearch, cx| {
+            search_bar.focus_search(cx);
+        });
         register_workspace_action(workspace, move |search_bar, _: &ToggleFilters, cx| {
             search_bar.toggle_filters(cx);
         });
     // If no search exists in the workspace, create a new one.
     fn deploy_search(
         workspace: &mut Workspace,
-        _: &workspace::DeploySearch,
+        action: &workspace::DeploySearch,
         cx: &mut ViewContext<Workspace>,
     ) {
         let existing = workspace
             .items()
             .find_map(|item| item.downcast::<ProjectSearchView>());
-        Self::existing_or_new_search(workspace, existing, cx)
+        Self::existing_or_new_search(workspace, existing, action, cx);
     }
     fn search_in_new(workspace: &mut Workspace, _: &SearchInNew, cx: &mut ViewContext<Workspace>) {
         _: &workspace::NewSearch,
         cx: &mut ViewContext<Workspace>,
     ) {
-        Self::existing_or_new_search(workspace, None, cx)
+        Self::existing_or_new_search(workspace, None, &DeploySearch::find(), cx)
     }
     fn existing_or_new_search(
         workspace: &mut Workspace,
         existing: Option<View<ProjectSearchView>>,
+        action: &workspace::DeploySearch,
         cx: &mut ViewContext<Workspace>,
     ) {
         let query = workspace.active_item(cx).and_then(|item| {
         };
         search.update(cx, |search, cx| {
+            search.replace_enabled = action.replace_enabled;
             if let Some(query) = query {
                 search.set_query(&query, cx);
             }
         self.cycle_field(Direction::Prev, cx);
     }
+    fn focus_search(&mut self, cx: &mut ViewContext<Self>) {
+        if let Some(search_view) = self.active_project_search.as_ref() {
+            search_view.update(cx, |search_view, cx| {
+                search_view.query_editor.focus_handle(cx).focus(cx);
+            });
+        }
+    }
     fn cycle_field(&mut self, direction: Direction, cx: &mut ViewContext<Self>) {
         let active_project_search = match &self.active_project_search {
             Some(active_project_search) => active_project_search,
                         .update(cx, |toolbar, cx| toolbar.add_item(search_bar, cx))
                 });
-                ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch, cx)
+                ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch::find(), cx)
             })
             .unwrap();
         workspace
             .update(cx, |workspace, cx| {
-                ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch, cx)
+                ProjectSearchView::deploy_search(workspace, &workspace::DeploySearch::find(), cx)
             })
             .unwrap();
         window.update(cx, |_, cx| {
             .unwrap();
         // Deploy a new search
-        cx.dispatch_action(window.into(), DeploySearch);
+        cx.dispatch_action(window.into(), DeploySearch::find());
         // Both panes should now have a project search in them
         window
             .unwrap();
         // Deploy a new search
-        cx.dispatch_action(window.into(), DeploySearch);
+        cx.dispatch_action(window.into(), DeploySearch::find());
         // The project search view should now be focused in the second pane
         // And the number of items should be unchanged.

crates/search/src/search.rs+1−0

@@ -22,6 +22,7 @@ actions!( · 21 unmodified lines
22	search,	22	search,
23	[	23	[
24	CycleMode,	24	CycleMode,
		25	FocusSearch,
25	ToggleWholeWord,	26	ToggleWholeWord,
26	ToggleCaseSensitive,	27	ToggleCaseSensitive,
27	ToggleIncludeIgnored,	28	ToggleIncludeIgnored,

crates/workspace/src/pane.rs+16−2

     pub entry_id: Option<u64>,
 }
+#[derive(PartialEq, Clone, Deserialize)]
+pub struct DeploySearch {
+    #[serde(default)]
+    pub replace_enabled: bool,
+}
 impl_actions!(
     pane,
     [
         CloseActiveItem,
         CloseInactiveItems,
         ActivateItem,
-        RevealInProjectPanel
+        RevealInProjectPanel,
+        DeploySearch,
     ]
 );
         CloseItemsToTheLeft,
         CloseItemsToTheRight,
         GoBack,
-        DeploySearch,
         GoForward,
         ReopenClosedItem,
         SplitLeft,
     ]
 );
+impl DeploySearch {
+    pub fn find() -> Self {
+        Self {
+            replace_enabled: false,
+        }
+    }
+}
 const MAX_NAVIGATION_HISTORY_LEN: usize = 1024;
 pub enum Event {

crates/zed/src/zed/app_menus.rs+1−1

@@ -67,7 +67,7 @@ pub fn app_menus() -> Vec<Menu<'static>> { · 66 unmodified lines
67	MenuItem::os_action("Copy", editor::actions::Copy, OsAction::Copy),	67	MenuItem::os_action("Copy", editor::actions::Copy, OsAction::Copy),
68	MenuItem::os_action("Paste", editor::actions::Paste, OsAction::Paste),	68	MenuItem::os_action("Paste", editor::actions::Paste, OsAction::Paste),
69	MenuItem::separator(),	69	MenuItem::separator(),
70	MenuItem::action("Find", search::buffer_search::Deploy { focus: true }),	70	MenuItem::action("Find", search::buffer_search::Deploy::find()),
71	MenuItem::action("Find In Project", workspace::NewSearch),	71	MenuItem::action("Find In Project", workspace::NewSearch),
72	MenuItem::separator(),	72	MenuItem::separator(),
73	MenuItem::action(	73	MenuItem::action(

Improve Find/Replace shortcuts (#10297)

Keyboard shortcuts

General

Issues and pull requests

Issues, pull requests and Inbox

Repository code