//! # settings_ui mod components; use anyhow::Result; use editor::{Editor, EditorEvent}; use feature_flags::{FeatureFlag, FeatureFlagAppExt as _}; use fuzzy::StringMatchCandidate; use gpui::{ App, Div, Entity, Focusable, FontWeight, Global, ReadGlobal as _, ScrollHandle, Task, TitlebarOptions, UniformListScrollHandle, Window, WindowHandle, WindowOptions, div, point, prelude::*, px, size, uniform_list, }; use project::WorktreeId; use settings::{ BottomDockLayout, CloseWindowWhenNoItems, CodeFade, CursorShape, OnLastWindowClosed, RestoreOnStartupBehavior, SaturatingBool, SettingsContent, SettingsStore, }; use std::{ any::{Any, TypeId, type_name}, cell::RefCell, collections::HashMap, num::NonZeroU32, ops::Range, rc::Rc, sync::{Arc, atomic::AtomicBool}, }; use ui::{ ButtonLike, ContextMenu, Divider, DropdownMenu, DropdownStyle, IconButtonShape, PopoverMenu, Switch, SwitchColor, TreeViewItem, WithScrollbar, prelude::*, }; use ui_input::{NumericStepper, NumericStepperStyle, NumericStepperType}; use util::{ResultExt as _, paths::PathStyle, rel_path::RelPath}; use zed_actions::OpenSettingsEditor; use crate::components::SettingsEditor; #[derive(Clone, Copy)] struct SettingField { pick: fn(&SettingsContent) -> &Option, pick_mut: fn(&mut SettingsContent) -> &mut Option, } trait AnySettingField { fn as_any(&self) -> &dyn Any; fn type_name(&self) -> &'static str; fn type_id(&self) -> TypeId; fn file_set_in(&self, file: SettingsUiFile, cx: &App) -> settings::SettingsFile; } impl AnySettingField for SettingField { fn as_any(&self) -> &dyn Any { self } fn type_name(&self) -> &'static str { type_name::() } fn type_id(&self) -> TypeId { TypeId::of::() } fn file_set_in(&self, file: SettingsUiFile, cx: &App) -> settings::SettingsFile { let (file, _) = cx .global::() .get_value_from_file(file.to_settings(), self.pick); return file; } } #[derive(Default, Clone)] struct SettingFieldRenderer { renderers: Rc< RefCell< HashMap< TypeId, Box< dyn Fn( &dyn AnySettingField, SettingsUiFile, Option<&SettingsFieldMetadata>, &mut Window, &mut App, ) -> AnyElement, >, >, >, >, } impl Global for SettingFieldRenderer {} impl SettingFieldRenderer { fn add_renderer( &mut self, renderer: impl Fn( &SettingField, SettingsUiFile, Option<&SettingsFieldMetadata>, &mut Window, &mut App, ) -> AnyElement + 'static, ) -> &mut Self { let key = TypeId::of::(); let renderer = Box::new( move |any_setting_field: &dyn AnySettingField, settings_file: SettingsUiFile, metadata: Option<&SettingsFieldMetadata>, window: &mut Window, cx: &mut App| { let field = any_setting_field .as_any() .downcast_ref::>() .unwrap(); renderer(field, settings_file, metadata, window, cx) }, ); self.renderers.borrow_mut().insert(key, renderer); self } fn render( &self, any_setting_field: &dyn AnySettingField, settings_file: SettingsUiFile, metadata: Option<&SettingsFieldMetadata>, window: &mut Window, cx: &mut App, ) -> AnyElement { let key = any_setting_field.type_id(); if let Some(renderer) = self.renderers.borrow().get(&key) { renderer(any_setting_field, settings_file, metadata, window, cx) } else { panic!( "No renderer found for type: {}", any_setting_field.type_name() ) } } } struct SettingsFieldMetadata { placeholder: Option<&'static str>, } fn user_settings_data() -> Vec { vec![ SettingsPage { title: "General Page", items: vec![ SettingsPageItem::SectionHeader("General"), SettingsPageItem::SettingItem(SettingItem { title: "Confirm Quit", description: "Whether to confirm before quitting Zed", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.confirm_quit, pick_mut: |settings_content| &mut settings_content.workspace.confirm_quit, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Restore On Startup", description: "Whether to restore previous session when opening Zed", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.restore_on_startup, pick_mut: |settings_content| { &mut settings_content.workspace.restore_on_startup }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Restore File State", description: "Whether to restore previous file state when reopening", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.restore_on_file_reopen, pick_mut: |settings_content| { &mut settings_content.workspace.restore_on_file_reopen }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Close on File Delete", description: "Whether to automatically close files that have been deleted", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.close_on_file_delete, pick_mut: |settings_content| { &mut settings_content.workspace.close_on_file_delete }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "When Closing With No Tabs", description: "What to do when using 'close active item' with no tabs", field: Box::new(SettingField { pick: |settings_content| { &settings_content.workspace.when_closing_with_no_tabs }, pick_mut: |settings_content| { &mut settings_content.workspace.when_closing_with_no_tabs }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "On Last Window Closed", description: "What to do when the last window is closed", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.on_last_window_closed, pick_mut: |settings_content| { &mut settings_content.workspace.on_last_window_closed }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use System Path Prompts", description: "Whether to use system dialogs for Open and Save As", field: Box::new(SettingField { pick: |settings_content| { &settings_content.workspace.use_system_path_prompts }, pick_mut: |settings_content| { &mut settings_content.workspace.use_system_path_prompts }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use System Prompts", description: "Whether to use system prompts for confirmations", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.use_system_prompts, pick_mut: |settings_content| { &mut settings_content.workspace.use_system_prompts }, }), metadata: None, }), SettingsPageItem::SectionHeader("Scoped Settings"), // todo(settings_ui): Implement another setting item type that just shows an edit in settings.json // SettingsPageItem::SettingItem(SettingItem { // title: "Preview Channel", // description: "Which settings should be activated only in Preview build of Zed", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.workspace.use_system_prompts, // pick_mut: |settings_content| { // &mut settings_content.workspace.use_system_prompts // }, // }), // metadata: None, // }), // SettingsPageItem::SettingItem(SettingItem { // title: "Settings Profiles", // description: "Any number of settings profiles that are temporarily applied on top of your existing user settings.", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.workspace.use_system_prompts, // pick_mut: |settings_content| { // &mut settings_content.workspace.use_system_prompts // }, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Privacy"), SettingsPageItem::SettingItem(SettingItem { title: "Telemetry Diagnostics", description: "Send debug info like crash reports.", field: Box::new(SettingField { pick: |settings_content| { if let Some(telemetry) = &settings_content.telemetry { &telemetry.diagnostics } else { &None } }, pick_mut: |settings_content| { &mut settings_content .telemetry .get_or_insert_default() .diagnostics }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Telemetry Metrics", description: "Send anonymized usage data like what languages you're using Zed with.", field: Box::new(SettingField { pick: |settings_content| { if let Some(telemetry) = &settings_content.telemetry { &telemetry.metrics } else { &None } }, pick_mut: |settings_content| { &mut settings_content.telemetry.get_or_insert_default().metrics }, }), metadata: None, }), ], }, SettingsPage { title: "Appearance & Behavior", items: vec![ SettingsPageItem::SectionHeader("Theme"), // todo(settings_ui): Figure out how we want to add these // SettingsPageItem::SettingItem(SettingItem { // title: "Theme Mode", // description: "How to select the theme", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.theme.theme, // pick_mut: |settings_content| &mut settings_content.theme.theme, // }), // metadata: None, // }), // SettingsPageItem::SettingItem(SettingItem { // title: "Icon Theme", // // todo(settings_ui) // // This description is misleading because the icon theme is used in more places than the file explorer) // description: "Choose the icon theme for file explorer", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.theme.icon_theme, // pick_mut: |settings_content| &mut settings_content.theme.icon_theme, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Layout"), SettingsPageItem::SettingItem(SettingItem { title: "Bottom Dock Layout", description: "Layout mode for the bottom dock", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.bottom_dock_layout, pick_mut: |settings_content| { &mut settings_content.workspace.bottom_dock_layout }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Zoomed Padding", description: "Whether to show padding for zoomed panels", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.zoomed_padding, pick_mut: |settings_content| &mut settings_content.workspace.zoomed_padding, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use System Window Tabs", description: "Whether to allow windows to tab together based on the user's tabbing preference (macOS only)", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.use_system_window_tabs, pick_mut: |settings_content| { &mut settings_content.workspace.use_system_window_tabs }, }), metadata: None, }), SettingsPageItem::SectionHeader("Fonts"), SettingsPageItem::SettingItem(SettingItem { title: "Buffer Font Family", description: "Font family for editor text", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.buffer_font_family, pick_mut: |settings_content| &mut settings_content.theme.buffer_font_family, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Buffer Font Size", description: "Font size for editor text", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.buffer_font_size, pick_mut: |settings_content| &mut settings_content.theme.buffer_font_size, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Buffer Font Weight", description: "Font weight for editor text (100-900)", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.buffer_font_weight, pick_mut: |settings_content| &mut settings_content.theme.buffer_font_weight, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Buffer Line Height", description: "Line height for editor text", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.buffer_line_height, pick_mut: |settings_content| &mut settings_content.theme.buffer_line_height, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "UI Font Family", description: "Font family for UI elements", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.ui_font_family, pick_mut: |settings_content| &mut settings_content.theme.ui_font_family, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "UI Font Size", description: "Font size for UI elements", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.ui_font_size, pick_mut: |settings_content| &mut settings_content.theme.ui_font_size, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "UI Font Weight", description: "Font weight for UI elements (100-900)", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.ui_font_weight, pick_mut: |settings_content| &mut settings_content.theme.ui_font_weight, }), metadata: None, }), SettingsPageItem::SectionHeader("Keymap"), SettingsPageItem::SettingItem(SettingItem { title: "Base Keymap", description: "The name of a base set of key bindings to use", field: Box::new(SettingField { pick: |settings_content| &settings_content.base_keymap, pick_mut: |settings_content| &mut settings_content.base_keymap, }), metadata: None, }), // todo(settings_ui): Vim/Helix Mode should be apart of one type because it's undefined // behavior to have them both enabled at the same time SettingsPageItem::SettingItem(SettingItem { title: "Vim Mode", description: "Whether to enable vim modes and key bindings", field: Box::new(SettingField { pick: |settings_content| &settings_content.vim_mode, pick_mut: |settings_content| &mut settings_content.vim_mode, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Helix Mode", description: "Whether to enable helix modes and key bindings", field: Box::new(SettingField { pick: |settings_content| &settings_content.helix_mode, pick_mut: |settings_content| &mut settings_content.helix_mode, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Multi Cursor Modifier", description: "Modifier key for adding multiple cursors", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.multi_cursor_modifier, pick_mut: |settings_content| { &mut settings_content.editor.multi_cursor_modifier }, }), metadata: None, }), SettingsPageItem::SectionHeader("Cursor"), SettingsPageItem::SettingItem(SettingItem { title: "Cursor Blink", description: "Whether the cursor blinks in the editor", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.cursor_blink, pick_mut: |settings_content| &mut settings_content.editor.cursor_blink, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Cursor Shape", description: "Cursor shape for the editor", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.cursor_shape, pick_mut: |settings_content| &mut settings_content.editor.cursor_shape, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Hide Mouse", description: "When to hide the mouse cursor", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.hide_mouse, pick_mut: |settings_content| &mut settings_content.editor.hide_mouse, }), metadata: None, }), SettingsPageItem::SectionHeader("Highlighting"), SettingsPageItem::SettingItem(SettingItem { title: "Unnecessary Code Fade", description: "How much to fade out unused code (0.0 - 0.9)", field: Box::new(SettingField { pick: |settings_content| &settings_content.theme.unnecessary_code_fade, pick_mut: |settings_content| { &mut settings_content.theme.unnecessary_code_fade }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Current Line Highlight", description: "How to highlight the current line", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.current_line_highlight, pick_mut: |settings_content| { &mut settings_content.editor.current_line_highlight }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Selection Highlight", description: "Whether to highlight all occurrences of selected text", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.selection_highlight, pick_mut: |settings_content| { &mut settings_content.editor.selection_highlight }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Rounded Selection", description: "Whether the text selection should have rounded corners", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.rounded_selection, pick_mut: |settings_content| &mut settings_content.editor.rounded_selection, }), metadata: None, }), SettingsPageItem::SectionHeader("Guides"), SettingsPageItem::SettingItem(SettingItem { title: "Show Wrap Guides", description: "Whether to show wrap guides (vertical rulers)", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_wrap_guides }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_wrap_guides }, }), metadata: None, }), // todo(settings_ui): This needs a custom component // SettingsPageItem::SettingItem(SettingItem { // title: "Wrap Guides", // description: "Character counts at which to show wrap guides", // field: Box::new(SettingField { // pick: |settings_content| { // &settings_content // .project // .all_languages // .defaults // .wrap_guides // }, // pick_mut: |settings_content| { // &mut settings_content // .project // .all_languages // .defaults // .wrap_guides // }, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Whitespace"), SettingsPageItem::SettingItem(SettingItem { title: "Show Whitespace", description: "Whether to show tabs and spaces", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_whitespaces }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_whitespaces }, }), metadata: None, }), SettingsPageItem::SectionHeader("Window"), // todo(settings_ui): Should we filter by platform? SettingsPageItem::SettingItem(SettingItem { title: "Use System Window Tabs", description: "Whether to allow windows to tab together (macOS only)", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.use_system_window_tabs, pick_mut: |settings_content| { &mut settings_content.workspace.use_system_window_tabs }, }), metadata: None, }), SettingsPageItem::SectionHeader("Layout"), SettingsPageItem::SettingItem(SettingItem { title: "Zoomed Padding", description: "Whether to show padding for zoomed panels", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.zoomed_padding, pick_mut: |settings_content| &mut settings_content.workspace.zoomed_padding, }), metadata: None, }), // todo(settings_ui): Needs numeric stepper + option within an option // SettingsPageItem::SettingItem(SettingItem { // title: "Centered Layout Left Padding", // description: "Left padding for centered layout", // field: Box::new(SettingField { // pick: |settings_content| { // &settings_content.workspace.centered_layout.left_padding // }, // pick_mut: |settings_content| { // &mut settings_content.workspace.centered_layout.left_padding // }, // }), // metadata: None, // }), // SettingsPageItem::SettingItem(SettingItem { // title: "Centered Layout Right Padding", // description: "Right padding for centered layout", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(centered_layout) = // &settings_content.workspace.centered_layout // { // ¢ered_layout.right_padding // } else { // &None // } // }, // pick_mut: |settings_content| { // if let Some(mut centered_layout) = // settings_content.workspace.centered_layout // { // &mut centered_layout.right_padding // } else { // &mut None // } // }, // }), // metadata: None, // }), SettingsPageItem::SettingItem(SettingItem { title: "Bottom Dock Layout", description: "Layout mode of the bottom dock", field: Box::new(SettingField { pick: |settings_content| &settings_content.workspace.bottom_dock_layout, pick_mut: |settings_content| { &mut settings_content.workspace.bottom_dock_layout }, }), metadata: None, }), ], }, SettingsPage { title: "Editor", items: vec![ SettingsPageItem::SectionHeader("Indentation"), // todo(settings_ui): Needs numeric stepper SettingsPageItem::SettingItem(SettingItem { title: "Tab Size", description: "How many columns a tab should occupy", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.tab_size }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.tab_size }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Hard Tabs", description: "Whether to indent lines using tab characters, as opposed to multiple spaces", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.hard_tabs }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.hard_tabs }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Auto Indent", description: "Whether indentation should be adjusted based on the context whilst typing", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.auto_indent }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.auto_indent }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Auto Indent On Paste", description: "Whether indentation of pasted content should be adjusted based on the context", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .auto_indent_on_paste }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .auto_indent_on_paste }, }), metadata: None, }), SettingsPageItem::SectionHeader("Wrapping"), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Preferred Line Length", // description: "The column at which to soft-wrap lines, for buffers where soft-wrap is enabled", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.project.all_languages.defaults.preferred_line_length, // pick_mut: |settings_content| &mut settings_content.project.all_languages.defaults.preferred_line_length, // }), // metadata: None, // }), SettingsPageItem::SettingItem(SettingItem { title: "Soft Wrap", description: "How to soft-wrap long lines of text", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.soft_wrap }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.soft_wrap }, }), metadata: None, }), SettingsPageItem::SectionHeader("Search"), SettingsPageItem::SettingItem(SettingItem { title: "Search Wrap", description: "Whether the editor search results will loop", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.search_wrap, pick_mut: |settings_content| &mut settings_content.editor.search_wrap, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Seed Search Query From Cursor", description: "When to populate a new search's query based on the text under the cursor", field: Box::new(SettingField { pick: |settings_content| { &settings_content.editor.seed_search_query_from_cursor }, pick_mut: |settings_content| { &mut settings_content.editor.seed_search_query_from_cursor }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use Smartcase Search", description: "Whether to use smartcase search", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.use_smartcase_search, pick_mut: |settings_content| { &mut settings_content.editor.use_smartcase_search }, }), metadata: None, }), SettingsPageItem::SectionHeader("Editor Behavior"), SettingsPageItem::SettingItem(SettingItem { title: "Redact Private Values", description: "Hide the values of variables in private files", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.redact_private_values, pick_mut: |settings_content| { &mut settings_content.editor.redact_private_values }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Middle Click Paste", description: "Whether to enable middle-click paste on Linux", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.middle_click_paste, pick_mut: |settings_content| { &mut settings_content.editor.middle_click_paste }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Double Click In Multibuffer", description: "What to do when multibuffer is double clicked in some of its excerpts", field: Box::new(SettingField { pick: |settings_content| { &settings_content.editor.double_click_in_multibuffer }, pick_mut: |settings_content| { &mut settings_content.editor.double_click_in_multibuffer }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Go To Definition Fallback", description: "Whether to follow-up empty go to definition responses from the language server", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.go_to_definition_fallback, pick_mut: |settings_content| { &mut settings_content.editor.go_to_definition_fallback }, }), metadata: None, }), SettingsPageItem::SectionHeader("Scrolling"), SettingsPageItem::SettingItem(SettingItem { title: "Scroll Beyond Last Line", description: "Whether the editor will scroll beyond the last line", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.scroll_beyond_last_line, pick_mut: |settings_content| { &mut settings_content.editor.scroll_beyond_last_line }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Vertical Scroll Margin", description: "The number of lines to keep above/below the cursor when auto-scrolling", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.vertical_scroll_margin, pick_mut: |settings_content| { &mut settings_content.editor.vertical_scroll_margin }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Horizontal Scroll Margin", description: "The number of characters to keep on either side when scrolling with the mouse", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.horizontal_scroll_margin, pick_mut: |settings_content| { &mut settings_content.editor.horizontal_scroll_margin }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Scroll Sensitivity", description: "Scroll sensitivity multiplier for both horizontal and vertical scrolling", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.scroll_sensitivity, pick_mut: |settings_content| { &mut settings_content.editor.scroll_sensitivity }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Fast Scroll Sensitivity", description: "Fast Scroll sensitivity multiplier for both horizontal and vertical scrolling", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.fast_scroll_sensitivity, pick_mut: |settings_content| { &mut settings_content.editor.fast_scroll_sensitivity }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Autoscroll On Clicks", description: "Whether to scroll when clicking near the edge of the visible text area", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.autoscroll_on_clicks, pick_mut: |settings_content| { &mut settings_content.editor.autoscroll_on_clicks }, }), metadata: None, }), SettingsPageItem::SectionHeader("Auto Actions"), SettingsPageItem::SettingItem(SettingItem { title: "Use Autoclose", description: "Whether to automatically type closing characters for you", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .use_autoclose }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .use_autoclose }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use Auto Surround", description: "Whether to automatically surround text with characters for you", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .use_auto_surround }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .use_auto_surround }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use On Type Format", description: "Whether to use additional LSP queries to format the code after every trigger symbol input", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .use_on_type_format }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .use_on_type_format }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Always Treat Brackets As Autoclosed", description: "Controls how the editor handles the autoclosed characters", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .always_treat_brackets_as_autoclosed }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .always_treat_brackets_as_autoclosed }, }), metadata: None, }), SettingsPageItem::SectionHeader("Formatting"), SettingsPageItem::SettingItem(SettingItem { title: "Remove Trailing Whitespace On Save", description: "Whether or not to remove any trailing whitespace from lines of a buffer before saving it", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .remove_trailing_whitespace_on_save }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .remove_trailing_whitespace_on_save }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Ensure Final Newline On Save", description: "Whether or not to ensure there's a single newline at the end of a buffer when saving it", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .ensure_final_newline_on_save }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .ensure_final_newline_on_save }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Extend Comment On Newline", description: "Whether to start a new line with a comment when a previous line is a comment as well", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .extend_comment_on_newline }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .extend_comment_on_newline }, }), metadata: None, }), SettingsPageItem::SectionHeader("Completions"), SettingsPageItem::SettingItem(SettingItem { title: "Show Completions On Input", description: "Whether to pop the completions menu while typing in an editor without explicitly requesting it", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_completions_on_input }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_completions_on_input }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Completion Documentation", description: "Whether to display inline and alongside documentation for items in the completions menu", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_completion_documentation }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_completion_documentation }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Auto Signature Help", description: "Whether to automatically show a signature help pop-up or not", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.auto_signature_help, pick_mut: |settings_content| { &mut settings_content.editor.auto_signature_help }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Signature Help After Edits", description: "Whether to show the signature help pop-up after completions or bracket pairs inserted", field: Box::new(SettingField { pick: |settings_content| { &settings_content.editor.show_signature_help_after_edits }, pick_mut: |settings_content| { &mut settings_content.editor.show_signature_help_after_edits }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Snippet Sort Order", description: "Determines how snippets are sorted relative to other completion items", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.snippet_sort_order, pick_mut: |settings_content| { &mut settings_content.editor.snippet_sort_order }, }), metadata: None, }), SettingsPageItem::SectionHeader("Hover"), SettingsPageItem::SettingItem(SettingItem { title: "Hover Popover Enabled", description: "Whether to show the informational hover box when moving the mouse over symbols in the editor", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.hover_popover_enabled, pick_mut: |settings_content| { &mut settings_content.editor.hover_popover_enabled }, }), metadata: None, }), // todo(settings ui): add units to this numeric stepper SettingsPageItem::SettingItem(SettingItem { title: "Hover Popover Delay", description: "Time to wait in milliseconds before showing the informational hover box", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.hover_popover_delay, pick_mut: |settings_content| { &mut settings_content.editor.hover_popover_delay }, }), metadata: None, }), SettingsPageItem::SectionHeader("Code Actions"), SettingsPageItem::SettingItem(SettingItem { title: "Inline Code Actions", description: "Whether to show code action button at start of buffer line", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.inline_code_actions, pick_mut: |settings_content| { &mut settings_content.editor.inline_code_actions }, }), metadata: None, }), SettingsPageItem::SectionHeader("Selection"), SettingsPageItem::SettingItem(SettingItem { title: "Drag And Drop Selection", description: "Whether to enable drag and drop selection", field: Box::new(SettingField { pick: |settings_content| { if let Some(drag_and_drop) = &settings_content.editor.drag_and_drop_selection { &drag_and_drop.enabled } else { &None } }, pick_mut: |settings_content| { &mut settings_content .editor .drag_and_drop_selection .get_or_insert_default() .enabled }, }), metadata: None, }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Drag And Drop Selection Delay", // description: "Delay in milliseconds before drag and drop selection starts", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(drag_and_drop) = &settings_content.editor.drag_and_drop_selection { // &drag_and_drop.delay // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content.editor.drag_and_drop_selection.get_or_insert_default().delay // }, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Line Numbers"), SettingsPageItem::SettingItem(SettingItem { title: "Relative Line Numbers", description: "Whether the line numbers on editors gutter are relative or not", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.relative_line_numbers, pick_mut: |settings_content| { &mut settings_content.editor.relative_line_numbers }, }), metadata: None, }), SettingsPageItem::SectionHeader("Gutter"), SettingsPageItem::SettingItem(SettingItem { title: "Show Line Numbers", description: "Whether to show line numbers in the gutter", field: Box::new(SettingField { pick: |settings_content| { if let Some(gutter) = &settings_content.editor.gutter { &gutter.line_numbers } else { &None } }, pick_mut: |settings_content| { &mut settings_content .editor .gutter .get_or_insert_default() .line_numbers }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Runnables", description: "Whether to show runnable buttons in the gutter", field: Box::new(SettingField { pick: |settings_content| { if let Some(gutter) = &settings_content.editor.gutter { &gutter.runnables } else { &None } }, pick_mut: |settings_content| { &mut settings_content .editor .gutter .get_or_insert_default() .runnables }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Breakpoints", description: "Whether to show breakpoints in the gutter", field: Box::new(SettingField { pick: |settings_content| { if let Some(gutter) = &settings_content.editor.gutter { &gutter.breakpoints } else { &None } }, pick_mut: |settings_content| { &mut settings_content .editor .gutter .get_or_insert_default() .breakpoints }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Folds", description: "Whether to show code folding controls in the gutter", field: Box::new(SettingField { pick: |settings_content| { if let Some(gutter) = &settings_content.editor.gutter { &gutter.folds } else { &None } }, pick_mut: |settings_content| { &mut settings_content.editor.gutter.get_or_insert_default().folds }, }), metadata: None, }), SettingsPageItem::SectionHeader("Tabs"), SettingsPageItem::SettingItem(SettingItem { title: "Show Tab Bar", description: "Whether or not to show the tab bar in the editor", field: Box::new(SettingField { pick: |settings_content| { if let Some(tab_bar) = &settings_content.tab_bar { &tab_bar.show } else { &None } }, pick_mut: |settings_content| { &mut settings_content.tab_bar.get_or_insert_default().show }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Git Status In Tabs", description: "Whether to show the Git file status on a tab item", field: Box::new(SettingField { pick: |settings_content| { if let Some(tabs) = &settings_content.tabs { &tabs.git_status } else { &None } }, pick_mut: |settings_content| { &mut settings_content.tabs.get_or_insert_default().git_status }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show File Icons In Tabs", description: "Whether to show the file icon for a tab", field: Box::new(SettingField { pick: |settings_content| { if let Some(tabs) = &settings_content.tabs { &tabs.file_icons } else { &None } }, pick_mut: |settings_content| { &mut settings_content.tabs.get_or_insert_default().file_icons }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Tab Close Position", description: "Position of the close button in a tab", field: Box::new(SettingField { pick: |settings_content| { if let Some(tabs) = &settings_content.tabs { &tabs.close_position } else { &None } }, pick_mut: |settings_content| { &mut settings_content.tabs.get_or_insert_default().close_position }, }), metadata: None, }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Maximum Tabs", // description: "Maximum open tabs in a pane. Will not close an unsaved tab", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.workspace.max_tabs, // pick_mut: |settings_content| &mut settings_content.workspace.max_tabs, // }), // metadata: None, // }), ], }, SettingsPage { title: "Languages & Frameworks", items: vec![ SettingsPageItem::SectionHeader("General"), SettingsPageItem::SettingItem(SettingItem { title: "Enable Language Server", description: "Whether to use language servers to provide code intelligence", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .enable_language_server }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .enable_language_server }, }), metadata: None, }), SettingsPageItem::SectionHeader("Languages"), SettingsPageItem::SubPageLink(SubPageLink { title: "JSON", render: Rc::new(|_, _, _| "A settings page!".into_any_element()), }), ], }, SettingsPage { title: "Workbench & Window", items: vec![ SettingsPageItem::SectionHeader("Workbench"), SettingsPageItem::SettingItem(SettingItem { title: "Editor Tabs", description: "Whether or not to show the tab bar in the editor", field: Box::new(SettingField { pick: |settings_content| { if let Some(tab_bar) = &settings_content.tab_bar { &tab_bar.show } else { &None } }, pick_mut: |settings_content| { &mut settings_content.tab_bar.get_or_insert_default().show }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Active language Button", description: "Whether to show the active language button in the status bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(status_bar) = &settings_content.status_bar { &status_bar.active_language_button } else { &None } }, pick_mut: |settings_content| { &mut settings_content .status_bar .get_or_insert_default() .active_language_button }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Cursor Position Button", description: "Whether to show the cursor position button in the status bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(status_bar) = &settings_content.status_bar { &status_bar.cursor_position_button } else { &None } }, pick_mut: |settings_content| { &mut settings_content .status_bar .get_or_insert_default() .cursor_position_button }, }), metadata: None, }), SettingsPageItem::SectionHeader("Terminal"), SettingsPageItem::SettingItem(SettingItem { title: "Terminal Button", description: "Whether to show the terminal button in the status bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(terminal) = &settings_content.terminal { &terminal.button } else { &None } }, pick_mut: |settings_content| { &mut settings_content.terminal.get_or_insert_default().button }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Navigation History Buttons", description: "Whether or not to show the navigation history buttons in the tab bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(tab_bar) = &settings_content.tab_bar { &tab_bar.show_nav_history_buttons } else { &None } }, pick_mut: |settings_content| { &mut settings_content .tab_bar .get_or_insert_default() .show_nav_history_buttons }, }), metadata: None, }), ], }, SettingsPage { title: "Panels & Tools", items: vec![ SettingsPageItem::SectionHeader("Project Panel"), SettingsPageItem::SettingItem(SettingItem { title: "Project Panel Button", description: "Whether to show the project panel button in the status bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(project_panel) = &settings_content.project_panel { &project_panel.button } else { &None } }, pick_mut: |settings_content| { &mut settings_content .project_panel .get_or_insert_default() .button }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Project Panel Dock", description: "Where to dock the project panel", field: Box::new(SettingField { pick: |settings_content| { if let Some(project_panel) = &settings_content.project_panel { &project_panel.dock } else { &None } }, pick_mut: |settings_content| { &mut settings_content.project_panel.get_or_insert_default().dock }, }), metadata: None, }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Project Panel Default Width", // description: "Default width of the project panel in pixels", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(project_panel) = &settings_content.project_panel { // &project_panel.default_width // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content // .project_panel // .get_or_insert_default() // .default_width // }, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Terminal"), SettingsPageItem::SettingItem(SettingItem { title: "Terminal Dock", description: "Where to dock the terminal panel", field: Box::new(SettingField { pick: |settings_content| { if let Some(terminal) = &settings_content.terminal { &terminal.dock } else { &None } }, pick_mut: |settings_content| { &mut settings_content.terminal.get_or_insert_default().dock }, }), metadata: None, }), SettingsPageItem::SectionHeader("Tab Settings"), SettingsPageItem::SettingItem(SettingItem { title: "Activate On Close", description: "What to do after closing the current tab", field: Box::new(SettingField { pick: |settings_content| { if let Some(tabs) = &settings_content.tabs { &tabs.activate_on_close } else { &None } }, pick_mut: |settings_content| { &mut settings_content .tabs .get_or_insert_default() .activate_on_close }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Tab Show Diagnostics", description: "Which files containing diagnostic errors/warnings to mark in the tabs", field: Box::new(SettingField { pick: |settings_content| { if let Some(tabs) = &settings_content.tabs { &tabs.show_diagnostics } else { &None } }, pick_mut: |settings_content| { &mut settings_content .tabs .get_or_insert_default() .show_diagnostics }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Close Button", description: "Controls the appearance behavior of the tab's close button", field: Box::new(SettingField { pick: |settings_content| { if let Some(tabs) = &settings_content.tabs { &tabs.show_close_button } else { &None } }, pick_mut: |settings_content| { &mut settings_content .tabs .get_or_insert_default() .show_close_button }, }), metadata: None, }), SettingsPageItem::SectionHeader("Preview Tabs"), SettingsPageItem::SettingItem(SettingItem { title: "Preview Tabs Enabled", description: "Whether to show opened editors as preview tabs", field: Box::new(SettingField { pick: |settings_content| { if let Some(preview_tabs) = &settings_content.preview_tabs { &preview_tabs.enabled } else { &None } }, pick_mut: |settings_content| { &mut settings_content .preview_tabs .get_or_insert_default() .enabled }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Enable Preview From File Finder", description: "Whether to open tabs in preview mode when selected from the file finder", field: Box::new(SettingField { pick: |settings_content| { if let Some(preview_tabs) = &settings_content.preview_tabs { &preview_tabs.enable_preview_from_file_finder } else { &None } }, pick_mut: |settings_content| { &mut settings_content .preview_tabs .get_or_insert_default() .enable_preview_from_file_finder }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Enable Preview From Code Navigation", description: "Whether a preview tab gets replaced when code navigation is used to navigate away from the tab", field: Box::new(SettingField { pick: |settings_content| { if let Some(preview_tabs) = &settings_content.preview_tabs { &preview_tabs.enable_preview_from_code_navigation } else { &None } }, pick_mut: |settings_content| { &mut settings_content .preview_tabs .get_or_insert_default() .enable_preview_from_code_navigation }, }), metadata: None, }), ], }, SettingsPage { title: "Version Control", items: vec![ SettingsPageItem::SectionHeader("Git"), SettingsPageItem::SettingItem(SettingItem { title: "Git Gutter", description: "Control whether the git gutter is shown", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { &git.git_gutter } else { &None } }, pick_mut: |settings_content| { &mut settings_content.git.get_or_insert_default().git_gutter }, }), metadata: None, }), // todo(settings_ui): Figure out the right default for this value in default.json // SettingsPageItem::SettingItem(SettingItem { // title: "Gutter Debounce", // description: "Debounce threshold in milliseconds after which changes are reflected in the git gutter", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(git) = &settings_content.git { // &git.gutter_debounce // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content.git.get_or_insert_default().gutter_debounce // }, // }), // metadata: None, // }), SettingsPageItem::SettingItem(SettingItem { title: "Inline Blame Enabled", description: "Whether or not to show git blame data inline in the currently focused line", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(inline_blame) = &git.inline_blame { &inline_blame.enabled } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .inline_blame .get_or_insert_default() .enabled }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Inline Blame Delay", description: "The delay after which the inline blame information is shown", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(inline_blame) = &git.inline_blame { &inline_blame.delay_ms } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .inline_blame .get_or_insert_default() .delay_ms }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Inline Blame Padding", description: "Padding between the end of the source line and the start of the inline blame in columns", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(inline_blame) = &git.inline_blame { &inline_blame.padding } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .inline_blame .get_or_insert_default() .padding }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Inline Blame Min Column", description: "The minimum column number to show the inline blame information at", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(inline_blame) = &git.inline_blame { &inline_blame.min_column } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .inline_blame .get_or_insert_default() .min_column }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Commit Summary", description: "Whether to show commit summary as part of the inline blame", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(inline_blame) = &git.inline_blame { &inline_blame.show_commit_summary } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .inline_blame .get_or_insert_default() .show_commit_summary }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Avatar", description: "Whether to show the avatar of the author of the commit", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(blame) = &git.blame { &blame.show_avatar } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .blame .get_or_insert_default() .show_avatar }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Author Name In Branch Picker", description: "Whether to show author name as part of the commit information in branch picker", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { if let Some(branch_picker) = &git.branch_picker { &branch_picker.show_author_name } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .git .get_or_insert_default() .branch_picker .get_or_insert_default() .show_author_name }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Hunk Style", description: "How git hunks are displayed visually in the editor", field: Box::new(SettingField { pick: |settings_content| { if let Some(git) = &settings_content.git { &git.hunk_style } else { &None } }, pick_mut: |settings_content| { &mut settings_content.git.get_or_insert_default().hunk_style }, }), metadata: None, }), ], }, SettingsPage { title: "System & Network", items: vec![ SettingsPageItem::SectionHeader("Network"), // todo(settings_ui): Proxy needs a default // SettingsPageItem::SettingItem(SettingItem { // title: "Proxy", // description: "The proxy to use for network requests", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.proxy, // pick_mut: |settings_content| &mut settings_content.proxy, // }), // metadata: Some(Box::new(SettingsFieldMetadata { // placeholder: Some("socks5h://localhost:10808"), // })), // }), SettingsPageItem::SettingItem(SettingItem { title: "Server URL", description: "The URL of the Zed server to connect to", field: Box::new(SettingField { pick: |settings_content| &settings_content.server_url, pick_mut: |settings_content| &mut settings_content.server_url, }), metadata: Some(Box::new(SettingsFieldMetadata { placeholder: Some("https://zed.dev"), })), }), SettingsPageItem::SectionHeader("System"), SettingsPageItem::SettingItem(SettingItem { title: "Auto Update", description: "Whether or not to automatically check for updates", field: Box::new(SettingField { pick: |settings_content| &settings_content.auto_update, pick_mut: |settings_content| &mut settings_content.auto_update, }), metadata: None, }), ], }, SettingsPage { title: "Diagnostics & Errors", items: vec![ SettingsPageItem::SectionHeader("Display"), SettingsPageItem::SettingItem(SettingItem { title: "Diagnostics Button", description: "Whether to show the project diagnostics button in the status bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(diagnostics) = &settings_content.diagnostics { &diagnostics.button } else { &None } }, pick_mut: |settings_content| { &mut settings_content.diagnostics.get_or_insert_default().button }, }), metadata: None, }), SettingsPageItem::SectionHeader("Filtering"), SettingsPageItem::SettingItem(SettingItem { title: "Max Severity", description: "Which level to use to filter out diagnostics displayed in the editor", field: Box::new(SettingField { pick: |settings_content| &settings_content.editor.diagnostics_max_severity, pick_mut: |settings_content| { &mut settings_content.editor.diagnostics_max_severity }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Include Warnings", description: "Whether to show warnings or not by default", field: Box::new(SettingField { pick: |settings_content| { if let Some(diagnostics) = &settings_content.diagnostics { &diagnostics.include_warnings } else { &None } }, pick_mut: |settings_content| { &mut settings_content .diagnostics .get_or_insert_default() .include_warnings }, }), metadata: None, }), SettingsPageItem::SectionHeader("Inline"), SettingsPageItem::SettingItem(SettingItem { title: "Inline Diagnostics Enabled", description: "Whether to show diagnostics inline or not", field: Box::new(SettingField { pick: |settings_content| { if let Some(diagnostics) = &settings_content.diagnostics { if let Some(inline) = &diagnostics.inline { &inline.enabled } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .diagnostics .get_or_insert_default() .inline .get_or_insert_default() .enabled }, }), metadata: None, }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Inline Update Debounce", // description: "The delay in milliseconds to show inline diagnostics after the last diagnostic update", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(diagnostics) = &settings_content.diagnostics { // if let Some(inline) = &diagnostics.inline { // &inline.update_debounce_ms // } else { // &None // } // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content // .diagnostics // .get_or_insert_default() // .inline // .get_or_insert_default() // .update_debounce_ms // }, // }), // metadata: None, // }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Inline Padding", // description: "The amount of padding between the end of the source line and the start of the inline diagnostic", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(diagnostics) = &settings_content.diagnostics { // if let Some(inline) = &diagnostics.inline { // &inline.padding // } else { // &None // } // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content // .diagnostics // .get_or_insert_default() // .inline // .get_or_insert_default() // .padding // }, // }), // metadata: None, // }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Inline Min Column", // description: "The minimum column to display inline diagnostics", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(diagnostics) = &settings_content.diagnostics { // if let Some(inline) = &diagnostics.inline { // &inline.min_column // } else { // &None // } // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content // .diagnostics // .get_or_insert_default() // .inline // .get_or_insert_default() // .min_column // }, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Performance"), SettingsPageItem::SettingItem(SettingItem { title: "LSP Pull Diagnostics Enabled", description: "Whether to pull for diagnostics or not", field: Box::new(SettingField { pick: |settings_content| { if let Some(diagnostics) = &settings_content.diagnostics { if let Some(lsp_pull) = &diagnostics.lsp_pull_diagnostics { &lsp_pull.enabled } else { &None } } else { &None } }, pick_mut: |settings_content| { &mut settings_content .diagnostics .get_or_insert_default() .lsp_pull_diagnostics .get_or_insert_default() .enabled }, }), metadata: None, }), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "LSP Pull Debounce", // description: "Minimum time to wait before pulling diagnostics from the language server(s)", // field: Box::new(SettingField { // pick: |settings_content| { // if let Some(diagnostics) = &settings_content.diagnostics { // if let Some(lsp_pull) = &diagnostics.lsp_pull_diagnostics { // &lsp_pull.debounce_ms // } else { // &None // } // } else { // &None // } // }, // pick_mut: |settings_content| { // &mut settings_content // .diagnostics // .get_or_insert_default() // .lsp_pull_diagnostics // .get_or_insert_default() // .debounce_ms // }, // }), // metadata: None, // }), ], }, SettingsPage { title: "Collaboration", items: vec![ SettingsPageItem::SectionHeader("Calls"), SettingsPageItem::SettingItem(SettingItem { title: "Mute On Join", description: "Whether the microphone should be muted when joining a channel or a call", field: Box::new(SettingField { pick: |settings_content| { if let Some(calls) = &settings_content.calls { &calls.mute_on_join } else { &None } }, pick_mut: |settings_content| { &mut settings_content.calls.get_or_insert_default().mute_on_join }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Share On Join", description: "Whether your current project should be shared when joining an empty channel", field: Box::new(SettingField { pick: |settings_content| { if let Some(calls) = &settings_content.calls { &calls.share_on_join } else { &None } }, pick_mut: |settings_content| { &mut settings_content.calls.get_or_insert_default().share_on_join }, }), metadata: None, }), SettingsPageItem::SectionHeader("Panel"), SettingsPageItem::SettingItem(SettingItem { title: "Collaboration Panel Button", description: "Whether to show the collaboration panel button in the status bar", field: Box::new(SettingField { pick: |settings_content| { if let Some(collab) = &settings_content.collaboration_panel { &collab.button } else { &None } }, pick_mut: |settings_content| { &mut settings_content .collaboration_panel .get_or_insert_default() .button }, }), metadata: None, }), SettingsPageItem::SectionHeader("Experimental"), SettingsPageItem::SettingItem(SettingItem { title: "Rodio Audio", description: "Opt into the new audio system", field: Box::new(SettingField { pick: |settings_content| { if let Some(audio) = &settings_content.audio { &audio.rodio_audio } else { &None } }, pick_mut: |settings_content| { &mut settings_content.audio.get_or_insert_default().rodio_audio }, }), metadata: None, }), ], }, SettingsPage { title: "AI", items: vec![ SettingsPageItem::SectionHeader("General"), SettingsPageItem::SettingItem(SettingItem { title: "Disable AI", description: "Whether to disable all AI features in Zed", field: Box::new(SettingField { pick: |settings_content| &settings_content.disable_ai, pick_mut: |settings_content| &mut settings_content.disable_ai, }), metadata: None, }), ], }, ] } // Derive Macro, on the new ProjectSettings struct fn project_settings_data() -> Vec { vec![ SettingsPage { title: "Project", items: vec![ SettingsPageItem::SectionHeader("Worktree Settings Content"), SettingsPageItem::SettingItem(SettingItem { title: "Project Name", description: "The displayed name of this project. If not set, the root directory name", field: Box::new(SettingField { pick: |settings_content| &settings_content.project.worktree.project_name, pick_mut: |settings_content| { &mut settings_content.project.worktree.project_name }, }), metadata: Some(Box::new(SettingsFieldMetadata { placeholder: Some("A new name"), })), }), ], }, SettingsPage { title: "Appearance & Behavior", items: vec![ SettingsPageItem::SectionHeader("Guides"), SettingsPageItem::SettingItem(SettingItem { title: "Show Wrap Guides", description: "Whether to show wrap guides (vertical rulers)", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_wrap_guides }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_wrap_guides }, }), metadata: None, }), // todo(settings_ui): This needs a custom component // SettingsPageItem::SettingItem(SettingItem { // title: "Wrap Guides", // description: "Character counts at which to show wrap guides", // field: Box::new(SettingField { // pick: |settings_content| { // &settings_content // .project // .all_languages // .defaults // .wrap_guides // }, // pick_mut: |settings_content| { // &mut settings_content // .project // .all_languages // .defaults // .wrap_guides // }, // }), // metadata: None, // }), SettingsPageItem::SectionHeader("Whitespace"), SettingsPageItem::SettingItem(SettingItem { title: "Show Whitespace", description: "Whether to show tabs and spaces", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_whitespaces }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_whitespaces }, }), metadata: None, }), ], }, SettingsPage { title: "Editing", items: vec![ SettingsPageItem::SectionHeader("Indentation"), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Tab Size", // description: "How many columns a tab should occupy", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.project.all_languages.defaults.tab_size, // pick_mut: |settings_content| &mut settings_content.project.all_languages.defaults.tab_size, // }), // metadata: None, // }), SettingsPageItem::SettingItem(SettingItem { title: "Hard Tabs", description: "Whether to indent lines using tab characters, as opposed to multiple spaces", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.hard_tabs }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.hard_tabs }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Auto Indent", description: "Whether indentation should be adjusted based on the context whilst typing", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.auto_indent }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.auto_indent }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Auto Indent On Paste", description: "Whether indentation of pasted content should be adjusted based on the context", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .auto_indent_on_paste }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .auto_indent_on_paste }, }), metadata: None, }), SettingsPageItem::SectionHeader("Wrapping"), // todo(settings_ui): Needs numeric stepper // SettingsPageItem::SettingItem(SettingItem { // title: "Preferred Line Length", // description: "The column at which to soft-wrap lines, for buffers where soft-wrap is enabled", // field: Box::new(SettingField { // pick: |settings_content| &settings_content.project.all_languages.defaults.preferred_line_length, // pick_mut: |settings_content| &mut settings_content.project.all_languages.defaults.preferred_line_length, // }), // metadata: None, // }), SettingsPageItem::SettingItem(SettingItem { title: "Soft Wrap", description: "How to soft-wrap long lines of text", field: Box::new(SettingField { pick: |settings_content| { &settings_content.project.all_languages.defaults.soft_wrap }, pick_mut: |settings_content| { &mut settings_content.project.all_languages.defaults.soft_wrap }, }), metadata: None, }), SettingsPageItem::SectionHeader("Auto Actions"), SettingsPageItem::SettingItem(SettingItem { title: "Use Autoclose", description: "Whether to automatically type closing characters for you", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .use_autoclose }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .use_autoclose }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use Auto Surround", description: "Whether to automatically surround text with characters for you", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .use_auto_surround }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .use_auto_surround }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Use On Type Format", description: "Whether to use additional LSP queries to format the code after every trigger symbol input", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .use_on_type_format }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .use_on_type_format }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Always Treat Brackets As Autoclosed", description: "Controls how the editor handles the autoclosed characters", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .always_treat_brackets_as_autoclosed }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .always_treat_brackets_as_autoclosed }, }), metadata: None, }), SettingsPageItem::SectionHeader("Formatting"), SettingsPageItem::SettingItem(SettingItem { title: "Remove Trailing Whitespace On Save", description: "Whether or not to remove any trailing whitespace from lines of a buffer before saving it", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .remove_trailing_whitespace_on_save }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .remove_trailing_whitespace_on_save }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Ensure Final Newline On Save", description: "Whether or not to ensure there's a single newline at the end of a buffer when saving it", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .ensure_final_newline_on_save }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .ensure_final_newline_on_save }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Extend Comment On Newline", description: "Whether to start a new line with a comment when a previous line is a comment as well", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .extend_comment_on_newline }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .extend_comment_on_newline }, }), metadata: None, }), SettingsPageItem::SectionHeader("Completions"), SettingsPageItem::SettingItem(SettingItem { title: "Show Completions On Input", description: "Whether to pop the completions menu while typing in an editor without explicitly requesting it", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_completions_on_input }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_completions_on_input }, }), metadata: None, }), SettingsPageItem::SettingItem(SettingItem { title: "Show Completion Documentation", description: "Whether to display inline and alongside documentation for items in the completions menu", field: Box::new(SettingField { pick: |settings_content| { &settings_content .project .all_languages .defaults .show_completion_documentation }, pick_mut: |settings_content| { &mut settings_content .project .all_languages .defaults .show_completion_documentation }, }), metadata: None, }), ], }, ] } pub struct SettingsUiFeatureFlag; impl FeatureFlag for SettingsUiFeatureFlag { const NAME: &'static str = "settings-ui"; } pub fn init(cx: &mut App) { init_renderers(cx); cx.observe_new(|workspace: &mut workspace::Workspace, _, _| { workspace.register_action_renderer(|div, _, _, cx| { let settings_ui_actions = [std::any::TypeId::of::()]; let has_flag = cx.has_flag::(); command_palette_hooks::CommandPaletteFilter::update_global(cx, |filter, _| { if has_flag { filter.show_action_types(&settings_ui_actions); } else { filter.hide_action_types(&settings_ui_actions); } }); if has_flag { div.on_action(cx.listener(|_, _: &OpenSettingsEditor, _, cx| { open_settings_editor(cx).ok(); })) } else { div } }); }) .detach(); } fn init_renderers(cx: &mut App) { // fn (field: SettingsField, current_file: SettingsFile, cx) -> (currently_set_in: SettingsFile, overridden_in: Vec) cx.default_global::() .add_renderer::(|settings_field, file, _, _, cx| { render_toggle_button(*settings_field, file, cx).into_any_element() }) .add_renderer::(|settings_field, file, metadata, _, cx| { render_text_field(settings_field.clone(), file, metadata, cx) }) .add_renderer::(|settings_field, file, _, _, cx| { render_toggle_button(*settings_field, file, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { // todo(settings_ui): We need to pass in a validator for this to ensure that users that type in invalid font names render_font_picker(settings_field.clone(), file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { // todo(settings_ui): Do we want to expose the custom variant of buffer line height? // right now there's a manual impl of strum::VariantArray render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::( |settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }, ) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::( |settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }, ) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_dropdown(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_numeric_stepper(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_numeric_stepper(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_numeric_stepper(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_numeric_stepper(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_numeric_stepper(*settings_field, file, window, cx) }) .add_renderer::(|settings_field, file, _, window, cx| { render_numeric_stepper(*settings_field, file, window, cx) }); // todo(settings_ui): Figure out how we want to handle discriminant unions // .add_renderer::(|settings_field, file, _, window, cx| { // render_dropdown(*settings_field, file, window, cx) // }); } pub fn open_settings_editor(cx: &mut App) -> anyhow::Result> { cx.open_window( WindowOptions { titlebar: Some(TitlebarOptions { title: Some("Settings Window".into()), appears_transparent: true, traffic_light_position: Some(point(px(12.0), px(12.0))), }), focus: true, show: true, kind: gpui::WindowKind::Normal, window_background: cx.theme().window_background_appearance(), window_min_size: Some(size(px(800.), px(600.))), // 4:3 Aspect Ratio ..Default::default() }, |window, cx| cx.new(|cx| SettingsWindow::new(window, cx)), ) } pub struct SettingsWindow { files: Vec, current_file: SettingsUiFile, pages: Vec, search_bar: Entity, search_task: Option>, navbar_entry: usize, // Index into pages - should probably be (usize, Option) for section + page navbar_entries: Vec, list_handle: UniformListScrollHandle, search_matches: Vec>, /// The current sub page path that is selected. /// If this is empty the selected page is rendered, /// otherwise the last sub page gets rendered. sub_page_stack: Vec, scroll_handle: ScrollHandle, } struct SubPage { link: SubPageLink, section_header: &'static str, } #[derive(PartialEq, Debug)] struct NavBarEntry { title: &'static str, is_root: bool, expanded: bool, page_index: usize, item_index: Option, } struct SettingsPage { title: &'static str, items: Vec, } #[derive(PartialEq)] enum SettingsPageItem { SectionHeader(&'static str), SettingItem(SettingItem), SubPageLink(SubPageLink), } impl std::fmt::Debug for SettingsPageItem { fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result { match self { SettingsPageItem::SectionHeader(header) => write!(f, "SectionHeader({})", header), SettingsPageItem::SettingItem(setting_item) => { write!(f, "SettingItem({})", setting_item.title) } SettingsPageItem::SubPageLink(sub_page_link) => { write!(f, "SubPageLink({})", sub_page_link.title) } } } } impl SettingsPageItem { fn render( &self, file: SettingsUiFile, section_header: &'static str, is_last: bool, window: &mut Window, cx: &mut Context, ) -> AnyElement { match self { SettingsPageItem::SectionHeader(header) => v_flex() .w_full() .gap_1() .child( Label::new(SharedString::new_static(header)) .size(LabelSize::XSmall) .color(Color::Muted) .buffer_font(cx), ) .child(Divider::horizontal().color(ui::DividerColor::BorderVariant)) .into_any_element(), SettingsPageItem::SettingItem(setting_item) => { let renderer = cx.default_global::().clone(); let file_set_in = SettingsUiFile::from_settings(setting_item.field.file_set_in(file.clone(), cx)); h_flex() .id(setting_item.title) .w_full() .gap_2() .flex_wrap() .justify_between() .map(|this| { if is_last { this.pb_6() } else { this.pb_4() .border_b_1() .border_color(cx.theme().colors().border_variant) } }) .child( v_flex() .max_w_1_2() .flex_shrink() .child( h_flex() .w_full() .gap_1() .child(Label::new(SharedString::new_static(setting_item.title))) .when_some( file_set_in.filter(|file_set_in| file_set_in != &file), |this, file_set_in| { this.child( Label::new(format!( "— set in {}", file_set_in.name() )) .color(Color::Muted) .size(LabelSize::Small), ) }, ), ) .child( Label::new(SharedString::new_static(setting_item.description)) .size(LabelSize::Small) .color(Color::Muted), ), ) .child(renderer.render( setting_item.field.as_ref(), file, setting_item.metadata.as_deref(), window, cx, )) .into_any_element() } SettingsPageItem::SubPageLink(sub_page_link) => h_flex() .id(sub_page_link.title) .w_full() .gap_2() .flex_wrap() .justify_between() .when(!is_last, |this| { this.pb_4() .border_b_1() .border_color(cx.theme().colors().border_variant) }) .child( v_flex() .max_w_1_2() .flex_shrink() .child(Label::new(SharedString::new_static(sub_page_link.title))), ) .child( Button::new(("sub-page".into(), sub_page_link.title), "Configure") .size(ButtonSize::Medium) .icon(IconName::ChevronRight) .icon_position(IconPosition::End) .icon_color(Color::Muted) .icon_size(IconSize::Small) .style(ButtonStyle::Outlined), ) .on_click({ let sub_page_link = sub_page_link.clone(); cx.listener(move |this, _, _, cx| { this.push_sub_page(sub_page_link.clone(), section_header, cx) }) }) .into_any_element(), } } } struct SettingItem { title: &'static str, description: &'static str, field: Box, metadata: Option>, } impl PartialEq for SettingItem { fn eq(&self, other: &Self) -> bool { self.title == other.title && self.description == other.description && (match (&self.metadata, &other.metadata) { (None, None) => true, (Some(m1), Some(m2)) => m1.placeholder == m2.placeholder, _ => false, }) } } #[derive(Clone)] struct SubPageLink { title: &'static str, render: Rc AnyElement>, } impl PartialEq for SubPageLink { fn eq(&self, other: &Self) -> bool { self.title == other.title } } #[allow(unused)] #[derive(Clone, PartialEq)] enum SettingsUiFile { User, // Uses all settings. Local((WorktreeId, Arc)), // Has a special name, and special set of settings Server(&'static str), // Uses a special name, and the user settings } impl SettingsUiFile { fn pages(&self) -> Vec { match self { SettingsUiFile::User => user_settings_data(), SettingsUiFile::Local(_) => project_settings_data(), SettingsUiFile::Server(_) => user_settings_data(), } } fn name(&self) -> SharedString { match self { SettingsUiFile::User => SharedString::new_static("User"), // TODO is PathStyle::local() ever not appropriate? SettingsUiFile::Local((_, path)) => { format!("Local ({})", path.display(PathStyle::local())).into() } SettingsUiFile::Server(file) => format!("Server ({})", file).into(), } } fn from_settings(file: settings::SettingsFile) -> Option { Some(match file { settings::SettingsFile::User => SettingsUiFile::User, settings::SettingsFile::Local(location) => SettingsUiFile::Local(location), settings::SettingsFile::Server => SettingsUiFile::Server("todo: server name"), settings::SettingsFile::Default => return None, }) } fn to_settings(&self) -> settings::SettingsFile { match self { SettingsUiFile::User => settings::SettingsFile::User, SettingsUiFile::Local(location) => settings::SettingsFile::Local(location.clone()), SettingsUiFile::Server(_) => settings::SettingsFile::Server, } } } impl SettingsWindow { pub fn new(window: &mut Window, cx: &mut Context) -> Self { let font_family_cache = theme::FontFamilyCache::global(cx); cx.spawn(async move |this, cx| { font_family_cache.prefetch(cx).await; this.update(cx, |_, cx| { cx.notify(); }) }) .detach(); let current_file = SettingsUiFile::User; let search_bar = cx.new(|cx| { let mut editor = Editor::single_line(window, cx); editor.set_placeholder_text("Search settings…", window, cx); editor }); cx.subscribe(&search_bar, |this, _, event: &EditorEvent, cx| { let EditorEvent::Edited { transaction_id: _ } = event else { return; }; this.update_matches(cx); }) .detach(); cx.observe_global_in::(window, move |this, _, cx| { this.fetch_files(cx); cx.notify(); }) .detach(); let mut this = Self { files: vec![], current_file: current_file, pages: vec![], navbar_entries: vec![], navbar_entry: 0, list_handle: UniformListScrollHandle::default(), search_bar, search_task: None, search_matches: vec![], sub_page_stack: vec![], scroll_handle: ScrollHandle::new(), }; this.fetch_files(cx); this.build_ui(cx); this.search_bar.update(cx, |editor, cx| { editor.focus_handle(cx).focus(window); }); this } fn toggle_navbar_entry(&mut self, ix: usize) { // We can only toggle root entries if !self.navbar_entries[ix].is_root { return; } let toggle_page_index = self.page_index_from_navbar_index(ix); let selected_page_index = self.page_index_from_navbar_index(self.navbar_entry); let expanded = &mut self.navbar_entries[ix].expanded; *expanded = !*expanded; // if currently selected page is a child of the parent page we are folding, // set the current page to the parent page if !*expanded && selected_page_index == toggle_page_index { self.navbar_entry = ix; } } fn build_navbar(&mut self) { let mut navbar_entries = Vec::with_capacity(self.navbar_entries.len()); for (page_index, page) in self.pages.iter().enumerate() { navbar_entries.push(NavBarEntry { title: page.title, is_root: true, expanded: false, page_index, item_index: None, }); for (item_index, item) in page.items.iter().enumerate() { let SettingsPageItem::SectionHeader(title) = item else { continue; }; navbar_entries.push(NavBarEntry { title, is_root: false, expanded: false, page_index, item_index: Some(item_index), }); } } self.navbar_entries = navbar_entries; } fn visible_navbar_entries(&self) -> impl Iterator { let mut index = 0; let entries = &self.navbar_entries; let search_matches = &self.search_matches; std::iter::from_fn(move || { while index < entries.len() { let entry = &entries[index]; let included_in_search = if let Some(item_index) = entry.item_index { search_matches[entry.page_index][item_index] } else { search_matches[entry.page_index].iter().any(|b| *b) || search_matches[entry.page_index].is_empty() }; if included_in_search { break; } index += 1; } if index >= self.navbar_entries.len() { return None; } let entry = &entries[index]; let entry_index = index; index += 1; if entry.is_root && !entry.expanded { while index < entries.len() { if entries[index].is_root { break; } index += 1; } } return Some((entry_index, entry)); }) } fn update_matches(&mut self, cx: &mut Context) { self.search_task.take(); let query = self.search_bar.read(cx).text(cx); if query.is_empty() { for page in &mut self.search_matches { page.fill(true); } cx.notify(); return; } struct ItemKey { page_index: usize, header_index: usize, item_index: usize, } let mut key_lut: Vec = vec![]; let mut candidates = Vec::default(); for (page_index, page) in self.pages.iter().enumerate() { let mut header_index = 0; for (item_index, item) in page.items.iter().enumerate() { let key_index = key_lut.len(); match item { SettingsPageItem::SettingItem(item) => { candidates.push(StringMatchCandidate::new(key_index, item.title)); candidates.push(StringMatchCandidate::new(key_index, item.description)); } SettingsPageItem::SectionHeader(header) => { candidates.push(StringMatchCandidate::new(key_index, header)); header_index = item_index; } SettingsPageItem::SubPageLink(sub_page_link) => { candidates.push(StringMatchCandidate::new(key_index, sub_page_link.title)); } } key_lut.push(ItemKey { page_index, header_index, item_index, }); } } let atomic_bool = AtomicBool::new(false); self.search_task = Some(cx.spawn(async move |this, cx| { let string_matches = fuzzy::match_strings( candidates.as_slice(), &query, false, true, candidates.len(), &atomic_bool, cx.background_executor().clone(), ); let string_matches = string_matches.await; this.update(cx, |this, cx| { for page in &mut this.search_matches { page.fill(false); } for string_match in string_matches { let ItemKey { page_index, header_index, item_index, } = key_lut[string_match.candidate_id]; let page = &mut this.search_matches[page_index]; page[header_index] = true; page[item_index] = true; } let first_navbar_entry_index = this .visible_navbar_entries() .next() .map(|e| e.0) .unwrap_or(0); this.navbar_entry = first_navbar_entry_index; cx.notify(); }) .ok(); })); } fn build_search_matches(&mut self) { self.search_matches = self .pages .iter() .map(|page| vec![true; page.items.len()]) .collect::>(); } fn build_ui(&mut self, cx: &mut Context) { self.pages = self.current_file.pages(); self.build_search_matches(); self.build_navbar(); if !self.search_bar.read(cx).is_empty(cx) { self.update_matches(cx); } cx.notify(); } fn fetch_files(&mut self, cx: &mut Context) { let settings_store = cx.global::(); let mut ui_files = vec![]; let all_files = settings_store.get_all_files(); for file in all_files { let Some(settings_ui_file) = SettingsUiFile::from_settings(file) else { continue; }; ui_files.push(settings_ui_file); } ui_files.reverse(); self.files = ui_files; if !self.files.contains(&self.current_file) { self.change_file(0, cx); } } fn change_file(&mut self, ix: usize, cx: &mut Context) { if ix >= self.files.len() { self.current_file = SettingsUiFile::User; return; } if self.files[ix] == self.current_file { return; } self.current_file = self.files[ix].clone(); self.navbar_entry = 0; self.build_ui(cx); } fn render_files(&self, _window: &mut Window, cx: &mut Context) -> Div { h_flex() .gap_1() .children(self.files.iter().enumerate().map(|(ix, file)| { Button::new(ix, file.name()) .toggle_state(file == &self.current_file) .selected_style(ButtonStyle::Tinted(ui::TintColor::Accent)) .on_click(cx.listener(move |this, _, _window, cx| this.change_file(ix, cx))) })) } fn render_search(&self, _window: &mut Window, cx: &mut App) -> Div { h_flex() .py_1() .px_1p5() .gap_1p5() .rounded_sm() .bg(cx.theme().colors().editor_background) .border_1() .border_color(cx.theme().colors().border) .child(Icon::new(IconName::MagnifyingGlass).color(Color::Muted)) .child(self.search_bar.clone()) } fn render_nav( &self, window: &mut Window, cx: &mut Context, ) -> impl IntoElement { let visible_entries: Vec<_> = self.visible_navbar_entries().collect(); let visible_count = visible_entries.len(); v_flex() .w_64() .p_2p5() .pt_10() .gap_3() .flex_none() .border_r_1() .border_color(cx.theme().colors().border) .bg(cx.theme().colors().panel_background) .child(self.render_search(window, cx)) .child( v_flex() .size_full() .child( uniform_list( "settings-ui-nav-bar", visible_count, cx.processor(move |this, range: Range, _, cx| { let entries: Vec<_> = this.visible_navbar_entries().collect(); range .filter_map(|ix| entries.get(ix).copied()) .map(|(ix, entry)| { TreeViewItem::new( ("settings-ui-navbar-entry", ix), entry.title, ) .root_item(entry.is_root) .toggle_state(this.is_navbar_entry_selected(ix)) .when(entry.is_root, |item| { item.expanded(entry.expanded).on_toggle(cx.listener( move |this, _, _, cx| { this.toggle_navbar_entry(ix); cx.notify(); }, )) }) .on_click(cx.listener(move |this, _, _, cx| { this.navbar_entry = ix; cx.notify(); })) .into_any_element() }) .collect() }), ) .track_scroll(self.list_handle.clone()) .flex_grow(), ) .vertical_scrollbar_for(self.list_handle.clone(), window, cx), ) } fn page_items(&self) -> impl Iterator { let page_idx = self.current_page_index(); self.current_page() .items .iter() .enumerate() .filter_map(move |(item_index, item)| { self.search_matches[page_idx][item_index].then_some(item) }) } fn render_sub_page_breadcrumbs(&self) -> impl IntoElement { let mut items = vec![]; items.push(self.current_page().title); items.extend( self.sub_page_stack .iter() .flat_map(|page| [page.section_header, page.link.title]), ); let last = items.pop().unwrap(); h_flex() .gap_1() .children( items .into_iter() .flat_map(|item| [item, "/"]) .map(|item| Label::new(item).color(Color::Muted)), ) .child(Label::new(last)) } fn render_page( &mut self, window: &mut Window, cx: &mut Context, ) -> impl IntoElement { let mut page = v_flex() .w_full() .pt_4() .pb_6() .px_6() .gap_4() .bg(cx.theme().colors().editor_background) .vertical_scrollbar_for(self.scroll_handle.clone(), window, cx); let mut page_content = v_flex() .id("settings-ui-page") .size_full() .gap_4() .overflow_y_scroll() .track_scroll(&self.scroll_handle); if self.sub_page_stack.len() == 0 { page = page.child(self.render_files(window, cx)); let items: Vec<_> = self.page_items().collect(); let items_len = items.len(); let mut section_header = None; let search_query = self.search_bar.read(cx).text(cx); let has_active_search = !search_query.is_empty(); let has_no_results = items_len == 0 && has_active_search; if has_no_results { page_content = page_content.child( v_flex() .size_full() .items_center() .justify_center() .gap_1() .child(div().child("No Results")) .child( div() .text_sm() .text_color(cx.theme().colors().text_muted) .child(format!("No settings match \"{}\"", search_query)), ), ) } else { let last_non_header_index = items .iter() .enumerate() .rev() .find(|(_, item)| !matches!(item, SettingsPageItem::SectionHeader(_))) .map(|(index, _)| index); page_content = page_content.children(items.clone().into_iter().enumerate().map( |(index, item)| { let no_bottom_border = items .get(index + 1) .map(|next_item| { matches!(next_item, SettingsPageItem::SectionHeader(_)) }) .unwrap_or(false); let is_last = Some(index) == last_non_header_index; if let SettingsPageItem::SectionHeader(header) = item { section_header = Some(*header); } item.render( self.current_file.clone(), section_header.expect("All items rendered after a section header"), no_bottom_border || is_last, window, cx, ) }, )) } } else { page = page.child( h_flex() .ml_neg_1p5() .gap_1() .child( IconButton::new("back-btn", IconName::ArrowLeft) .icon_size(IconSize::Small) .shape(IconButtonShape::Square) .on_click(cx.listener(|this, _, _, cx| { this.pop_sub_page(cx); })), ) .child(self.render_sub_page_breadcrumbs()), ); let active_page_render_fn = self.sub_page_stack.last().unwrap().link.render.clone(); page_content = page_content.child((active_page_render_fn)(self, window, cx)); } return page.child(page_content); } fn current_page_index(&self) -> usize { self.page_index_from_navbar_index(self.navbar_entry) } fn current_page(&self) -> &SettingsPage { &self.pages[self.current_page_index()] } fn page_index_from_navbar_index(&self, index: usize) -> usize { if self.navbar_entries.is_empty() { return 0; } self.navbar_entries[index].page_index } fn is_navbar_entry_selected(&self, ix: usize) -> bool { ix == self.navbar_entry } fn push_sub_page( &mut self, sub_page_link: SubPageLink, section_header: &'static str, cx: &mut Context, ) { self.sub_page_stack.push(SubPage { link: sub_page_link, section_header, }); cx.notify(); } fn pop_sub_page(&mut self, cx: &mut Context) { self.sub_page_stack.pop(); cx.notify(); } } impl Render for SettingsWindow { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl IntoElement { let ui_font = theme::setup_ui_font(window, cx); div() .key_context("SettingsWindow") .flex() .flex_row() .size_full() .font(ui_font) .bg(cx.theme().colors().background) .text_color(cx.theme().colors().text) .child(self.render_nav(window, cx)) .child(self.render_page(window, cx)) } } fn update_settings_file( file: SettingsUiFile, cx: &mut App, update: impl 'static + Send + FnOnce(&mut SettingsContent, &App), ) -> Result<()> { match file { SettingsUiFile::Local((worktree_id, rel_path)) => { fn all_projects(cx: &App) -> impl Iterator> { workspace::AppState::global(cx) .upgrade() .map(|app_state| { app_state .workspace_store .read(cx) .workspaces() .iter() .filter_map(|workspace| { Some(workspace.read(cx).ok()?.project().clone()) }) }) .into_iter() .flatten() } let rel_path = rel_path.join(paths::local_settings_file_relative_path()); let project = all_projects(cx).find(|project| { project.read_with(cx, |project, cx| { project.contains_local_settings_file(worktree_id, &rel_path, cx) }) }); let Some(project) = project else { anyhow::bail!( "Could not find worktree containing settings file: {}", &rel_path.display(PathStyle::local()) ); }; project.update(cx, |project, cx| { project.update_local_settings_file(worktree_id, rel_path, cx, update); }); return Ok(()); } SettingsUiFile::User => { // todo(settings_ui) error? SettingsStore::global(cx).update_settings_file(::global(cx), update); Ok(()) } SettingsUiFile::Server(_) => unimplemented!(), } } fn render_text_field + Into + AsRef + Clone>( field: SettingField, file: SettingsUiFile, metadata: Option<&SettingsFieldMetadata>, cx: &mut App, ) -> AnyElement { let (_, initial_text) = SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick); let initial_text = Some(initial_text.clone()).filter(|s| !s.as_ref().is_empty()); SettingsEditor::new() .when_some(initial_text, |editor, text| { editor.with_initial_text(text.into()) }) .when_some( metadata.and_then(|metadata| metadata.placeholder), |editor, placeholder| editor.with_placeholder(placeholder), ) .on_confirm({ move |new_text, cx| { update_settings_file(file.clone(), cx, move |settings, _cx| { *(field.pick_mut)(settings) = new_text.map(Into::into); }) .log_err(); // todo(settings_ui) don't log err } }) .into_any_element() } fn render_toggle_button + From + Copy>( field: SettingField, file: SettingsUiFile, cx: &mut App, ) -> AnyElement { let (_, &value) = SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick); let toggle_state = if value.into() { ToggleState::Selected } else { ToggleState::Unselected }; Switch::new("toggle_button", toggle_state) .color(ui::SwitchColor::Accent) .on_click({ move |state, _window, cx| { let state = *state == ui::ToggleState::Selected; update_settings_file(file.clone(), cx, move |settings, _cx| { *(field.pick_mut)(settings) = Some(state.into()); }) .log_err(); // todo(settings_ui) don't log err } }) .color(SwitchColor::Accent) .into_any_element() } fn render_font_picker( field: SettingField, file: SettingsUiFile, window: &mut Window, cx: &mut App, ) -> AnyElement { let current_value = SettingsStore::global(cx) .get_value_from_file(file.to_settings(), field.pick) .1 .clone(); let font_picker = cx.new(|cx| { ui_input::font_picker( current_value.clone().into(), move |font_name, cx| { update_settings_file(file.clone(), cx, move |settings, _cx| { *(field.pick_mut)(settings) = Some(font_name.into()); }) .log_err(); // todo(settings_ui) don't log err }, window, cx, ) }); div() .child( PopoverMenu::new("font-picker") .menu(move |_window, _cx| Some(font_picker.clone())) .trigger( ButtonLike::new("font-family-button") .style(ButtonStyle::Outlined) .size(ButtonSize::Medium) .full_width() .child( h_flex() .w_full() .justify_between() .child(Label::new(current_value)) .child( Icon::new(IconName::ChevronUpDown) .color(Color::Muted) .size(IconSize::XSmall), ), ), ) .full_width(true) .anchor(gpui::Corner::TopLeft) .offset(gpui::Point { x: px(0.0), y: px(4.0), }) .with_handle(ui::PopoverMenuHandle::default()), ) .into_any_element() } fn render_numeric_stepper( field: SettingField, file: SettingsUiFile, window: &mut Window, cx: &mut App, ) -> AnyElement { let (_, &value) = SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick); NumericStepper::new("numeric_stepper", value, window, cx) .on_change({ move |value, _window, cx| { let value = *value; update_settings_file(file.clone(), cx, move |settings, _cx| { *(field.pick_mut)(settings) = Some(value); }) .log_err(); // todo(settings_ui) don't log err } }) .style(NumericStepperStyle::Outlined) .into_any_element() } fn render_dropdown( field: SettingField, file: SettingsUiFile, window: &mut Window, cx: &mut App, ) -> AnyElement where T: strum::VariantArray + strum::VariantNames + Copy + PartialEq + Send + Sync + 'static, { let variants = || -> &'static [T] { ::VARIANTS }; let labels = || -> &'static [&'static str] { ::VARIANTS }; let (_, ¤t_value) = SettingsStore::global(cx).get_value_from_file(file.to_settings(), field.pick); let current_value_label = labels()[variants().iter().position(|v| *v == current_value).unwrap()]; DropdownMenu::new( "dropdown", current_value_label, ContextMenu::build(window, cx, move |mut menu, _, _| { for (&value, &label) in std::iter::zip(variants(), labels()) { let file = file.clone(); menu = menu.toggleable_entry( label, value == current_value, IconPosition::Start, None, move |_, cx| { if value == current_value { return; } update_settings_file(file.clone(), cx, move |settings, _cx| { *(field.pick_mut)(settings) = Some(value); }) .log_err(); // todo(settings_ui) don't log err }, ); } menu }), ) .trigger_size(ButtonSize::Medium) .style(DropdownStyle::Outlined) .offset(gpui::Point { x: px(0.0), y: px(2.0), }) .into_any_element() } #[cfg(test)] mod test { use super::*; impl SettingsWindow { fn navbar_entry(&self) -> usize { self.navbar_entry } fn new_builder(window: &mut Window, cx: &mut Context) -> Self { let mut this = Self::new(window, cx); this.navbar_entries.clear(); this.pages.clear(); this } fn build(mut self) -> Self { self.build_search_matches(); self.build_navbar(); self } fn add_page( mut self, title: &'static str, build_page: impl Fn(SettingsPage) -> SettingsPage, ) -> Self { let page = SettingsPage { title, items: Vec::default(), }; self.pages.push(build_page(page)); self } fn search(&mut self, search_query: &str, window: &mut Window, cx: &mut Context) { self.search_task.take(); self.search_bar.update(cx, |editor, cx| { editor.set_text(search_query, window, cx); }); self.update_matches(cx); } fn assert_search_results(&self, other: &Self) { // page index could be different because of filtered out pages #[derive(Debug, PartialEq)] struct EntryMinimal { is_root: bool, title: &'static str, } pretty_assertions::assert_eq!( other .visible_navbar_entries() .map(|(_, entry)| EntryMinimal { is_root: entry.is_root, title: entry.title, }) .collect::>(), self.visible_navbar_entries() .map(|(_, entry)| EntryMinimal { is_root: entry.is_root, title: entry.title, }) .collect::>(), ); assert_eq!( self.current_page().items.iter().collect::>(), other.page_items().collect::>() ); } } impl SettingsPage { fn item(mut self, item: SettingsPageItem) -> Self { self.items.push(item); self } } impl SettingsPageItem { fn basic_item(title: &'static str, description: &'static str) -> Self { SettingsPageItem::SettingItem(SettingItem { title, description, field: Box::new(SettingField { pick: |settings_content| &settings_content.auto_update, pick_mut: |settings_content| &mut settings_content.auto_update, }), metadata: None, }) } } fn register_settings(cx: &mut App) { settings::init(cx); theme::init(theme::LoadThemes::JustBase, cx); workspace::init_settings(cx); project::Project::init_settings(cx); language::init(cx); editor::init(cx); menu::init(); } fn parse(input: &'static str, window: &mut Window, cx: &mut App) -> SettingsWindow { let mut pages: Vec = Vec::new(); let mut expanded_pages = Vec::new(); let mut selected_idx = None; let mut index = 0; let mut in_expanded_section = false; for mut line in input .lines() .map(|line| line.trim()) .filter(|line| !line.is_empty()) { if let Some(pre) = line.strip_suffix('*') { assert!(selected_idx.is_none(), "Only one selected entry allowed"); selected_idx = Some(index); line = pre; } let (kind, title) = line.split_once(" ").unwrap(); assert_eq!(kind.len(), 1); let kind = kind.chars().next().unwrap(); if kind == 'v' { let page_idx = pages.len(); expanded_pages.push(page_idx); pages.push(SettingsPage { title, items: vec![], }); index += 1; in_expanded_section = true; } else if kind == '>' { pages.push(SettingsPage { title, items: vec![], }); index += 1; in_expanded_section = false; } else if kind == '-' { pages .last_mut() .unwrap() .items .push(SettingsPageItem::SectionHeader(title)); if selected_idx == Some(index) && !in_expanded_section { panic!("Items in unexpanded sections cannot be selected"); } index += 1; } else { panic!( "Entries must start with one of 'v', '>', or '-'\n line: {}", line ); } } let mut settings_window = SettingsWindow { files: Vec::default(), current_file: crate::SettingsUiFile::User, pages, search_bar: cx.new(|cx| Editor::single_line(window, cx)), navbar_entry: selected_idx.expect("Must have a selected navbar entry"), navbar_entries: Vec::default(), list_handle: UniformListScrollHandle::default(), search_matches: vec![], search_task: None, sub_page_stack: vec![], scroll_handle: ScrollHandle::new(), }; settings_window.build_search_matches(); settings_window.build_navbar(); for expanded_page_index in expanded_pages { for entry in &mut settings_window.navbar_entries { if entry.page_index == expanded_page_index && entry.is_root { entry.expanded = true; } } } settings_window } #[track_caller] fn check_navbar_toggle( before: &'static str, toggle_page: &'static str, after: &'static str, window: &mut Window, cx: &mut App, ) { let mut settings_window = parse(before, window, cx); let toggle_page_idx = settings_window .pages .iter() .position(|page| page.title == toggle_page) .expect("page not found"); let toggle_idx = settings_window .navbar_entries .iter() .position(|entry| entry.page_index == toggle_page_idx) .expect("page not found"); settings_window.toggle_navbar_entry(toggle_idx); let expected_settings_window = parse(after, window, cx); pretty_assertions::assert_eq!( settings_window .visible_navbar_entries() .map(|(_, entry)| entry) .collect::>(), expected_settings_window .visible_navbar_entries() .map(|(_, entry)| entry) .collect::>(), ); pretty_assertions::assert_eq!( settings_window.navbar_entries[settings_window.navbar_entry()], expected_settings_window.navbar_entries[expected_settings_window.navbar_entry()], ); } macro_rules! check_navbar_toggle { ($name:ident, before: $before:expr, toggle_page: $toggle_page:expr, after: $after:expr) => { #[gpui::test] fn $name(cx: &mut gpui::TestAppContext) { let window = cx.add_empty_window(); window.update(|window, cx| { register_settings(cx); check_navbar_toggle($before, $toggle_page, $after, window, cx); }); } }; } check_navbar_toggle!( navbar_basic_open, before: r" v General - General - Privacy* v Project - Project Settings ", toggle_page: "General", after: r" > General* v Project - Project Settings " ); check_navbar_toggle!( navbar_basic_close, before: r" > General* - General - Privacy v Project - Project Settings ", toggle_page: "General", after: r" v General* - General - Privacy v Project - Project Settings " ); check_navbar_toggle!( navbar_basic_second_root_entry_close, before: r" > General - General - Privacy v Project - Project Settings* ", toggle_page: "Project", after: r" > General > Project* " ); check_navbar_toggle!( navbar_toggle_subroot, before: r" v General Page - General - Privacy v Project - Worktree Settings Content* v AI - General > Appearance & Behavior ", toggle_page: "Project", after: r" v General Page - General - Privacy > Project* v AI - General > Appearance & Behavior " ); check_navbar_toggle!( navbar_toggle_close_propagates_selected_index, before: r" v General Page - General - Privacy v Project - Worktree Settings Content v AI - General* > Appearance & Behavior ", toggle_page: "General Page", after: r" > General Page v Project - Worktree Settings Content v AI - General* > Appearance & Behavior " ); check_navbar_toggle!( navbar_toggle_expand_propagates_selected_index, before: r" > General Page - General - Privacy v Project - Worktree Settings Content v AI - General* > Appearance & Behavior ", toggle_page: "General Page", after: r" v General Page - General - Privacy v Project - Worktree Settings Content v AI - General* > Appearance & Behavior " ); #[gpui::test] fn test_basic_search(cx: &mut gpui::TestAppContext) { let cx = cx.add_empty_window(); let (actual, expected) = cx.update(|window, cx| { register_settings(cx); let expected = cx.new(|cx| { SettingsWindow::new_builder(window, cx) .add_page("General", |page| { page.item(SettingsPageItem::SectionHeader("General settings")) .item(SettingsPageItem::basic_item("test title", "General test")) }) .build() }); let actual = cx.new(|cx| { SettingsWindow::new_builder(window, cx) .add_page("General", |page| { page.item(SettingsPageItem::SectionHeader("General settings")) .item(SettingsPageItem::basic_item("test title", "General test")) }) .add_page("Theme", |page| { page.item(SettingsPageItem::SectionHeader("Theme settings")) }) .build() }); actual.update(cx, |settings, cx| settings.search("gen", window, cx)); (actual, expected) }); cx.cx.run_until_parked(); cx.update(|_window, cx| { let expected = expected.read(cx); let actual = actual.read(cx); expected.assert_search_results(&actual); }) } #[gpui::test] fn test_search_render_page_with_filtered_out_navbar_entries(cx: &mut gpui::TestAppContext) { let cx = cx.add_empty_window(); let (actual, expected) = cx.update(|window, cx| { register_settings(cx); let actual = cx.new(|cx| { SettingsWindow::new_builder(window, cx) .add_page("General", |page| { page.item(SettingsPageItem::SectionHeader("General settings")) .item(SettingsPageItem::basic_item( "Confirm Quit", "Whether to confirm before quitting Zed", )) .item(SettingsPageItem::basic_item( "Auto Update", "Automatically update Zed", )) }) .add_page("AI", |page| { page.item(SettingsPageItem::basic_item( "Disable AI", "Whether to disable all AI features in Zed", )) }) .add_page("Appearance & Behavior", |page| { page.item(SettingsPageItem::SectionHeader("Cursor")).item( SettingsPageItem::basic_item( "Cursor Shape", "Cursor shape for the editor", ), ) }) .build() }); let expected = cx.new(|cx| { SettingsWindow::new_builder(window, cx) .add_page("Appearance & Behavior", |page| { page.item(SettingsPageItem::SectionHeader("Cursor")).item( SettingsPageItem::basic_item( "Cursor Shape", "Cursor shape for the editor", ), ) }) .build() }); actual.update(cx, |settings, cx| settings.search("cursor", window, cx)); (actual, expected) }); cx.cx.run_until_parked(); cx.update(|_window, cx| { let expected = expected.read(cx); let actual = actual.read(cx); expected.assert_search_results(&actual); }) } }