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