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;
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, Serialize, Deserialize, JsonSchema, MergeFrom)]
171pub struct ServerSettingsContent {
172 #[serde(flatten)]
173 pub project: ProjectSettingsContent,
174}
175
176#[skip_serializing_none]
177#[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
178pub struct UserSettingsContent {
179 #[serde(flatten)]
180 pub content: Box<SettingsContent>,
181
182 pub dev: Option<Box<SettingsContent>>,
183 pub nightly: Option<Box<SettingsContent>>,
184 pub preview: Option<Box<SettingsContent>>,
185 pub stable: Option<Box<SettingsContent>>,
186
187 pub macos: Option<Box<SettingsContent>>,
188 pub windows: Option<Box<SettingsContent>>,
189 pub linux: Option<Box<SettingsContent>>,
190
191 #[serde(default)]
192 pub profiles: HashMap<String, SettingsContent>,
193}
194
195pub struct ExtensionsSettingsContent {
196 pub all_languages: AllLanguageSettingsContent,
197}
198
199impl UserSettingsContent {
200 pub fn for_release_channel(&self) -> Option<&SettingsContent> {
201 match *release_channel::RELEASE_CHANNEL {
202 ReleaseChannel::Dev => self.dev.as_deref(),
203 ReleaseChannel::Nightly => self.nightly.as_deref(),
204 ReleaseChannel::Preview => self.preview.as_deref(),
205 ReleaseChannel::Stable => self.stable.as_deref(),
206 }
207 }
208
209 pub fn for_os(&self) -> Option<&SettingsContent> {
210 match env::consts::OS {
211 "macos" => self.macos.as_deref(),
212 "linux" => self.linux.as_deref(),
213 "windows" => self.windows.as_deref(),
214 _ => None,
215 }
216 }
217
218 pub fn for_profile(&self, cx: &App) -> Option<&SettingsContent> {
219 let Some(active_profile) = cx.try_global::<ActiveSettingsProfileName>() else {
220 return None;
221 };
222 self.profiles.get(&active_profile.0)
223 }
224}
225
226/// Base key bindings scheme. Base keymaps can be overridden with user keymaps.
227///
228/// Default: VSCode
229#[derive(
230 Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq, Default,
231)]
232pub enum BaseKeymapContent {
233 #[default]
234 VSCode,
235 JetBrains,
236 SublimeText,
237 Atom,
238 TextMate,
239 Emacs,
240 Cursor,
241 None,
242}
243
244#[skip_serializing_none]
245#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
246pub struct TitleBarSettingsContent {
247 /// Controls when the title bar is visible: "always" | "never" | "hide_in_full_screen".
248 ///
249 /// Default: "always"
250 pub show: Option<TitleBarVisibility>,
251 /// Whether to show the branch icon beside branch switcher in the title bar.
252 ///
253 /// Default: false
254 pub show_branch_icon: Option<bool>,
255 /// Whether to show onboarding banners in the title bar.
256 ///
257 /// Default: true
258 pub show_onboarding_banner: Option<bool>,
259 /// Whether to show user avatar in the title bar.
260 ///
261 /// Default: true
262 pub show_user_picture: Option<bool>,
263 /// Whether to show the branch name button in the titlebar.
264 ///
265 /// Default: true
266 pub show_branch_name: Option<bool>,
267 /// Whether to show the project host and name in the titlebar.
268 ///
269 /// Default: true
270 pub show_project_items: Option<bool>,
271 /// Whether to show the sign in button in the title bar.
272 ///
273 /// Default: true
274 pub show_sign_in: Option<bool>,
275 /// Whether to show the menus in the title bar.
276 ///
277 /// Default: false
278 pub show_menus: Option<bool>,
279}
280
281#[derive(Copy, Clone, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
282#[serde(rename_all = "snake_case")]
283pub enum TitleBarVisibility {
284 Always,
285 Never,
286 HideInFullScreen,
287}
288
289/// Configuration of audio in Zed.
290#[skip_serializing_none]
291#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
292pub struct AudioSettingsContent {
293 /// Opt into the new audio system.
294 ///
295 /// You need to rejoin a call for this setting to apply
296 #[serde(rename = "experimental.rodio_audio")]
297 pub rodio_audio: Option<bool>, // default is false
298 /// Requires 'rodio_audio: true'
299 ///
300 /// Automatically increase or decrease you microphone's volume. This affects how
301 /// loud you sound to others.
302 ///
303 /// Recommended: off (default)
304 /// Microphones are too quite in zed, until everyone is on experimental
305 /// audio and has auto speaker volume on this will make you very loud
306 /// compared to other speakers.
307 #[serde(rename = "experimental.auto_microphone_volume")]
308 pub auto_microphone_volume: Option<bool>,
309 /// Requires 'rodio_audio: true'
310 ///
311 /// Automatically increate or decrease the volume of other call members.
312 /// This only affects how things sound for you.
313 #[serde(rename = "experimental.auto_speaker_volume")]
314 pub auto_speaker_volume: Option<bool>,
315 /// Requires 'rodio_audio: true'
316 ///
317 /// Remove background noises. Works great for typing, cars, dogs, AC. Does
318 /// not work well on music.
319 #[serde(rename = "experimental.denoise")]
320 pub denoise: Option<bool>,
321 /// Requires 'rodio_audio: true'
322 ///
323 /// Use audio parameters compatible with the previous versions of
324 /// experimental audio and non-experimental audio. When this is false you
325 /// will sound strange to anyone not on the latest experimental audio. In
326 /// the future we will migrate by setting this to false
327 ///
328 /// You need to rejoin a call for this setting to apply
329 #[serde(rename = "experimental.legacy_audio_compatible")]
330 pub legacy_audio_compatible: Option<bool>,
331}
332
333/// Control what info is collected by Zed.
334#[skip_serializing_none]
335#[derive(Default, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Debug, MergeFrom)]
336pub struct TelemetrySettingsContent {
337 /// Send debug info like crash reports.
338 ///
339 /// Default: true
340 pub diagnostics: Option<bool>,
341 /// Send anonymized usage data like what languages you're using Zed with.
342 ///
343 /// Default: true
344 pub metrics: Option<bool>,
345}
346
347#[skip_serializing_none]
348#[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Clone, MergeFrom)]
349pub struct DebuggerSettingsContent {
350 /// Determines the stepping granularity.
351 ///
352 /// Default: line
353 pub stepping_granularity: Option<SteppingGranularity>,
354 /// Whether the breakpoints should be reused across Zed sessions.
355 ///
356 /// Default: true
357 pub save_breakpoints: Option<bool>,
358 /// Whether to show the debug button in the status bar.
359 ///
360 /// Default: true
361 pub button: Option<bool>,
362 /// Time in milliseconds until timeout error when connecting to a TCP debug adapter
363 ///
364 /// Default: 2000ms
365 pub timeout: Option<u64>,
366 /// Whether to log messages between active debug adapters and Zed
367 ///
368 /// Default: true
369 pub log_dap_communications: Option<bool>,
370 /// Whether to format dap messages in when adding them to debug adapter logger
371 ///
372 /// Default: true
373 pub format_dap_log_messages: Option<bool>,
374 /// The dock position of the debug panel
375 ///
376 /// Default: Bottom
377 pub dock: Option<DockPosition>,
378}
379
380/// The granularity of one 'step' in the stepping requests `next`, `stepIn`, `stepOut`, and `stepBack`.
381#[derive(
382 PartialEq, Eq, Debug, Hash, Clone, Copy, Deserialize, Serialize, JsonSchema, MergeFrom,
383)]
384#[serde(rename_all = "snake_case")]
385pub enum SteppingGranularity {
386 /// The step should allow the program to run until the current statement has finished executing.
387 /// The meaning of a statement is determined by the adapter and it may be considered equivalent to a line.
388 /// For example 'for(int i = 0; i < 10; i++)' could be considered to have 3 statements 'int i = 0', 'i < 10', and 'i++'.
389 Statement,
390 /// The step should allow the program to run until the current source line has executed.
391 Line,
392 /// The step should allow one instruction to execute (e.g. one x86 instruction).
393 Instruction,
394}
395
396#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
397#[serde(rename_all = "snake_case")]
398pub enum DockPosition {
399 Left,
400 Bottom,
401 Right,
402}
403
404/// Settings for slash commands.
405#[skip_serializing_none]
406#[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
407pub struct SlashCommandSettings {
408 /// Settings for the `/cargo-workspace` slash command.
409 pub cargo_workspace: Option<CargoWorkspaceCommandSettings>,
410}
411
412/// Settings for the `/cargo-workspace` slash command.
413#[skip_serializing_none]
414#[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
415pub struct CargoWorkspaceCommandSettings {
416 /// Whether `/cargo-workspace` is enabled.
417 pub enabled: Option<bool>,
418}
419
420/// Configuration of voice calls in Zed.
421#[skip_serializing_none]
422#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
423pub struct CallSettingsContent {
424 /// Whether the microphone should be muted when joining a channel or a call.
425 ///
426 /// Default: false
427 pub mute_on_join: Option<bool>,
428
429 /// Whether your current project should be shared when joining an empty channel.
430 ///
431 /// Default: false
432 pub share_on_join: Option<bool>,
433}
434
435#[skip_serializing_none]
436#[derive(Deserialize, Serialize, PartialEq, Debug, Default, Clone, JsonSchema, MergeFrom)]
437pub struct ExtensionSettingsContent {
438 /// The extensions that should be automatically installed by Zed.
439 ///
440 /// This is used to make functionality provided by extensions (e.g., language support)
441 /// available out-of-the-box.
442 ///
443 /// Default: { "html": true }
444 #[serde(default)]
445 pub auto_install_extensions: HashMap<Arc<str>, bool>,
446 #[serde(default)]
447 pub auto_update_extensions: HashMap<Arc<str>, bool>,
448}
449
450#[skip_serializing_none]
451#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
452pub struct GitPanelSettingsContent {
453 /// Whether to show the panel button in the status bar.
454 ///
455 /// Default: true
456 pub button: Option<bool>,
457 /// Where to dock the panel.
458 ///
459 /// Default: left
460 pub dock: Option<DockPosition>,
461 /// Default width of the panel in pixels.
462 ///
463 /// Default: 360
464 pub default_width: Option<f32>,
465 /// How entry statuses are displayed.
466 ///
467 /// Default: icon
468 pub status_style: Option<StatusStyle>,
469 /// How and when the scrollbar should be displayed.
470 ///
471 /// Default: inherits editor scrollbar settings
472 pub scrollbar: Option<ScrollbarSettings>,
473
474 /// What the default branch name should be when
475 /// `init.defaultBranch` is not set in git
476 ///
477 /// Default: main
478 pub fallback_branch_name: Option<String>,
479
480 /// Whether to sort entries in the panel by path
481 /// or by status (the default).
482 ///
483 /// Default: false
484 pub sort_by_path: Option<bool>,
485
486 /// Whether to collapse untracked files in the diff panel.
487 ///
488 /// Default: false
489 pub collapse_untracked_diff: Option<bool>,
490}
491
492#[derive(
493 Default, Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq,
494)]
495#[serde(rename_all = "snake_case")]
496pub enum StatusStyle {
497 #[default]
498 Icon,
499 LabelColor,
500}
501
502#[skip_serializing_none]
503#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
504pub struct ScrollbarSettings {
505 pub show: Option<ShowScrollbar>,
506}
507
508#[skip_serializing_none]
509#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
510pub struct NotificationPanelSettingsContent {
511 /// Whether to show the panel button in the status bar.
512 ///
513 /// Default: true
514 pub button: Option<bool>,
515 /// Where to dock the panel.
516 ///
517 /// Default: right
518 pub dock: Option<DockPosition>,
519 /// Default width of the panel in pixels.
520 ///
521 /// Default: 300
522 pub default_width: Option<f32>,
523}
524
525#[skip_serializing_none]
526#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
527pub struct PanelSettingsContent {
528 /// Whether to show the panel button in the status bar.
529 ///
530 /// Default: true
531 pub button: Option<bool>,
532 /// Where to dock the panel.
533 ///
534 /// Default: left
535 pub dock: Option<DockPosition>,
536 /// Default width of the panel in pixels.
537 ///
538 /// Default: 240
539 pub default_width: Option<f32>,
540}
541
542#[skip_serializing_none]
543#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
544pub struct MessageEditorSettings {
545 /// Whether to automatically replace emoji shortcodes with emoji characters.
546 /// For example: typing `:wave:` gets replaced with `👋`.
547 ///
548 /// Default: false
549 pub auto_replace_emoji_shortcode: Option<bool>,
550}
551
552#[skip_serializing_none]
553#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
554pub struct FileFinderSettingsContent {
555 /// Whether to show file icons in the file finder.
556 ///
557 /// Default: true
558 pub file_icons: Option<bool>,
559 /// Determines how much space the file finder can take up in relation to the available window width.
560 ///
561 /// Default: small
562 pub modal_max_width: Option<FileFinderWidthContent>,
563 /// Determines whether the file finder should skip focus for the active file in search results.
564 ///
565 /// Default: true
566 pub skip_focus_for_active_in_search: Option<bool>,
567 /// Determines whether to show the git status in the file finder
568 ///
569 /// Default: true
570 pub git_status: Option<bool>,
571 /// Whether to use gitignored files when searching.
572 /// Only the file Zed had indexed will be used, not necessary all the gitignored files.
573 ///
574 /// Can accept 3 values:
575 /// * `Some(true)`: Use all gitignored files
576 /// * `Some(false)`: Use only the files Zed had indexed
577 /// * `None`: Be smart and search for ignored when called from a gitignored worktree
578 ///
579 /// Default: None
580 /// todo() -> Change this type to an enum
581 pub include_ignored: Option<bool>,
582}
583
584#[derive(
585 Debug, PartialEq, Eq, Clone, Copy, Default, Serialize, Deserialize, JsonSchema, MergeFrom,
586)]
587#[serde(rename_all = "lowercase")]
588pub enum FileFinderWidthContent {
589 #[default]
590 Small,
591 Medium,
592 Large,
593 XLarge,
594 Full,
595}
596
597#[skip_serializing_none]
598#[derive(Clone, Default, Serialize, Deserialize, PartialEq, Debug, JsonSchema, MergeFrom)]
599pub struct VimSettingsContent {
600 pub default_mode: Option<ModeContent>,
601 pub toggle_relative_line_numbers: Option<bool>,
602 pub use_system_clipboard: Option<UseSystemClipboard>,
603 pub use_smartcase_find: Option<bool>,
604 pub custom_digraphs: Option<HashMap<String, Arc<str>>>,
605 pub highlight_on_yank_duration: Option<u64>,
606 pub cursor_shape: Option<CursorShapeSettings>,
607}
608
609#[derive(Copy, Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Debug)]
610#[serde(rename_all = "snake_case")]
611pub enum ModeContent {
612 #[default]
613 Normal,
614 Insert,
615 HelixNormal,
616}
617
618/// Controls when to use system clipboard.
619#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom)]
620#[serde(rename_all = "snake_case")]
621pub enum UseSystemClipboard {
622 /// Don't use system clipboard.
623 Never,
624 /// Use system clipboard.
625 Always,
626 /// Use system clipboard for yank operations.
627 OnYank,
628}
629
630/// The settings for cursor shape.
631#[skip_serializing_none]
632#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom)]
633pub struct CursorShapeSettings {
634 /// Cursor shape for the normal mode.
635 ///
636 /// Default: block
637 pub normal: Option<CursorShape>,
638 /// Cursor shape for the replace mode.
639 ///
640 /// Default: underline
641 pub replace: Option<CursorShape>,
642 /// Cursor shape for the visual mode.
643 ///
644 /// Default: block
645 pub visual: Option<CursorShape>,
646 /// Cursor shape for the insert mode.
647 ///
648 /// The default value follows the primary cursor_shape.
649 pub insert: Option<CursorShape>,
650}
651
652/// Settings specific to journaling
653#[skip_serializing_none]
654#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
655pub struct JournalSettingsContent {
656 /// The path of the directory where journal entries are stored.
657 ///
658 /// Default: `~`
659 pub path: Option<String>,
660 /// What format to display the hours in.
661 ///
662 /// Default: hour12
663 pub hour_format: Option<HourFormat>,
664}
665
666#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
667#[serde(rename_all = "snake_case")]
668pub enum HourFormat {
669 #[default]
670 Hour12,
671 Hour24,
672}
673
674#[skip_serializing_none]
675#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
676pub struct OutlinePanelSettingsContent {
677 /// Whether to show the outline panel button in the status bar.
678 ///
679 /// Default: true
680 pub button: Option<bool>,
681 /// Customize default width (in pixels) taken by outline panel
682 ///
683 /// Default: 240
684 pub default_width: Option<f32>,
685 /// The position of outline panel
686 ///
687 /// Default: left
688 pub dock: Option<DockSide>,
689 /// Whether to show file icons in the outline panel.
690 ///
691 /// Default: true
692 pub file_icons: Option<bool>,
693 /// Whether to show folder icons or chevrons for directories in the outline panel.
694 ///
695 /// Default: true
696 pub folder_icons: Option<bool>,
697 /// Whether to show the git status in the outline panel.
698 ///
699 /// Default: true
700 pub git_status: Option<bool>,
701 /// Amount of indentation (in pixels) for nested items.
702 ///
703 /// Default: 20
704 pub indent_size: Option<f32>,
705 /// Whether to reveal it in the outline panel automatically,
706 /// when a corresponding project entry becomes active.
707 /// Gitignored entries are never auto revealed.
708 ///
709 /// Default: true
710 pub auto_reveal_entries: Option<bool>,
711 /// Whether to fold directories automatically
712 /// when directory has only one directory inside.
713 ///
714 /// Default: true
715 pub auto_fold_dirs: Option<bool>,
716 /// Settings related to indent guides in the outline panel.
717 pub indent_guides: Option<IndentGuidesSettingsContent>,
718 /// Scrollbar-related settings
719 pub scrollbar: Option<ScrollbarSettingsContent>,
720 /// Default depth to expand outline items in the current file.
721 /// The default depth to which outline entries are expanded on reveal.
722 /// - Set to 0 to collapse all items that have children
723 /// - Set to 1 or higher to collapse items at that depth or deeper
724 ///
725 /// Default: 100
726 pub expand_outlines_with_depth: Option<usize>,
727}
728
729#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Copy, PartialEq)]
730#[serde(rename_all = "snake_case")]
731pub enum DockSide {
732 Left,
733 Right,
734}
735
736#[derive(Copy, Clone, Debug, PartialEq, Eq, Deserialize, Serialize, JsonSchema, MergeFrom)]
737#[serde(rename_all = "snake_case")]
738pub enum ShowIndentGuides {
739 Always,
740 Never,
741}
742
743#[skip_serializing_none]
744#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
745pub struct IndentGuidesSettingsContent {
746 /// When to show the scrollbar in the outline panel.
747 pub show: Option<ShowIndentGuides>,
748}
749
750#[derive(Clone, Copy, Default, PartialEq, Debug, JsonSchema, MergeFrom, Deserialize, Serialize)]
751#[serde(rename_all = "snake_case")]
752pub enum LineIndicatorFormat {
753 Short,
754 #[default]
755 Long,
756}
757
758/// The settings for the image viewer.
759#[skip_serializing_none]
760#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
761pub struct ImageViewerSettingsContent {
762 /// The unit to use for displaying image file sizes.
763 ///
764 /// Default: "binary"
765 pub unit: Option<ImageFileSizeUnit>,
766}
767
768#[skip_serializing_none]
769#[derive(Clone, Copy, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
770#[serde(rename_all = "snake_case")]
771pub enum ImageFileSizeUnit {
772 /// Displays file size in binary units (e.g., KiB, MiB).
773 #[default]
774 Binary,
775 /// Displays file size in decimal units (e.g., KB, MB).
776 Decimal,
777}
778
779#[skip_serializing_none]
780#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
781pub struct RemoteSettingsContent {
782 pub ssh_connections: Option<Vec<SshConnection>>,
783 pub wsl_connections: Option<Vec<WslConnection>>,
784 pub read_ssh_config: Option<bool>,
785}
786
787#[skip_serializing_none]
788#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom)]
789pub struct SshConnection {
790 pub host: SharedString,
791 pub username: Option<String>,
792 pub port: Option<u16>,
793 #[serde(default)]
794 pub args: Vec<String>,
795 #[serde(default)]
796 pub projects: collections::BTreeSet<SshProject>,
797 /// Name to use for this server in UI.
798 pub nickname: Option<String>,
799 // By default Zed will download the binary to the host directly.
800 // If this is set to true, Zed will download the binary to your local machine,
801 // and then upload it over the SSH connection. Useful if your SSH server has
802 // limited outbound internet access.
803 pub upload_binary_over_ssh: Option<bool>,
804
805 pub port_forwards: Option<Vec<SshPortForwardOption>>,
806}
807
808#[derive(Clone, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom, Debug)]
809pub struct WslConnection {
810 pub distro_name: SharedString,
811 pub user: Option<String>,
812 #[serde(default)]
813 pub projects: BTreeSet<SshProject>,
814}
815
816#[skip_serializing_none]
817#[derive(
818 Clone, Debug, Default, Serialize, PartialEq, Eq, PartialOrd, Ord, Deserialize, JsonSchema,
819)]
820pub struct SshProject {
821 pub paths: Vec<String>,
822}
823
824#[skip_serializing_none]
825#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize, JsonSchema, MergeFrom)]
826pub struct SshPortForwardOption {
827 #[serde(skip_serializing_if = "Option::is_none")]
828 pub local_host: Option<String>,
829 pub local_port: u16,
830 #[serde(skip_serializing_if = "Option::is_none")]
831 pub remote_host: Option<String>,
832 pub remote_port: u16,
833}
834
835/// Settings for configuring REPL display and behavior.
836#[skip_serializing_none]
837#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
838pub struct ReplSettingsContent {
839 /// Maximum number of lines to keep in REPL's scrollback buffer.
840 /// Clamped with [4, 256] range.
841 ///
842 /// Default: 32
843 pub max_lines: Option<usize>,
844 /// Maximum number of columns to keep in REPL's scrollback buffer.
845 /// Clamped with [20, 512] range.
846 ///
847 /// Default: 128
848 pub max_columns: Option<usize>,
849}
850
851#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
852/// An ExtendingVec in the settings can only accumulate new values.
853///
854/// This is useful for things like private files where you only want
855/// to allow new values to be added.
856///
857/// Consider using a HashMap<String, bool> instead of this type
858/// (like auto_install_extensions) so that user settings files can both add
859/// and remove values from the set.
860pub struct ExtendingVec<T>(pub Vec<T>);
861
862impl<T> Into<Vec<T>> for ExtendingVec<T> {
863 fn into(self) -> Vec<T> {
864 self.0
865 }
866}
867impl<T> From<Vec<T>> for ExtendingVec<T> {
868 fn from(vec: Vec<T>) -> Self {
869 ExtendingVec(vec)
870 }
871}
872
873impl<T: Clone> merge_from::MergeFrom for ExtendingVec<T> {
874 fn merge_from(&mut self, other: &Self) {
875 self.0.extend_from_slice(other.0.as_slice());
876 }
877}
878
879/// A SaturatingBool in the settings can only ever be set to true,
880/// later attempts to set it to false will be ignored.
881///
882/// Used by `disable_ai`.
883#[derive(Debug, Default, Copy, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
884pub struct SaturatingBool(pub bool);
885
886impl From<bool> for SaturatingBool {
887 fn from(value: bool) -> Self {
888 SaturatingBool(value)
889 }
890}
891
892impl merge_from::MergeFrom for SaturatingBool {
893 fn merge_from(&mut self, other: &Self) {
894 self.0 |= other.0
895 }
896}