mirror of
https://github.com/zed-industries/zed.git
synced 2026-11-20 15:40:29 +01:00
git_ui: Enable splitting MultiDiffView (directory zed --diff) (#64967)
## Summary Enable split diffs for `zed --diff`, where the left and right sides are directories. This simply reuses the existing split diff that's already used for single-file diffs, git UI, etc. I believe this will make the Zed diff experience more consistent for use cases like `git difftool`, `jj diff --tool` etc. See #50046 for a similar change that made this work for single-file diff views. ### Before <img width="1624" height="975" alt="image" src="https://github.com/user-attachments/assets/db8c0592-8bea-4b8f-9ccc-d94456fb6208" /> ### After <img width="1624" height="976" alt="image" src="https://github.com/user-attachments/assets/c074cc5f-bdf7-4747-9ef5-4f77b3e42ee6" /> <img width="1624" height="976" alt="image" src="https://github.com/user-attachments/assets/a97026a8-312d-4a51-a9f7-24343640237a" /> ## Testing 1. `cargo build` 2. `zed --zed target/debug/zed --diff $left $right` (where `$left` and `$right` are directories) For the screenshots above, I used `jj` configuration like this. It's a little awkward to setup because the debug build of Zed looks for grammar files in `crates/grammars/src` to properly highlight everything ```toml [merge-tools.zed-tester] program = "bash" diff-invocation-mode = "dir" diff-args = [ "-c", ''' dir=$PWD cd /path/to/zed/checkout zed-preview --zed ./target/debug/zed --wait --diff "$dir/$1" "$dir/$2" ''', "", "$left", "$right" ] ``` Usage with this config: `jj show $revision --tool zed-tester` or `jj diff -r $revisions --tool zed-tester` ## Self-review - [x] I've reviewed my diff for quality, security, reliability, and performance. - [x] UI changes follow the [checklist](https://zed.dev/docs/development/ui-checklist). - No new UI components here, just plugging existing ones together. UX should match what already existed for other usages of these components - [x] Tests cover the new or changed behavior. - In particular, added a test for the same scenario as #60914 to ensure that it works for this view Release Notes: - Enable side-by-side view for multibuffer `zed --diff` of directories
This commit is contained in:
@@ -1,7 +1,8 @@
|
||||
use anyhow::Result;
|
||||
use buffer_diff::BufferDiff;
|
||||
use editor::{
|
||||
Editor, EditorEvent, HiddenUnstagedDiffHunkRenderer, MultiBuffer, multibuffer_context_lines,
|
||||
Editor, EditorEvent, EditorSettings, HiddenUnstagedDiffHunkRenderer, MultiBuffer,
|
||||
SplittableEditor, multibuffer_context_lines,
|
||||
};
|
||||
use git_ui_core::file_diff_view::build_buffer_diff;
|
||||
use gpui::{
|
||||
@@ -11,6 +12,7 @@ use gpui::{
|
||||
use language::{Buffer, Capability, HighlightedText, OffsetRangeExt};
|
||||
use multi_buffer::PathKey;
|
||||
use project::{Project, ProjectPath};
|
||||
use settings::Settings;
|
||||
use std::{
|
||||
any::{Any, TypeId},
|
||||
path::{Path, PathBuf},
|
||||
@@ -26,9 +28,10 @@ use workspace::{
|
||||
};
|
||||
|
||||
pub struct MultiDiffView {
|
||||
editor: Entity<Editor>,
|
||||
editor: Entity<SplittableEditor>,
|
||||
file_count: usize,
|
||||
_editor_event_subscription: Subscription,
|
||||
_buffer_language_subscription: Subscription,
|
||||
}
|
||||
|
||||
struct Entry {
|
||||
@@ -170,8 +173,16 @@ impl MultiDiffView {
|
||||
register_entry(&multibuffer, entry, &common_root, context_lines, cx);
|
||||
}
|
||||
|
||||
let workspace_handle = cx.entity();
|
||||
let diff_view = cx.new(|cx| {
|
||||
Self::new(multibuffer.clone(), project.clone(), file_count, window, cx)
|
||||
Self::new(
|
||||
multibuffer.clone(),
|
||||
project.clone(),
|
||||
file_count,
|
||||
window,
|
||||
workspace_handle,
|
||||
cx,
|
||||
)
|
||||
});
|
||||
|
||||
let pane = workspace.active_pane();
|
||||
@@ -194,14 +205,19 @@ impl MultiDiffView {
|
||||
project: Entity<Project>,
|
||||
file_count: usize,
|
||||
window: &mut Window,
|
||||
workspace: Entity<Workspace>,
|
||||
cx: &mut Context<Self>,
|
||||
) -> Self {
|
||||
let editor = cx.new(|cx| {
|
||||
let mut editor =
|
||||
Editor::for_multibuffer(multibuffer, Some(project.clone()), window, cx);
|
||||
let editor = SplittableEditor::new(
|
||||
EditorSettings::get_global(cx).diff_view_style,
|
||||
multibuffer.clone(),
|
||||
project.clone(),
|
||||
workspace,
|
||||
window,
|
||||
cx,
|
||||
);
|
||||
editor.set_diff_hunk_renderer(Some(Arc::new(HiddenUnstagedDiffHunkRenderer)), cx);
|
||||
editor.disable_diagnostics(cx);
|
||||
editor.set_expand_all_diff_hunks(cx);
|
||||
editor
|
||||
});
|
||||
|
||||
@@ -211,10 +227,34 @@ impl MultiDiffView {
|
||||
}
|
||||
});
|
||||
|
||||
// The buffers' languages may load after the diff was built, e.g. when
|
||||
// opening the view on startup via `zed --diff`. Propagate them from rhs
|
||||
// to the corresponding lhs buffers when they change.
|
||||
let buffer_language_subscription =
|
||||
cx.subscribe(&multibuffer, |_, multibuffer, event, cx| {
|
||||
let &multi_buffer::Event::LanguageChanged(buffer_id, _) = event else {
|
||||
return;
|
||||
};
|
||||
let Some(rhs_buffer) = multibuffer.read(cx).buffer(buffer_id) else {
|
||||
return;
|
||||
};
|
||||
let Some(diff) = multibuffer.read(cx).diff_for(buffer_id) else {
|
||||
return;
|
||||
};
|
||||
|
||||
let language = rhs_buffer.read(cx).language().cloned();
|
||||
let lhs_buffer = diff.read(cx).base_text_buffer().clone();
|
||||
|
||||
lhs_buffer.update(cx, |lhs_buffer, cx| {
|
||||
lhs_buffer.set_language_async(language, cx);
|
||||
});
|
||||
});
|
||||
|
||||
Self {
|
||||
editor,
|
||||
file_count,
|
||||
_editor_event_subscription: editor_event_subscription,
|
||||
_buffer_language_subscription: buffer_language_subscription,
|
||||
}
|
||||
}
|
||||
|
||||
@@ -268,14 +308,12 @@ impl Item for MultiDiffView {
|
||||
&'a self,
|
||||
type_id: TypeId,
|
||||
self_handle: &'a Entity<Self>,
|
||||
_: &'a App,
|
||||
cx: &'a App,
|
||||
) -> Option<gpui::AnyEntity> {
|
||||
if type_id == TypeId::of::<Self>() {
|
||||
Some(self_handle.clone().into())
|
||||
} else if type_id == TypeId::of::<Editor>() {
|
||||
Some(self.editor.clone().into())
|
||||
} else {
|
||||
None
|
||||
self.editor.act_as_type(type_id, cx)
|
||||
}
|
||||
}
|
||||
|
||||
@@ -293,8 +331,10 @@ impl Item for MultiDiffView {
|
||||
_: &mut Window,
|
||||
cx: &mut Context<Self>,
|
||||
) {
|
||||
self.editor.update(cx, |editor, _| {
|
||||
editor.set_nav_history(Some(nav_history));
|
||||
self.editor.update(cx, |editor, cx| {
|
||||
editor.rhs_editor().update(cx, |editor, _| {
|
||||
editor.set_nav_history(Some(nav_history));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
@@ -348,3 +388,181 @@ impl Render for MultiDiffView {
|
||||
self.editor.clone()
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use super::*;
|
||||
use gpui::BorrowAppContext;
|
||||
use gpui::TestAppContext;
|
||||
use language::{Language, LanguageConfig};
|
||||
use project::{FakeFs, Project};
|
||||
use settings::{DiffViewStyle, SettingsStore};
|
||||
use util::path;
|
||||
use workspace::MultiWorkspace;
|
||||
|
||||
async fn test_init(
|
||||
cx: &mut TestAppContext,
|
||||
diff_style: DiffViewStyle,
|
||||
) -> Entity<MultiDiffView> {
|
||||
cx.update(|cx| {
|
||||
let settings_store = SettingsStore::test(cx);
|
||||
cx.set_global(settings_store);
|
||||
cx.update_global::<SettingsStore, _>(|store, cx| {
|
||||
store.update_user_settings(cx, |settings| {
|
||||
settings.editor.diff_view_style = Some(diff_style);
|
||||
});
|
||||
});
|
||||
theme_settings::init(theme::LoadThemes::JustBase, cx);
|
||||
});
|
||||
|
||||
let fs = FakeFs::new(cx.executor());
|
||||
fs.insert_tree(
|
||||
path!("/test"),
|
||||
serde_json::json!({
|
||||
"old": {
|
||||
"file.rs": "fn main() {}\n",
|
||||
"old_file.rs": "pub const BAR: usize = 0;\n",
|
||||
},
|
||||
"new": {
|
||||
"file.rs": "fn main() { unimplemented!() }\n",
|
||||
"new_file.rs": "pub fn foo() {}\n",
|
||||
}
|
||||
}),
|
||||
)
|
||||
.await;
|
||||
|
||||
let project = Project::test(fs.clone(), [path!("/test").as_ref()], cx).await;
|
||||
let (multi_workspace, cx) =
|
||||
cx.add_window_view(|window, cx| MultiWorkspace::test_new(project.clone(), window, cx));
|
||||
let workspace = multi_workspace.read_with(cx, |mw, _| mw.workspace().clone());
|
||||
|
||||
let diff_view = workspace
|
||||
.update_in(cx, |workspace, window, cx| {
|
||||
MultiDiffView::open(
|
||||
vec![
|
||||
[
|
||||
path!("/test/old/file.rs").into(),
|
||||
path!("/test/new/file.rs").into(),
|
||||
],
|
||||
[
|
||||
path!("/test/old/old_file.rs").into(),
|
||||
path!("/test/new/old_file.rs").into(),
|
||||
],
|
||||
[
|
||||
path!("/test/old/new_file.rs").into(),
|
||||
path!("/test/new/new_file.rs").into(),
|
||||
],
|
||||
],
|
||||
workspace,
|
||||
window,
|
||||
cx,
|
||||
)
|
||||
})
|
||||
.await
|
||||
.unwrap();
|
||||
|
||||
cx.run_until_parked();
|
||||
|
||||
diff_view
|
||||
}
|
||||
|
||||
#[gpui::test]
|
||||
async fn test_unified_diff_view(cx: &mut TestAppContext) {
|
||||
let diff_view = test_init(cx, DiffViewStyle::Unified).await;
|
||||
|
||||
// Language detection completes only after the diff view was created,
|
||||
// as happens on startup with `zed -n --diff old new`.
|
||||
let language = Arc::new(Language::new(
|
||||
LanguageConfig {
|
||||
name: "Rust".into(),
|
||||
..LanguageConfig::default()
|
||||
},
|
||||
None,
|
||||
));
|
||||
|
||||
diff_view.update(cx, |diff_view, cx| {
|
||||
diff_view.editor.update(cx, |editor, cx| {
|
||||
editor.rhs_editor().update(cx, |rhs_editor, cx| {
|
||||
rhs_editor.buffer().update(cx, |multibuffer, cx| {
|
||||
multibuffer.for_each_buffer(&mut |buffer| {
|
||||
buffer.update(cx, |buffer, cx| {
|
||||
buffer.set_language(Some(language.clone()), cx);
|
||||
})
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
cx.run_until_parked();
|
||||
|
||||
diff_view.read_with(cx, |diff_view, cx| {
|
||||
let rhs_editor = diff_view.editor.read(cx).rhs_editor().clone();
|
||||
let multibuffer = rhs_editor.read(cx).buffer().read(cx);
|
||||
|
||||
multibuffer.for_each_buffer(&mut |buffer| {
|
||||
let diff = multibuffer
|
||||
.diff_for(buffer.read(cx).remote_id())
|
||||
.expect("should have diff for each buffer");
|
||||
|
||||
let language = diff
|
||||
.read(cx)
|
||||
.base_text_buffer()
|
||||
.read(cx)
|
||||
.language()
|
||||
.map(|language| language.name());
|
||||
|
||||
assert_eq!(language, Some("Rust".into()));
|
||||
});
|
||||
});
|
||||
}
|
||||
|
||||
#[gpui::test]
|
||||
async fn test_split_diff_view(cx: &mut TestAppContext) {
|
||||
let diff_view = test_init(cx, DiffViewStyle::Split).await;
|
||||
|
||||
// Language detection completes only after the diff view was created,
|
||||
// as happens on startup with `zed -n --diff old new`.
|
||||
let language = Arc::new(Language::new(
|
||||
LanguageConfig {
|
||||
name: "Rust".into(),
|
||||
..LanguageConfig::default()
|
||||
},
|
||||
None,
|
||||
));
|
||||
|
||||
diff_view.update(cx, |diff_view, cx| {
|
||||
diff_view.editor.update(cx, |editor, cx| {
|
||||
editor.rhs_editor().update(cx, |rhs_editor, cx| {
|
||||
rhs_editor.buffer().update(cx, |multibuffer, cx| {
|
||||
multibuffer.for_each_buffer(&mut |buffer| {
|
||||
buffer.update(cx, |buffer, cx| {
|
||||
buffer.set_language(Some(language.clone()), cx);
|
||||
})
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
});
|
||||
|
||||
cx.run_until_parked();
|
||||
|
||||
diff_view.read_with(cx, |diff_view, cx| {
|
||||
let lhs_editor = diff_view
|
||||
.editor
|
||||
.read(cx)
|
||||
.lhs_editor()
|
||||
.expect("diff view should be split")
|
||||
.clone();
|
||||
|
||||
lhs_editor
|
||||
.read(cx)
|
||||
.buffer()
|
||||
.read(cx)
|
||||
.for_each_buffer(&mut |buffer| {
|
||||
let lhs_language = buffer.read(cx).language().map(|language| language.name());
|
||||
assert_eq!(lhs_language, Some("Rust".into()));
|
||||
});
|
||||
});
|
||||
}
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user