project_panel: Add granular auto-open file settings (zed-industries#40234)

miguelcsx · miguelcsx · commit 0cabafb5c37b · 2025-10-17T23:37:39.000-05:00
- Based on zed-industries#40234, and improvement of zed-industries#40331 Release Notes: - Added granular settings to control when files auto-open in the project panel (project_panel.auto_open.on_create, on_paste, on_drop) --- - Add nested �uto_open settings structure with three boolean options: - on_create: Auto-open newly created files (default: true) - on_paste: Auto-open pasted/duplicated files (default: false - fixes binary file errors) - on_drop: Auto-open externally dropped files (default: true) - Implement settings checks in paste, new file, and drop operations - Add Settings UI controls for all three auto-open options - Add test coverage with helper function for settings configuration - Add user documentation with examples and use cases
diff --git a/assets/settings/default.json b/assets/settings/default.json
@@ -725,8 +725,15 @@
     "hide_root": false,
     // Whether to hide the hidden entries in the project panel.
     "hide_hidden": false,
-    // Whether to automatically open files when pasting them in the project panel.
-    "open_file_on_paste": true
+    // Settings for automatically opening files in various operations.
+    "auto_open": {
+      // Automatically open newly created files in the editor
+      "on_create": true,
+      // Automatically open files after pasting or duplicating them
+      "on_paste": false,
+      // Automatically open files dropped from external sources
+      "on_drop": true
+    }
   },
   "outline_panel": {
     // Whether to show the outline panel button in the status bar
diff --git a/crates/project_panel/src/project_panel.rs b/crates/project_panel/src/project_panel.rs
@@ -1647,7 +1647,10 @@ impl ProjectPanel {
                             }
                         project_panel.update_visible_entries(None, false, false, window, cx);
                         if is_new_entry && !is_dir {
-                            project_panel.open_entry(new_entry.id, true, false, cx);
+                            let settings = ProjectPanelSettings::get_global(cx);
+                            if settings.auto_open.should_open_on_create() {
+                                project_panel.open_entry(new_entry.id, true, false, cx);
+                            }
                         }
                         cx.notify();
                     })?;
@@ -2698,16 +2701,16 @@ impl ProjectPanel {
                             });
 
                             if item_count == 1 {
-                                // open entry if not dir, setting is enabled, and only focus if rename is not pending
-                                if !entry.is_dir()
-                                    && ProjectPanelSettings::get_global(cx).open_file_on_paste
-                                {
-                                    project_panel.open_entry(
-                                        entry.id,
-                                        disambiguation_range.is_none(),
-                                        false,
-                                        cx,
-                                    );
+                                if !entry.is_dir() {
+                                    let settings = ProjectPanelSettings::get_global(cx);
+                                    if settings.auto_open.should_open_on_paste() {
+                                        project_panel.open_entry(
+                                            entry.id,
+                                            disambiguation_range.is_none(),
+                                            false,
+                                            cx,
+                                        );
+                                    }
                                 }
 
                                 // if only one entry was pasted and it was disambiguated, open the rename editor
@@ -3582,11 +3585,13 @@ impl ProjectPanel {
 
                 let opened_entries = task.await.with_context(|| "failed to copy external paths")?;
                 this.update(cx, |this, cx| {
-                    if open_file_after_drop && !opened_entries.is_empty() {
+                if open_file_after_drop && !opened_entries.is_empty() {
+                    let settings = ProjectPanelSettings::get_global(cx);
+                    if settings.auto_open.should_open_on_drop() {
                         this.open_entry(opened_entries[0], true, false, cx);
                     }
-                })
-            }
+                }
+            })
             .log_err().await
         })
         .detach();
diff --git a/crates/project_panel/src/project_panel_settings.rs b/crates/project_panel/src/project_panel_settings.rs
@@ -29,7 +29,7 @@ pub struct ProjectPanelSettings {
     pub hide_root: bool,
     pub hide_hidden: bool,
     pub drag_and_drop: bool,
-    pub open_file_on_paste: bool,
+    pub auto_open: AutoOpenSettings,
 }
 
 #[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
@@ -45,6 +45,30 @@ pub struct ScrollbarSettings {
     pub show: Option<ShowScrollbar>,
 }
 
+#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
+pub struct AutoOpenSettings {
+    pub on_create: bool,
+    pub on_paste: bool,
+    pub on_drop: bool,
+}
+
+impl AutoOpenSettings {
+    #[inline]
+    pub fn should_open_on_create(self) -> bool {
+        self.on_create
+    }
+
+    #[inline]
+    pub fn should_open_on_paste(self) -> bool {
+        self.on_paste
+    }
+
+    #[inline]
+    pub fn should_open_on_drop(self) -> bool {
+        self.on_drop
+    }
+}
+
 impl ScrollbarVisibility for ProjectPanelSettings {
     fn visibility(&self, cx: &ui::App) -> ShowScrollbar {
         self.scrollbar
@@ -80,7 +104,52 @@ impl Settings for ProjectPanelSettings {
             hide_root: project_panel.hide_root.unwrap(),
             hide_hidden: project_panel.hide_hidden.unwrap(),
             drag_and_drop: project_panel.drag_and_drop.unwrap(),
-            open_file_on_paste: project_panel.open_file_on_paste.unwrap(),
+            auto_open: {
+                let auto_open = project_panel.auto_open.unwrap();
+                AutoOpenSettings {
+                    on_create: auto_open.on_create.unwrap(),
+                    on_paste: auto_open.on_paste.unwrap(),
+                    on_drop: auto_open.on_drop.unwrap(),
+                }
+            },
+        }
+    }
+
+    fn import_from_vscode(
+        vscode: &settings::VsCodeSettings,
+        current: &mut settings::SettingsContent,
+    ) {
+        if let Some(hide_gitignore) = vscode.read_bool("explorer.excludeGitIgnore") {
+            current.project_panel.get_or_insert_default().hide_gitignore = Some(hide_gitignore);
+        }
+        if let Some(auto_reveal) = vscode.read_bool("explorer.autoReveal") {
+            current
+                .project_panel
+                .get_or_insert_default()
+                .auto_reveal_entries = Some(auto_reveal);
+        }
+        if let Some(compact_folders) = vscode.read_bool("explorer.compactFolders") {
+            current.project_panel.get_or_insert_default().auto_fold_dirs = Some(compact_folders);
+        }
+
+        if Some(false) == vscode.read_bool("git.decorations.enabled") {
+            current.project_panel.get_or_insert_default().git_status = Some(false);
+        }
+        if Some(false) == vscode.read_bool("problems.decorations.enabled") {
+            current
+                .project_panel
+                .get_or_insert_default()
+                .show_diagnostics = Some(ShowDiagnostics::Off);
+        }
+        if let (Some(false), Some(false)) = (
+            vscode.read_bool("explorer.decorations.badges"),
+            vscode.read_bool("explorer.decorations.colors"),
+        ) {
+            current.project_panel.get_or_insert_default().git_status = Some(false);
+            current
+                .project_panel
+                .get_or_insert_default()
+                .show_diagnostics = Some(ShowDiagnostics::Off);
         }
     }
 }
diff --git a/crates/project_panel/src/project_panel_tests.rs b/crates/project_panel/src/project_panel_tests.rs
@@ -1161,6 +1161,7 @@ async fn test_adding_directory_via_file(cx: &mut gpui::TestAppContext) {
 #[gpui::test]
 async fn test_copy_paste(cx: &mut gpui::TestAppContext) {
     init_test(cx);
+    set_auto_open_settings(cx, true, true, true);
 
     let fs = FakeFs::new(cx.executor());
     fs.insert_tree(
@@ -1257,6 +1258,140 @@ async fn test_copy_paste(cx: &mut gpui::TestAppContext) {
     });
 }
 
+#[gpui::test]
+async fn test_paste_with_auto_open_disabled(cx: &mut gpui::TestAppContext) {
+    init_test(cx);
+    set_auto_open_settings(cx, true, false, true);
+
+    let fs = FakeFs::new(cx.executor());
+    fs.insert_tree(
+        "/root1",
+        json!({
+            "test.txt": "content"
+        }),
+    )
+    .await;
+
+    let project = Project::test(fs.clone(), ["/root1".as_ref()], cx).await;
+    let workspace = cx.add_window(|window, cx| Workspace::test_new(project.clone(), window, cx));
+    let cx = &mut VisualTestContext::from_window(*workspace, cx);
+    let panel = workspace.update(cx, ProjectPanel::new).unwrap();
+    cx.run_until_parked();
+
+    panel.update_in(cx, |panel, window, cx| {
+        panel.select_next(&Default::default(), window, cx);
+    });
+
+    panel.update_in(cx, |panel, window, cx| {
+        panel.copy(&Default::default(), window, cx);
+        panel.paste(&Default::default(), window, cx);
+    });
+    cx.executor().run_until_parked();
+
+    // File should be pasted but not opened (no EDITOR marker)
+    assert_eq!(
+        visible_entries_as_strings(&panel, 0..50, cx),
+        &[
+            "v root1",
+            "      test.txt",
+            "      [EDITOR: 'test copy.txt']  <== selected  <== marked",
+        ]
+    );
+
+    // Rename editor appears for disambiguation, confirm it
+    panel.update_in(cx, |panel, window, cx| {
+        assert!(panel.confirm_edit(window, cx).is_none())
+    });
+    cx.executor().run_until_parked();
+
+    // After confirming rename, file should exist but still not be opened as a separate editor
+    let entries = visible_entries_as_strings(&panel, 0..50, cx);
+    assert!(entries.contains(&"      test copy.txt".to_string()));
+    assert!(entries.contains(&"      test.txt".to_string()));
+}
+
+#[gpui::test]
+async fn test_paste_with_auto_open_enabled(cx: &mut gpui::TestAppContext) {
+    init_test(cx);
+    set_auto_open_settings(cx, true, true, true);
+
+    let fs = FakeFs::new(cx.executor());
+    fs.insert_tree(
+        "/root1",
+        json!({
+            "test.txt": "content"
+        }),
+    )
+    .await;
+
+    let project = Project::test(fs.clone(), ["/root1".as_ref()], cx).await;
+    let workspace = cx.add_window(|window, cx| Workspace::test_new(project.clone(), window, cx));
+    let cx = &mut VisualTestContext::from_window(*workspace, cx);
+    let panel = workspace.update(cx, ProjectPanel::new).unwrap();
+    cx.run_until_parked();
+
+    panel.update_in(cx, |panel, window, cx| {
+        panel.select_next(&Default::default(), window, cx);
+    });
+
+    panel.update_in(cx, |panel, window, cx| {
+        panel.copy(&Default::default(), window, cx);
+        panel.paste(&Default::default(), window, cx);
+    });
+    cx.executor().run_until_parked();
+
+    // File should be pasted AND opened (EDITOR marker present)
+    assert_eq!(
+        visible_entries_as_strings(&panel, 0..50, cx),
+        &[
+            "v root1",
+            "      test.txt",
+            "      [EDITOR: 'test copy.txt']  <== selected  <== marked",
+        ]
+    );
+}
+
+#[gpui::test]
+async fn test_duplicate_respects_auto_open_setting(cx: &mut gpui::TestAppContext) {
+    init_test(cx);
+    set_auto_open_settings(cx, true, false, true);
+
+    let fs = FakeFs::new(cx.executor());
+    fs.insert_tree(
+        "/root1",
+        json!({
+            "test.txt": "content"
+        }),
+    )
+    .await;
+
+    let project = Project::test(fs.clone(), ["/root1".as_ref()], cx).await;
+    let workspace = cx.add_window(|window, cx| Workspace::test_new(project.clone(), window, cx));
+    let cx = &mut VisualTestContext::from_window(*workspace, cx);
+    let panel = workspace.update(cx, ProjectPanel::new).unwrap();
+    cx.run_until_parked();
+
+    panel.update_in(cx, |panel, window, cx| {
+        panel.select_next(&Default::default(), window, cx);
+    });
+
+    // Duplicate uses paste internally, so it should respect on_paste setting
+    panel.update_in(cx, |panel, window, cx| {
+        panel.duplicate(&Duplicate, window, cx);
+    });
+    cx.executor().run_until_parked();
+
+    // File should be duplicated but not opened (no additional EDITOR marker beyond rename)
+    assert_eq!(
+        visible_entries_as_strings(&panel, 0..50, cx),
+        &[
+            "v root1",
+            "      test.txt",
+            "      [EDITOR: 'test copy.txt']  <== selected  <== marked",
+        ]
+    );
+}
+
 #[gpui::test]
 async fn test_cut_paste(cx: &mut gpui::TestAppContext) {
     init_test(cx);
@@ -6987,6 +7122,21 @@ fn init_test_with_editor(cx: &mut TestAppContext) {
     });
 }
 
+fn set_auto_open_settings(cx: &mut TestAppContext, on_create: bool, on_paste: bool, on_drop: bool) {
+    cx.update(|cx| {
+        cx.update_global::<SettingsStore, _>(|store, cx| {
+            store.update_user_settings(cx, |settings| {
+                settings.project_panel.get_or_insert_default().auto_open =
+                    Some(settings::ProjectPanelAutoOpenSettings {
+                        on_create: Some(on_create),
+                        on_paste: Some(on_paste),
+                        on_drop: Some(on_drop),
+                    });
+            });
+        })
+    });
+}
+
 fn ensure_single_file_is_opened(
     window: &WindowHandle<Workspace>,
     expected_path: &str,
diff --git a/crates/settings/src/settings_content/workspace.rs b/crates/settings/src/settings_content/workspace.rs
@@ -488,6 +488,23 @@ impl OnLastWindowClosed {
     }
 }
 
+#[skip_serializing_none]
+#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
+pub struct ProjectPanelAutoOpenSettings {
+    /// Whether to automatically open newly created files in the editor.
+    ///
+    /// Default: true
+    pub on_create: Option<bool>,
+    /// Whether to automatically open files after pasting or duplicating them.
+    ///
+    /// Default: false
+    pub on_paste: Option<bool>,
+    /// Whether to automatically open files dropped from external sources.
+    ///
+    /// Default: true
+    pub on_drop: Option<bool>,
+}
+
 #[skip_serializing_none]
 #[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
 pub struct ProjectPanelSettingsContent {
@@ -566,10 +583,8 @@ pub struct ProjectPanelSettingsContent {
     ///
     /// Default: true
     pub drag_and_drop: Option<bool>,
-    /// Whether to automatically open files when pasting them in the project panel.
-    ///
-    /// Default: true
-    pub open_file_on_paste: Option<bool>,
+    /// Settings for automatically opening files in various operations.
+    pub auto_open: Option<ProjectPanelAutoOpenSettings>,
 }
 
 #[derive(
diff --git a/crates/settings/src/vscode_import.rs b/crates/settings/src/vscode_import.rs
@@ -655,7 +655,6 @@ impl VsCodeSettings {
             hide_root: None,
             indent_guides: None,
             indent_size: None,
-            open_file_on_paste: None,
             scrollbar: None,
             show_diagnostics: self
                 .read_bool("problems.decorations.enabled")
diff --git a/crates/settings_ui/src/page_data.rs b/crates/settings_ui/src/page_data.rs
diff --git a/docs/src/configuring-zed.md b/docs/src/configuring-zed.md
