Yehowshua/ZIm
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Improve Find/Replace shortcuts (#10297)

Browse source 
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
This commit is contained in:
Andrew Lygin 2024-04-09 08:07:59 +03:00 • committed by GitHub
parent cc367d43d6
commit 935e0d547e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
8 changed files with 103 additions and 28 deletions
Download patch file Download diff file Expand all files Collapse all files

37
crates/search/src/buffer_search.rs
View file

@ -3,9 +3,9 @@ mod registrar;
use crate::{
mode::{next_mode, SearchMode},
search_bar::render_nav_button,
ActivateRegexMode, ActivateTextMode, CycleMode, NextHistoryQuery, PreviousHistoryQuery,
ReplaceAll, ReplaceNext, SearchOptions, SelectAllMatches, SelectNextMatch, SelectPrevMatch,
ToggleCaseSensitive, ToggleReplace, ToggleWholeWord,
ActivateRegexMode, ActivateTextMode, CycleMode, FocusSearch, NextHistoryQuery,
PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions, SelectAllMatches,
SelectNextMatch, SelectPrevMatch, ToggleCaseSensitive, ToggleReplace, ToggleWholeWord,
};
use any_vec::AnyVec;
use collections::HashMap;
@ -44,15 +44,31 @@ const MIN_INPUT_WIDTH_REMS: f32 = 15.;
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,
}
@ -470,6 +486,9 @@ impl ToolbarItemView for BufferSearchBar {
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);
@ -583,9 +602,17 @@ impl BufferSearchBar {
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 handle = self.query_editor.focus_handle(cx);
let mut handle = self.query_editor.focus_handle(cx).clone();
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;

34
crates/search/src/project_search.rs
View file

@ -1,7 +1,8 @@
use crate::{
mode::SearchMode, ActivateRegexMode, ActivateTextMode, CycleMode, NextHistoryQuery,
PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions, SelectNextMatch, SelectPrevMatch,
ToggleCaseSensitive, ToggleIncludeIgnored, ToggleReplace, ToggleWholeWord,
mode::SearchMode, ActivateRegexMode, ActivateTextMode, CycleMode, FocusSearch,
NextHistoryQuery, PreviousHistoryQuery, ReplaceAll, ReplaceNext, SearchOptions,
SelectNextMatch, SelectPrevMatch, ToggleCaseSensitive, ToggleIncludeIgnored, ToggleReplace,
ToggleWholeWord,
};
use anyhow::Context as _;
use collections::{HashMap, HashSet};
@ -60,6 +61,9 @@ const SEARCH_CONTEXT: u32 = 2;
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);
});
@ -797,7 +801,7 @@ impl ProjectSearchView {
// 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
@ -806,7 +810,7 @@ impl ProjectSearchView {
.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>) {
@ -846,12 +850,13 @@ impl ProjectSearchView {
_: &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| {
@ -887,6 +892,7 @@ impl ProjectSearchView {
};
search.update(cx, |search, cx| {
search.replace_enabled = action.replace_enabled;
if let Some(query) = query {
search.set_query(&query, cx);
}
@ -1172,6 +1178,14 @@ impl ProjectSearchBar {
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,
@ -2011,7 +2025,7 @@ pub mod tests {
.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();
@ -2160,7 +2174,7 @@ pub mod tests {
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| {
@ -3259,7 +3273,7 @@ pub mod tests {
.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
@ -3284,7 +3298,7 @@ pub mod tests {
.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.

1
crates/search/src/search.rs
View file

@ -22,6 +22,7 @@ actions!(
search,
[
CycleMode,
FocusSearch,
ToggleWholeWord,
ToggleCaseSensitive,
ToggleIncludeIgnored,