1mod agent;
2mod editor;
3mod language;
4mod language_model;
5mod project;
6mod terminal;
7mod theme;
8mod workspace;
9
10pub use agent::*;
11pub use editor::*;
12pub use language::*;
13pub use language_model::*;
14pub use project::*;
15pub use terminal::*;
16pub use theme::*;
17pub use workspace::*;
18
19use collections::{HashMap, IndexMap};
20use gpui::{App, SharedString};
21use release_channel::ReleaseChannel;
22use schemars::JsonSchema;
23use serde::{Deserialize, Serialize};
24use serde_with::skip_serializing_none;
25use settings_macros::MergeFrom;
26use std::collections::BTreeSet;
27use std::env;
28use std::sync::Arc;
29pub use util::serde::default_true;
30
31use crate::{ActiveSettingsProfileName, merge_from};
32
33#[skip_serializing_none]
34#[derive(Debug, PartialEq, Default, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
35pub struct SettingsContent {
36 #[serde(flatten)]
37 pub project: ProjectSettingsContent,
38
39 #[serde(flatten)]
40 pub theme: Box<ThemeSettingsContent>,
41
42 #[serde(flatten)]
43 pub extension: ExtensionSettingsContent,
44
45 #[serde(flatten)]
46 pub workspace: WorkspaceSettingsContent,
47
48 #[serde(flatten)]
49 pub editor: EditorSettingsContent,
50
51 #[serde(flatten)]
52 pub remote: RemoteSettingsContent,
53
54 /// Settings related to the file finder.
55 pub file_finder: Option<FileFinderSettingsContent>,
56
57 pub git_panel: Option<GitPanelSettingsContent>,
58
59 pub tabs: Option<ItemSettingsContent>,
60 pub tab_bar: Option<TabBarSettingsContent>,
61
62 pub preview_tabs: Option<PreviewTabsSettingsContent>,
63
64 pub agent: Option<AgentSettingsContent>,
65 pub agent_servers: Option<AllAgentServersSettings>,
66
67 /// Configuration of audio in Zed.
68 pub audio: Option<AudioSettingsContent>,
69
70 /// Whether or not to automatically check for updates.
71 ///
72 /// Default: true
73 pub auto_update: Option<bool>,
74
75 /// This base keymap settings adjusts the default keybindings in Zed to be similar
76 /// to other common code editors. By default, Zed's keymap closely follows VSCode's
77 /// keymap, with minor adjustments, this corresponds to the "VSCode" setting.
78 ///
79 /// Default: VSCode
80 pub base_keymap: Option<BaseKeymapContent>,
81
82 /// Configuration for the collab panel visual settings.
83 pub collaboration_panel: Option<PanelSettingsContent>,
84
85 pub debugger: Option<DebuggerSettingsContent>,
86
87 /// Configuration for Diagnostics-related features.
88 pub diagnostics: Option<DiagnosticsSettingsContent>,
89
90 /// Configuration for Git-related features
91 pub git: Option<GitSettings>,
92
93 /// Common language server settings.
94 pub global_lsp_settings: Option<GlobalLspSettingsContent>,
95
96 /// The settings for the image viewer.
97 pub image_viewer: Option<ImageViewerSettingsContent>,
98
99 pub repl: Option<ReplSettingsContent>,
100
101 /// Whether or not to enable Helix mode.
102 ///
103 /// Default: false
104 pub helix_mode: Option<bool>,
105
106 pub journal: Option<JournalSettingsContent>,
107
108 /// A map of log scopes to the desired log level.
109 /// Useful for filtering out noisy logs or enabling more verbose logging.
110 ///
111 /// Example: {"log": {"client": "warn"}}
112 pub log: Option<HashMap<String, String>>,
113
114 pub line_indicator_format: Option<LineIndicatorFormat>,
115
116 pub language_models: Option<AllLanguageModelSettingsContent>,
117
118 pub outline_panel: Option<OutlinePanelSettingsContent>,
119
120 pub project_panel: Option<ProjectPanelSettingsContent>,
121
122 /// Configuration for the Message Editor
123 pub message_editor: Option<MessageEditorSettings>,
124
125 /// Configuration for Node-related features
126 pub node: Option<NodeBinarySettings>,
127
128 /// Configuration for the Notification Panel
129 pub notification_panel: Option<NotificationPanelSettingsContent>,
130
131 pub proxy: Option<String>,
132
133 /// The URL of the Zed server to connect to.
134 pub server_url: Option<String>,
135
136 /// Configuration for session-related features
137 pub session: Option<SessionSettingsContent>,
138 /// Control what info is collected by Zed.
139 pub telemetry: Option<TelemetrySettingsContent>,
140
141 /// Configuration of the terminal in Zed.
142 pub terminal: Option<TerminalSettingsContent>,
143
144 pub title_bar: Option<TitleBarSettingsContent>,
145
146 /// Whether or not to enable Vim mode.
147 ///
148 /// Default: false
149 pub vim_mode: Option<bool>,
150
151 // Settings related to calls in Zed
152 pub calls: Option<CallSettingsContent>,
153
154 /// Whether to disable all AI features in Zed.
155 ///
156 /// Default: false
157 pub disable_ai: Option<SaturatingBool>,
158
159 /// Settings related to Vim mode in Zed.
160 pub vim: Option<VimSettingsContent>,
161}
162
163impl SettingsContent {
164 pub fn languages_mut(&mut self) -> &mut HashMap<SharedString, LanguageSettingsContent> {
165 &mut self.project.all_languages.languages.0
166 }
167}
168
169#[skip_serializing_none]
170#[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
171pub struct UserSettingsContent {
172 #[serde(flatten)]
173 pub content: Box<SettingsContent>,
174
175 pub dev: Option<Box<SettingsContent>>,
176 pub nightly: Option<Box<SettingsContent>>,
177 pub preview: Option<Box<SettingsContent>>,
178 pub stable: Option<Box<SettingsContent>>,
179
180 pub macos: Option<Box<SettingsContent>>,
181 pub windows: Option<Box<SettingsContent>>,
182 pub linux: Option<Box<SettingsContent>>,
183
184 #[serde(default)]
185 pub profiles: IndexMap<String, SettingsContent>,
186}
187
188pub struct ExtensionsSettingsContent {
189 pub all_languages: AllLanguageSettingsContent,
190}
191
192impl UserSettingsContent {
193 pub fn for_release_channel(&self) -> Option<&SettingsContent> {
194 match *release_channel::RELEASE_CHANNEL {
195 ReleaseChannel::Dev => self.dev.as_deref(),
196 ReleaseChannel::Nightly => self.nightly.as_deref(),
197 ReleaseChannel::Preview => self.preview.as_deref(),
198 ReleaseChannel::Stable => self.stable.as_deref(),
199 }
200 }
201
202 pub fn for_os(&self) -> Option<&SettingsContent> {
203 match env::consts::OS {
204 "macos" => self.macos.as_deref(),
205 "linux" => self.linux.as_deref(),
206 "windows" => self.windows.as_deref(),
207 _ => None,
208 }
209 }
210
211 pub fn for_profile(&self, cx: &App) -> Option<&SettingsContent> {
212 let Some(active_profile) = cx.try_global::<ActiveSettingsProfileName>() else {
213 return None;
214 };
215 self.profiles.get(&active_profile.0)
216 }
217}
218
219/// Base key bindings scheme. Base keymaps can be overridden with user keymaps.
220///
221/// Default: VSCode
222#[derive(
223 Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq, Default,
224)]
225pub enum BaseKeymapContent {
226 #[default]
227 VSCode,
228 JetBrains,
229 SublimeText,
230 Atom,
231 TextMate,
232 Emacs,
233 Cursor,
234 None,
235}
236
237#[skip_serializing_none]
238#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
239pub struct TitleBarSettingsContent {
240 /// Controls when the title bar is visible: "always" | "never" | "hide_in_full_screen".
241 ///
242 /// Default: "always"
243 pub show: Option<TitleBarVisibility>,
244 /// Whether to show the branch icon beside branch switcher in the title bar.
245 ///
246 /// Default: false
247 pub show_branch_icon: Option<bool>,
248 /// Whether to show onboarding banners in the title bar.
249 ///
250 /// Default: true
251 pub show_onboarding_banner: Option<bool>,
252 /// Whether to show user avatar in the title bar.
253 ///
254 /// Default: true
255 pub show_user_picture: Option<bool>,
256 /// Whether to show the branch name button in the titlebar.
257 ///
258 /// Default: true
259 pub show_branch_name: Option<bool>,
260 /// Whether to show the project host and name in the titlebar.
261 ///
262 /// Default: true
263 pub show_project_items: Option<bool>,
264 /// Whether to show the sign in button in the title bar.
265 ///
266 /// Default: true
267 pub show_sign_in: Option<bool>,
268 /// Whether to show the menus in the title bar.
269 ///
270 /// Default: false
271 pub show_menus: Option<bool>,
272}
273
274#[derive(Copy, Clone, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
275#[serde(rename_all = "snake_case")]
276pub enum TitleBarVisibility {
277 Always,
278 Never,
279 HideInFullScreen,
280}
281
282/// Configuration of audio in Zed.
283#[skip_serializing_none]
284#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
285pub struct AudioSettingsContent {
286 /// Opt into the new audio system.
287 #[serde(rename = "experimental.rodio_audio", default)]
288 pub rodio_audio: Option<bool>,
289 /// Requires 'rodio_audio: true'
290 ///
291 /// Use the new audio systems automatic gain control for your microphone.
292 /// This affects how loud you sound to others.
293 #[serde(rename = "experimental.control_input_volume", default)]
294 pub control_input_volume: Option<bool>,
295 /// Requires 'rodio_audio: true'
296 ///
297 /// Use the new audio systems automatic gain control on everyone in the
298 /// call. This makes call members who are too quite louder and those who are
299 /// too loud quieter. This only affects how things sound for you.
300 #[serde(rename = "experimental.control_output_volume", default)]
301 pub control_output_volume: Option<bool>,
302}
303
304/// Control what info is collected by Zed.
305#[skip_serializing_none]
306#[derive(Default, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Debug, MergeFrom)]
307pub struct TelemetrySettingsContent {
308 /// Send debug info like crash reports.
309 ///
310 /// Default: true
311 pub diagnostics: Option<bool>,
312 /// Send anonymized usage data like what languages you're using Zed with.
313 ///
314 /// Default: true
315 pub metrics: Option<bool>,
316}
317
318#[skip_serializing_none]
319#[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Clone, MergeFrom)]
320pub struct DebuggerSettingsContent {
321 /// Determines the stepping granularity.
322 ///
323 /// Default: line
324 pub stepping_granularity: Option<SteppingGranularity>,
325 /// Whether the breakpoints should be reused across Zed sessions.
326 ///
327 /// Default: true
328 pub save_breakpoints: Option<bool>,
329 /// Whether to show the debug button in the status bar.
330 ///
331 /// Default: true
332 pub button: Option<bool>,
333 /// Time in milliseconds until timeout error when connecting to a TCP debug adapter
334 ///
335 /// Default: 2000ms
336 pub timeout: Option<u64>,
337 /// Whether to log messages between active debug adapters and Zed
338 ///
339 /// Default: true
340 pub log_dap_communications: Option<bool>,
341 /// Whether to format dap messages in when adding them to debug adapter logger
342 ///
343 /// Default: true
344 pub format_dap_log_messages: Option<bool>,
345 /// The dock position of the debug panel
346 ///
347 /// Default: Bottom
348 pub dock: Option<DockPosition>,
349}
350
351/// The granularity of one 'step' in the stepping requests `next`, `stepIn`, `stepOut`, and `stepBack`.
352#[derive(
353 PartialEq, Eq, Debug, Hash, Clone, Copy, Deserialize, Serialize, JsonSchema, MergeFrom,
354)]
355#[serde(rename_all = "snake_case")]
356pub enum SteppingGranularity {
357 /// The step should allow the program to run until the current statement has finished executing.
358 /// The meaning of a statement is determined by the adapter and it may be considered equivalent to a line.
359 /// For example 'for(int i = 0; i < 10; i++)' could be considered to have 3 statements 'int i = 0', 'i < 10', and 'i++'.
360 Statement,
361 /// The step should allow the program to run until the current source line has executed.
362 Line,
363 /// The step should allow one instruction to execute (e.g. one x86 instruction).
364 Instruction,
365}
366
367#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
368#[serde(rename_all = "snake_case")]
369pub enum DockPosition {
370 Left,
371 Bottom,
372 Right,
373}
374
375/// Settings for slash commands.
376#[skip_serializing_none]
377#[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
378pub struct SlashCommandSettings {
379 /// Settings for the `/cargo-workspace` slash command.
380 pub cargo_workspace: Option<CargoWorkspaceCommandSettings>,
381}
382
383/// Settings for the `/cargo-workspace` slash command.
384#[skip_serializing_none]
385#[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
386pub struct CargoWorkspaceCommandSettings {
387 /// Whether `/cargo-workspace` is enabled.
388 pub enabled: Option<bool>,
389}
390
391/// Configuration of voice calls in Zed.
392#[skip_serializing_none]
393#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
394pub struct CallSettingsContent {
395 /// Whether the microphone should be muted when joining a channel or a call.
396 ///
397 /// Default: false
398 pub mute_on_join: Option<bool>,
399
400 /// Whether your current project should be shared when joining an empty channel.
401 ///
402 /// Default: false
403 pub share_on_join: Option<bool>,
404}
405
406#[skip_serializing_none]
407#[derive(Deserialize, Serialize, PartialEq, Debug, Default, Clone, JsonSchema, MergeFrom)]
408pub struct ExtensionSettingsContent {
409 /// The extensions that should be automatically installed by Zed.
410 ///
411 /// This is used to make functionality provided by extensions (e.g., language support)
412 /// available out-of-the-box.
413 ///
414 /// Default: { "html": true }
415 #[serde(default)]
416 pub auto_install_extensions: HashMap<Arc<str>, bool>,
417 #[serde(default)]
418 pub auto_update_extensions: HashMap<Arc<str>, bool>,
419}
420
421#[skip_serializing_none]
422#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
423pub struct GitPanelSettingsContent {
424 /// Whether to show the panel button in the status bar.
425 ///
426 /// Default: true
427 pub button: Option<bool>,
428 /// Where to dock the panel.
429 ///
430 /// Default: left
431 pub dock: Option<DockPosition>,
432 /// Default width of the panel in pixels.
433 ///
434 /// Default: 360
435 pub default_width: Option<f32>,
436 /// How entry statuses are displayed.
437 ///
438 /// Default: icon
439 pub status_style: Option<StatusStyle>,
440 /// How and when the scrollbar should be displayed.
441 ///
442 /// Default: inherits editor scrollbar settings
443 pub scrollbar: Option<ScrollbarSettings>,
444
445 /// What the default branch name should be when
446 /// `init.defaultBranch` is not set in git
447 ///
448 /// Default: main
449 pub fallback_branch_name: Option<String>,
450
451 /// Whether to sort entries in the panel by path
452 /// or by status (the default).
453 ///
454 /// Default: false
455 pub sort_by_path: Option<bool>,
456
457 /// Whether to collapse untracked files in the diff panel.
458 ///
459 /// Default: false
460 pub collapse_untracked_diff: Option<bool>,
461}
462
463#[derive(
464 Default, Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq,
465)]
466#[serde(rename_all = "snake_case")]
467pub enum StatusStyle {
468 #[default]
469 Icon,
470 LabelColor,
471}
472
473#[skip_serializing_none]
474#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
475pub struct ScrollbarSettings {
476 pub show: Option<ShowScrollbar>,
477}
478
479#[skip_serializing_none]
480#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
481pub struct NotificationPanelSettingsContent {
482 /// Whether to show the panel button in the status bar.
483 ///
484 /// Default: true
485 pub button: Option<bool>,
486 /// Where to dock the panel.
487 ///
488 /// Default: right
489 pub dock: Option<DockPosition>,
490 /// Default width of the panel in pixels.
491 ///
492 /// Default: 300
493 pub default_width: Option<f32>,
494}
495
496#[skip_serializing_none]
497#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
498pub struct PanelSettingsContent {
499 /// Whether to show the panel button in the status bar.
500 ///
501 /// Default: true
502 pub button: Option<bool>,
503 /// Where to dock the panel.
504 ///
505 /// Default: left
506 pub dock: Option<DockPosition>,
507 /// Default width of the panel in pixels.
508 ///
509 /// Default: 240
510 pub default_width: Option<f32>,
511}
512
513#[skip_serializing_none]
514#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
515pub struct MessageEditorSettings {
516 /// Whether to automatically replace emoji shortcodes with emoji characters.
517 /// For example: typing `:wave:` gets replaced with `👋`.
518 ///
519 /// Default: false
520 pub auto_replace_emoji_shortcode: Option<bool>,
521}
522
523#[skip_serializing_none]
524#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
525pub struct FileFinderSettingsContent {
526 /// Whether to show file icons in the file finder.
527 ///
528 /// Default: true
529 pub file_icons: Option<bool>,
530 /// Determines how much space the file finder can take up in relation to the available window width.
531 ///
532 /// Default: small
533 pub modal_max_width: Option<FileFinderWidthContent>,
534 /// Determines whether the file finder should skip focus for the active file in search results.
535 ///
536 /// Default: true
537 pub skip_focus_for_active_in_search: Option<bool>,
538 /// Determines whether to show the git status in the file finder
539 ///
540 /// Default: true
541 pub git_status: Option<bool>,
542 /// Whether to use gitignored files when searching.
543 /// Only the file Zed had indexed will be used, not necessary all the gitignored files.
544 ///
545 /// Can accept 3 values:
546 /// * `Some(true)`: Use all gitignored files
547 /// * `Some(false)`: Use only the files Zed had indexed
548 /// * `None`: Be smart and search for ignored when called from a gitignored worktree
549 ///
550 /// Default: None
551 /// todo() -> Change this type to an enum
552 pub include_ignored: Option<bool>,
553}
554
555#[derive(
556 Debug, PartialEq, Eq, Clone, Copy, Default, Serialize, Deserialize, JsonSchema, MergeFrom,
557)]
558#[serde(rename_all = "lowercase")]
559pub enum FileFinderWidthContent {
560 #[default]
561 Small,
562 Medium,
563 Large,
564 XLarge,
565 Full,
566}
567
568#[skip_serializing_none]
569#[derive(Clone, Default, Serialize, Deserialize, PartialEq, Debug, JsonSchema, MergeFrom)]
570pub struct VimSettingsContent {
571 pub default_mode: Option<ModeContent>,
572 pub toggle_relative_line_numbers: Option<bool>,
573 pub use_system_clipboard: Option<UseSystemClipboard>,
574 pub use_smartcase_find: Option<bool>,
575 pub custom_digraphs: Option<HashMap<String, Arc<str>>>,
576 pub highlight_on_yank_duration: Option<u64>,
577 pub cursor_shape: Option<CursorShapeSettings>,
578}
579
580#[derive(Copy, Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Debug)]
581#[serde(rename_all = "snake_case")]
582pub enum ModeContent {
583 #[default]
584 Normal,
585 Insert,
586 HelixNormal,
587}
588
589/// Controls when to use system clipboard.
590#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom)]
591#[serde(rename_all = "snake_case")]
592pub enum UseSystemClipboard {
593 /// Don't use system clipboard.
594 Never,
595 /// Use system clipboard.
596 Always,
597 /// Use system clipboard for yank operations.
598 OnYank,
599}
600
601/// The settings for cursor shape.
602#[skip_serializing_none]
603#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom)]
604pub struct CursorShapeSettings {
605 /// Cursor shape for the normal mode.
606 ///
607 /// Default: block
608 pub normal: Option<CursorShape>,
609 /// Cursor shape for the replace mode.
610 ///
611 /// Default: underline
612 pub replace: Option<CursorShape>,
613 /// Cursor shape for the visual mode.
614 ///
615 /// Default: block
616 pub visual: Option<CursorShape>,
617 /// Cursor shape for the insert mode.
618 ///
619 /// The default value follows the primary cursor_shape.
620 pub insert: Option<CursorShape>,
621}
622
623/// Settings specific to journaling
624#[skip_serializing_none]
625#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
626pub struct JournalSettingsContent {
627 /// The path of the directory where journal entries are stored.
628 ///
629 /// Default: `~`
630 pub path: Option<String>,
631 /// What format to display the hours in.
632 ///
633 /// Default: hour12
634 pub hour_format: Option<HourFormat>,
635}
636
637#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
638#[serde(rename_all = "snake_case")]
639pub enum HourFormat {
640 #[default]
641 Hour12,
642 Hour24,
643}
644
645#[skip_serializing_none]
646#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
647pub struct OutlinePanelSettingsContent {
648 /// Whether to show the outline panel button in the status bar.
649 ///
650 /// Default: true
651 pub button: Option<bool>,
652 /// Customize default width (in pixels) taken by outline panel
653 ///
654 /// Default: 240
655 pub default_width: Option<f32>,
656 /// The position of outline panel
657 ///
658 /// Default: left
659 pub dock: Option<DockSide>,
660 /// Whether to show file icons in the outline panel.
661 ///
662 /// Default: true
663 pub file_icons: Option<bool>,
664 /// Whether to show folder icons or chevrons for directories in the outline panel.
665 ///
666 /// Default: true
667 pub folder_icons: Option<bool>,
668 /// Whether to show the git status in the outline panel.
669 ///
670 /// Default: true
671 pub git_status: Option<bool>,
672 /// Amount of indentation (in pixels) for nested items.
673 ///
674 /// Default: 20
675 pub indent_size: Option<f32>,
676 /// Whether to reveal it in the outline panel automatically,
677 /// when a corresponding project entry becomes active.
678 /// Gitignored entries are never auto revealed.
679 ///
680 /// Default: true
681 pub auto_reveal_entries: Option<bool>,
682 /// Whether to fold directories automatically
683 /// when directory has only one directory inside.
684 ///
685 /// Default: true
686 pub auto_fold_dirs: Option<bool>,
687 /// Settings related to indent guides in the outline panel.
688 pub indent_guides: Option<IndentGuidesSettingsContent>,
689 /// Scrollbar-related settings
690 pub scrollbar: Option<ScrollbarSettingsContent>,
691 /// Default depth to expand outline items in the current file.
692 /// The default depth to which outline entries are expanded on reveal.
693 /// - Set to 0 to collapse all items that have children
694 /// - Set to 1 or higher to collapse items at that depth or deeper
695 ///
696 /// Default: 100
697 pub expand_outlines_with_depth: Option<usize>,
698}
699
700#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Copy, PartialEq)]
701#[serde(rename_all = "snake_case")]
702pub enum DockSide {
703 Left,
704 Right,
705}
706
707#[derive(Copy, Clone, Debug, PartialEq, Eq, Deserialize, Serialize, JsonSchema, MergeFrom)]
708#[serde(rename_all = "snake_case")]
709pub enum ShowIndentGuides {
710 Always,
711 Never,
712}
713
714#[skip_serializing_none]
715#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
716pub struct IndentGuidesSettingsContent {
717 /// When to show the scrollbar in the outline panel.
718 pub show: Option<ShowIndentGuides>,
719}
720
721#[derive(Clone, Copy, Default, PartialEq, Debug, JsonSchema, MergeFrom, Deserialize, Serialize)]
722#[serde(rename_all = "snake_case")]
723pub enum LineIndicatorFormat {
724 Short,
725 #[default]
726 Long,
727}
728
729/// The settings for the image viewer.
730#[skip_serializing_none]
731#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
732pub struct ImageViewerSettingsContent {
733 /// The unit to use for displaying image file sizes.
734 ///
735 /// Default: "binary"
736 pub unit: Option<ImageFileSizeUnit>,
737}
738
739#[skip_serializing_none]
740#[derive(Clone, Copy, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
741#[serde(rename_all = "snake_case")]
742pub enum ImageFileSizeUnit {
743 /// Displays file size in binary units (e.g., KiB, MiB).
744 #[default]
745 Binary,
746 /// Displays file size in decimal units (e.g., KB, MB).
747 Decimal,
748}
749
750#[skip_serializing_none]
751#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
752pub struct RemoteSettingsContent {
753 pub ssh_connections: Option<Vec<SshConnection>>,
754 pub wsl_connections: Option<Vec<WslConnection>>,
755 pub read_ssh_config: Option<bool>,
756}
757
758#[skip_serializing_none]
759#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom)]
760pub struct SshConnection {
761 pub host: SharedString,
762 pub username: Option<String>,
763 pub port: Option<u16>,
764 #[serde(default)]
765 pub args: Vec<String>,
766 #[serde(default)]
767 pub projects: collections::BTreeSet<SshProject>,
768 /// Name to use for this server in UI.
769 pub nickname: Option<String>,
770 // By default Zed will download the binary to the host directly.
771 // If this is set to true, Zed will download the binary to your local machine,
772 // and then upload it over the SSH connection. Useful if your SSH server has
773 // limited outbound internet access.
774 pub upload_binary_over_ssh: Option<bool>,
775
776 pub port_forwards: Option<Vec<SshPortForwardOption>>,
777}
778
779#[derive(Clone, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom, Debug)]
780pub struct WslConnection {
781 pub distro_name: SharedString,
782 pub user: Option<String>,
783 #[serde(default)]
784 pub projects: BTreeSet<SshProject>,
785}
786
787#[skip_serializing_none]
788#[derive(
789 Clone, Debug, Default, Serialize, PartialEq, Eq, PartialOrd, Ord, Deserialize, JsonSchema,
790)]
791pub struct SshProject {
792 pub paths: Vec<String>,
793}
794
795#[skip_serializing_none]
796#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize, JsonSchema, MergeFrom)]
797pub struct SshPortForwardOption {
798 #[serde(skip_serializing_if = "Option::is_none")]
799 pub local_host: Option<String>,
800 pub local_port: u16,
801 #[serde(skip_serializing_if = "Option::is_none")]
802 pub remote_host: Option<String>,
803 pub remote_port: u16,
804}
805
806/// Settings for configuring REPL display and behavior.
807#[skip_serializing_none]
808#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
809pub struct ReplSettingsContent {
810 /// Maximum number of lines to keep in REPL's scrollback buffer.
811 /// Clamped with [4, 256] range.
812 ///
813 /// Default: 32
814 pub max_lines: Option<usize>,
815 /// Maximum number of columns to keep in REPL's scrollback buffer.
816 /// Clamped with [20, 512] range.
817 ///
818 /// Default: 128
819 pub max_columns: Option<usize>,
820}
821
822#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
823/// An ExtendingVec in the settings can only accumulate new values.
824///
825/// This is useful for things like private files where you only want
826/// to allow new values to be added.
827///
828/// Consider using a HashMap<String, bool> instead of this type
829/// (like auto_install_extensions) so that user settings files can both add
830/// and remove values from the set.
831pub struct ExtendingVec<T>(pub Vec<T>);
832
833impl<T> Into<Vec<T>> for ExtendingVec<T> {
834 fn into(self) -> Vec<T> {
835 self.0
836 }
837}
838impl<T> From<Vec<T>> for ExtendingVec<T> {
839 fn from(vec: Vec<T>) -> Self {
840 ExtendingVec(vec)
841 }
842}
843
844impl<T: Clone> merge_from::MergeFrom for ExtendingVec<T> {
845 fn merge_from(&mut self, other: &Self) {
846 self.0.extend_from_slice(other.0.as_slice());
847 }
848}
849
850/// A SaturatingBool in the settings can only ever be set to true,
851/// later attempts to set it to false will be ignored.
852///
853/// Used by `disable_ai`.
854#[derive(Debug, Default, Copy, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
855pub struct SaturatingBool(pub bool);
856
857impl From<bool> for SaturatingBool {
858 fn from(value: bool) -> Self {
859 SaturatingBool(value)
860 }
861}
862
863impl merge_from::MergeFrom for SaturatingBool {
864 fn merge_from(&mut self, other: &Self) {
865 self.0 |= other.0
866 }
867}