1mod agent;
2mod editor;
3mod extension;
4mod fallible_options;
5mod language;
6mod language_model;
7pub mod merge_from;
8mod project;
9mod serde_helper;
10mod terminal;
11mod theme;
12mod workspace;
13
14pub use agent::*;
15pub use editor::*;
16pub use extension::*;
17pub use fallible_options::*;
18pub use language::*;
19pub use language_model::*;
20pub use merge_from::MergeFrom as MergeFromTrait;
21pub use project::*;
22use serde::de::DeserializeOwned;
23pub use serde_helper::{
24 serialize_f32_with_two_decimal_places, serialize_optional_f32_with_two_decimal_places,
25};
26use settings_json::parse_json_with_comments;
27pub use terminal::*;
28pub use theme::*;
29pub use workspace::*;
30
31use collections::{HashMap, IndexMap};
32use schemars::JsonSchema;
33use serde::{Deserialize, Serialize};
34use settings_macros::{MergeFrom, with_fallible_options};
35
36/// Defines a settings override struct where each field is
37/// `Option<Box<SettingsContent>>`, along with:
38/// - `OVERRIDE_KEYS`: a `&[&str]` of the field names (the JSON keys)
39/// - `get_by_key(&self, key) -> Option<&SettingsContent>`: accessor by key
40///
41/// The field list is the single source of truth for the override key strings.
42macro_rules! settings_overrides {
43 (
44 $(#[$attr:meta])*
45 pub struct $name:ident { $($field:ident),* $(,)? }
46 ) => {
47 $(#[$attr])*
48 pub struct $name {
49 $(pub $field: Option<Box<SettingsContent>>,)*
50 }
51
52 impl $name {
53 /// The JSON override keys, derived from the field names on this struct.
54 pub const OVERRIDE_KEYS: &[&str] = &[$(stringify!($field)),*];
55
56 /// Look up an override by its JSON key name.
57 pub fn get_by_key(&self, key: &str) -> Option<&SettingsContent> {
58 match key {
59 $(stringify!($field) => self.$field.as_deref(),)*
60 _ => None,
61 }
62 }
63 }
64 }
65}
66use std::collections::BTreeSet;
67use std::sync::Arc;
68pub use util::serde::default_true;
69
70#[derive(Debug, Clone, PartialEq, Eq)]
71pub enum ParseStatus {
72 /// Settings were parsed successfully
73 Success,
74 /// Settings failed to parse
75 Failed { error: String },
76}
77
78#[with_fallible_options]
79#[derive(Debug, PartialEq, Default, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
80pub struct SettingsContent {
81 #[serde(flatten)]
82 pub project: ProjectSettingsContent,
83
84 #[serde(flatten)]
85 pub theme: Box<ThemeSettingsContent>,
86
87 #[serde(flatten)]
88 pub extension: ExtensionSettingsContent,
89
90 #[serde(flatten)]
91 pub workspace: WorkspaceSettingsContent,
92
93 #[serde(flatten)]
94 pub editor: EditorSettingsContent,
95
96 #[serde(flatten)]
97 pub remote: RemoteSettingsContent,
98
99 /// Settings related to the file finder.
100 pub file_finder: Option<FileFinderSettingsContent>,
101
102 pub git_panel: Option<GitPanelSettingsContent>,
103
104 pub tabs: Option<ItemSettingsContent>,
105 pub tab_bar: Option<TabBarSettingsContent>,
106 pub status_bar: Option<StatusBarSettingsContent>,
107
108 pub preview_tabs: Option<PreviewTabsSettingsContent>,
109
110 pub agent: Option<AgentSettingsContent>,
111 pub agent_servers: Option<AllAgentServersSettings>,
112
113 /// Configuration of audio in Zed.
114 pub audio: Option<AudioSettingsContent>,
115
116 /// Whether or not to automatically check for updates.
117 ///
118 /// Default: true
119 pub auto_update: Option<bool>,
120
121 /// This base keymap settings adjusts the default keybindings in Zed to be similar
122 /// to other common code editors. By default, Zed's keymap closely follows VSCode's
123 /// keymap, with minor adjustments, this corresponds to the "VSCode" setting.
124 ///
125 /// Default: VSCode
126 pub base_keymap: Option<BaseKeymapContent>,
127
128 /// Configuration for the collab panel visual settings.
129 pub collaboration_panel: Option<PanelSettingsContent>,
130
131 pub debugger: Option<DebuggerSettingsContent>,
132
133 /// Configuration for Diagnostics-related features.
134 pub diagnostics: Option<DiagnosticsSettingsContent>,
135
136 /// Configuration for Git-related features
137 pub git: Option<GitSettings>,
138
139 /// Common language server settings.
140 pub global_lsp_settings: Option<GlobalLspSettingsContent>,
141
142 /// The settings for the image viewer.
143 pub image_viewer: Option<ImageViewerSettingsContent>,
144
145 pub repl: Option<ReplSettingsContent>,
146
147 /// Whether or not to enable Helix mode.
148 ///
149 /// Default: false
150 pub helix_mode: Option<bool>,
151
152 pub journal: Option<JournalSettingsContent>,
153
154 /// A map of log scopes to the desired log level.
155 /// Useful for filtering out noisy logs or enabling more verbose logging.
156 ///
157 /// Example: {"log": {"client": "warn"}}
158 pub log: Option<HashMap<String, String>>,
159
160 pub line_indicator_format: Option<LineIndicatorFormat>,
161
162 pub language_models: Option<AllLanguageModelSettingsContent>,
163
164 pub outline_panel: Option<OutlinePanelSettingsContent>,
165
166 pub project_panel: Option<ProjectPanelSettingsContent>,
167
168 /// Configuration for the Message Editor
169 pub message_editor: Option<MessageEditorSettings>,
170
171 /// Configuration for Node-related features
172 pub node: Option<NodeBinarySettings>,
173
174 /// Configuration for the Notification Panel
175 pub notification_panel: Option<NotificationPanelSettingsContent>,
176
177 pub proxy: Option<String>,
178
179 /// The URL of the Zed server to connect to.
180 pub server_url: Option<String>,
181
182 /// Configuration for session-related features
183 pub session: Option<SessionSettingsContent>,
184 /// Control what info is collected by Zed.
185 pub telemetry: Option<TelemetrySettingsContent>,
186
187 /// Configuration of the terminal in Zed.
188 pub terminal: Option<TerminalSettingsContent>,
189
190 pub title_bar: Option<TitleBarSettingsContent>,
191
192 /// Whether or not to enable Vim mode.
193 ///
194 /// Default: false
195 pub vim_mode: Option<bool>,
196
197 // Settings related to calls in Zed
198 pub calls: Option<CallSettingsContent>,
199
200 /// Settings for the which-key popup.
201 pub which_key: Option<WhichKeySettingsContent>,
202
203 /// Settings related to Vim mode in Zed.
204 pub vim: Option<VimSettingsContent>,
205}
206
207impl SettingsContent {
208 pub fn languages_mut(&mut self) -> &mut HashMap<String, LanguageSettingsContent> {
209 &mut self.project.all_languages.languages.0
210 }
211}
212
213// These impls are there to optimize builds by avoiding monomorphization downstream. Yes, they're repetitive, but using default impls
214// break the optimization, for whatever reason.
215pub trait RootUserSettings: Sized + DeserializeOwned {
216 fn parse_json(json: &str) -> (Option<Self>, ParseStatus);
217 fn parse_json_with_comments(json: &str) -> anyhow::Result<Self>;
218}
219
220impl RootUserSettings for SettingsContent {
221 fn parse_json(json: &str) -> (Option<Self>, ParseStatus) {
222 fallible_options::parse_json(json)
223 }
224 fn parse_json_with_comments(json: &str) -> anyhow::Result<Self> {
225 parse_json_with_comments(json)
226 }
227}
228// Explicit opt-in instead of blanket impl to avoid monomorphizing downstream. Just a hunch though.
229impl RootUserSettings for Option<SettingsContent> {
230 fn parse_json(json: &str) -> (Option<Self>, ParseStatus) {
231 fallible_options::parse_json(json)
232 }
233 fn parse_json_with_comments(json: &str) -> anyhow::Result<Self> {
234 parse_json_with_comments(json)
235 }
236}
237impl RootUserSettings for UserSettingsContent {
238 fn parse_json(json: &str) -> (Option<Self>, ParseStatus) {
239 fallible_options::parse_json(json)
240 }
241 fn parse_json_with_comments(json: &str) -> anyhow::Result<Self> {
242 parse_json_with_comments(json)
243 }
244}
245
246settings_overrides! {
247 #[with_fallible_options]
248 #[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
249 pub struct ReleaseChannelOverrides { dev, nightly, preview, stable }
250}
251
252settings_overrides! {
253 #[with_fallible_options]
254 #[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
255 pub struct PlatformOverrides { macos, linux, windows }
256}
257
258#[with_fallible_options]
259#[derive(Debug, Default, PartialEq, Clone, Serialize, Deserialize, JsonSchema, MergeFrom)]
260pub struct UserSettingsContent {
261 #[serde(flatten)]
262 pub content: Box<SettingsContent>,
263
264 #[serde(flatten)]
265 pub release_channel_overrides: ReleaseChannelOverrides,
266
267 #[serde(flatten)]
268 pub platform_overrides: PlatformOverrides,
269
270 #[serde(default)]
271 pub profiles: IndexMap<String, SettingsContent>,
272}
273
274pub struct ExtensionsSettingsContent {
275 pub all_languages: AllLanguageSettingsContent,
276}
277
278/// Base key bindings scheme. Base keymaps can be overridden with user keymaps.
279///
280/// Default: VSCode
281#[derive(
282 Copy,
283 Clone,
284 Debug,
285 Serialize,
286 Deserialize,
287 JsonSchema,
288 MergeFrom,
289 PartialEq,
290 Eq,
291 Default,
292 strum::VariantArray,
293)]
294pub enum BaseKeymapContent {
295 #[default]
296 VSCode,
297 JetBrains,
298 SublimeText,
299 Atom,
300 TextMate,
301 Emacs,
302 Cursor,
303 None,
304}
305
306impl strum::VariantNames for BaseKeymapContent {
307 const VARIANTS: &'static [&'static str] = &[
308 "VSCode",
309 "JetBrains",
310 "Sublime Text",
311 "Atom",
312 "TextMate",
313 "Emacs",
314 "Cursor",
315 "None",
316 ];
317}
318
319#[with_fallible_options]
320#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
321pub struct TitleBarSettingsContent {
322 /// Whether to show the branch icon beside branch switcher in the title bar.
323 ///
324 /// Default: false
325 pub show_branch_icon: Option<bool>,
326 /// Whether to show onboarding banners in the title bar.
327 ///
328 /// Default: true
329 pub show_onboarding_banner: Option<bool>,
330 /// Whether to show user avatar in the title bar.
331 ///
332 /// Default: true
333 pub show_user_picture: Option<bool>,
334 /// Whether to show the branch name button in the titlebar.
335 ///
336 /// Default: true
337 pub show_branch_name: Option<bool>,
338 /// Whether to show the project host and name in the titlebar.
339 ///
340 /// Default: true
341 pub show_project_items: Option<bool>,
342 /// Whether to show the sign in button in the title bar.
343 ///
344 /// Default: true
345 pub show_sign_in: Option<bool>,
346 /// Whether to show the user menu button in the title bar.
347 ///
348 /// Default: true
349 pub show_user_menu: Option<bool>,
350 /// Whether to show the menus in the title bar.
351 ///
352 /// Default: false
353 pub show_menus: Option<bool>,
354}
355
356/// Configuration of audio in Zed.
357#[with_fallible_options]
358#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
359pub struct AudioSettingsContent {
360 /// Opt into the new audio system.
361 ///
362 /// You need to rejoin a call for this setting to apply
363 #[serde(rename = "experimental.rodio_audio")]
364 pub rodio_audio: Option<bool>, // default is false
365 /// Requires 'rodio_audio: true'
366 ///
367 /// Automatically increase or decrease you microphone's volume. This affects how
368 /// loud you sound to others.
369 ///
370 /// Recommended: off (default)
371 /// Microphones are too quite in zed, until everyone is on experimental
372 /// audio and has auto speaker volume on this will make you very loud
373 /// compared to other speakers.
374 #[serde(rename = "experimental.auto_microphone_volume")]
375 pub auto_microphone_volume: Option<bool>,
376 /// Requires 'rodio_audio: true'
377 ///
378 /// Automatically increate or decrease the volume of other call members.
379 /// This only affects how things sound for you.
380 #[serde(rename = "experimental.auto_speaker_volume")]
381 pub auto_speaker_volume: Option<bool>,
382 /// Requires 'rodio_audio: true'
383 ///
384 /// Remove background noises. Works great for typing, cars, dogs, AC. Does
385 /// not work well on music.
386 #[serde(rename = "experimental.denoise")]
387 pub denoise: Option<bool>,
388 /// Requires 'rodio_audio: true'
389 ///
390 /// Use audio parameters compatible with the previous versions of
391 /// experimental audio and non-experimental audio. When this is false you
392 /// will sound strange to anyone not on the latest experimental audio. In
393 /// the future we will migrate by setting this to false
394 ///
395 /// You need to rejoin a call for this setting to apply
396 #[serde(rename = "experimental.legacy_audio_compatible")]
397 pub legacy_audio_compatible: Option<bool>,
398 /// Requires 'rodio_audio: true'
399 ///
400 /// Select specific output audio device.
401 #[serde(rename = "experimental.output_audio_device")]
402 pub output_audio_device: Option<AudioOutputDeviceName>,
403 /// Requires 'rodio_audio: true'
404 ///
405 /// Select specific input audio device.
406 #[serde(rename = "experimental.input_audio_device")]
407 pub input_audio_device: Option<AudioInputDeviceName>,
408}
409
410#[derive(Clone, Default, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
411#[serde(transparent)]
412pub struct AudioOutputDeviceName(pub Option<String>);
413
414impl AsRef<Option<String>> for AudioInputDeviceName {
415 fn as_ref(&self) -> &Option<String> {
416 &self.0
417 }
418}
419
420impl From<Option<String>> for AudioInputDeviceName {
421 fn from(value: Option<String>) -> Self {
422 Self(value)
423 }
424}
425
426#[derive(Clone, Default, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq)]
427#[serde(transparent)]
428pub struct AudioInputDeviceName(pub Option<String>);
429
430impl AsRef<Option<String>> for AudioOutputDeviceName {
431 fn as_ref(&self) -> &Option<String> {
432 &self.0
433 }
434}
435
436impl From<Option<String>> for AudioOutputDeviceName {
437 fn from(value: Option<String>) -> Self {
438 Self(value)
439 }
440}
441
442/// Control what info is collected by Zed.
443#[with_fallible_options]
444#[derive(Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Debug, MergeFrom)]
445pub struct TelemetrySettingsContent {
446 /// Send debug info like crash reports.
447 ///
448 /// Default: true
449 pub diagnostics: Option<bool>,
450 /// Send anonymized usage data like what languages you're using Zed with.
451 ///
452 /// Default: true
453 pub metrics: Option<bool>,
454}
455
456impl Default for TelemetrySettingsContent {
457 fn default() -> Self {
458 Self {
459 diagnostics: Some(true),
460 metrics: Some(true),
461 }
462 }
463}
464
465#[with_fallible_options]
466#[derive(Default, Debug, PartialEq, Eq, Serialize, Deserialize, JsonSchema, Clone, MergeFrom)]
467pub struct DebuggerSettingsContent {
468 /// Determines the stepping granularity.
469 ///
470 /// Default: line
471 pub stepping_granularity: Option<SteppingGranularity>,
472 /// Whether the breakpoints should be reused across Zed sessions.
473 ///
474 /// Default: true
475 pub save_breakpoints: Option<bool>,
476 /// Whether to show the debug button in the status bar.
477 ///
478 /// Default: true
479 pub button: Option<bool>,
480 /// Time in milliseconds until timeout error when connecting to a TCP debug adapter
481 ///
482 /// Default: 2000ms
483 pub timeout: Option<u64>,
484 /// Whether to log messages between active debug adapters and Zed
485 ///
486 /// Default: true
487 pub log_dap_communications: Option<bool>,
488 /// Whether to format dap messages in when adding them to debug adapter logger
489 ///
490 /// Default: true
491 pub format_dap_log_messages: Option<bool>,
492 /// The dock position of the debug panel
493 ///
494 /// Default: Bottom
495 pub dock: Option<DockPosition>,
496}
497
498/// The granularity of one 'step' in the stepping requests `next`, `stepIn`, `stepOut`, and `stepBack`.
499#[derive(
500 PartialEq,
501 Eq,
502 Debug,
503 Hash,
504 Clone,
505 Copy,
506 Deserialize,
507 Serialize,
508 JsonSchema,
509 MergeFrom,
510 strum::VariantArray,
511 strum::VariantNames,
512)]
513#[serde(rename_all = "snake_case")]
514pub enum SteppingGranularity {
515 /// The step should allow the program to run until the current statement has finished executing.
516 /// The meaning of a statement is determined by the adapter and it may be considered equivalent to a line.
517 /// For example 'for(int i = 0; i < 10; i++)' could be considered to have 3 statements 'int i = 0', 'i < 10', and 'i++'.
518 Statement,
519 /// The step should allow the program to run until the current source line has executed.
520 Line,
521 /// The step should allow one instruction to execute (e.g. one x86 instruction).
522 Instruction,
523}
524
525#[derive(
526 Copy,
527 Clone,
528 Debug,
529 Serialize,
530 Deserialize,
531 JsonSchema,
532 MergeFrom,
533 PartialEq,
534 Eq,
535 strum::VariantArray,
536 strum::VariantNames,
537)]
538#[serde(rename_all = "snake_case")]
539pub enum DockPosition {
540 Left,
541 Bottom,
542 Right,
543}
544
545/// Settings for slash commands.
546#[with_fallible_options]
547#[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
548pub struct SlashCommandSettings {
549 /// Settings for the `/cargo-workspace` slash command.
550 pub cargo_workspace: Option<CargoWorkspaceCommandSettings>,
551}
552
553/// Settings for the `/cargo-workspace` slash command.
554#[with_fallible_options]
555#[derive(Deserialize, Serialize, Debug, Default, Clone, JsonSchema, MergeFrom, PartialEq, Eq)]
556pub struct CargoWorkspaceCommandSettings {
557 /// Whether `/cargo-workspace` is enabled.
558 pub enabled: Option<bool>,
559}
560
561/// Configuration of voice calls in Zed.
562#[with_fallible_options]
563#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
564pub struct CallSettingsContent {
565 /// Whether the microphone should be muted when joining a channel or a call.
566 ///
567 /// Default: false
568 pub mute_on_join: Option<bool>,
569
570 /// Whether your current project should be shared when joining an empty channel.
571 ///
572 /// Default: false
573 pub share_on_join: Option<bool>,
574}
575
576#[with_fallible_options]
577#[derive(Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug)]
578pub struct GitPanelSettingsContent {
579 /// Whether to show the panel button in the status bar.
580 ///
581 /// Default: true
582 pub button: Option<bool>,
583 /// Where to dock the panel.
584 ///
585 /// Default: left
586 pub dock: Option<DockPosition>,
587 /// Default width of the panel in pixels.
588 ///
589 /// Default: 360
590 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
591 pub default_width: Option<f32>,
592 /// How entry statuses are displayed.
593 ///
594 /// Default: icon
595 pub status_style: Option<StatusStyle>,
596 /// How and when the scrollbar should be displayed.
597 ///
598 /// Default: inherits editor scrollbar settings
599 pub scrollbar: Option<ScrollbarSettings>,
600
601 /// What the default branch name should be when
602 /// `init.defaultBranch` is not set in git
603 ///
604 /// Default: main
605 pub fallback_branch_name: Option<String>,
606
607 /// Whether to sort entries in the panel by path
608 /// or by status (the default).
609 ///
610 /// Default: false
611 pub sort_by_path: Option<bool>,
612
613 /// Whether to collapse untracked files in the diff panel.
614 ///
615 /// Default: false
616 pub collapse_untracked_diff: Option<bool>,
617
618 /// Whether to show entries with tree or flat view in the panel
619 ///
620 /// Default: false
621 pub tree_view: Option<bool>,
622
623 /// Whether to show the addition/deletion change count next to each file in the Git panel.
624 ///
625 /// Default: false
626 pub diff_stats: Option<bool>,
627}
628
629#[derive(
630 Default,
631 Copy,
632 Clone,
633 Debug,
634 Serialize,
635 Deserialize,
636 JsonSchema,
637 MergeFrom,
638 PartialEq,
639 Eq,
640 strum::VariantArray,
641 strum::VariantNames,
642)]
643#[serde(rename_all = "snake_case")]
644pub enum StatusStyle {
645 #[default]
646 Icon,
647 LabelColor,
648}
649
650#[with_fallible_options]
651#[derive(
652 Copy, Clone, Default, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq,
653)]
654pub struct ScrollbarSettings {
655 pub show: Option<ShowScrollbar>,
656}
657
658#[with_fallible_options]
659#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
660pub struct NotificationPanelSettingsContent {
661 /// Whether to show the panel button in the status bar.
662 ///
663 /// Default: true
664 pub button: Option<bool>,
665 /// Where to dock the panel.
666 ///
667 /// Default: right
668 pub dock: Option<DockPosition>,
669 /// Default width of the panel in pixels.
670 ///
671 /// Default: 300
672 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
673 pub default_width: Option<f32>,
674}
675
676#[with_fallible_options]
677#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
678pub struct PanelSettingsContent {
679 /// Whether to show the panel button in the status bar.
680 ///
681 /// Default: true
682 pub button: Option<bool>,
683 /// Where to dock the panel.
684 ///
685 /// Default: left
686 pub dock: Option<DockPosition>,
687 /// Default width of the panel in pixels.
688 ///
689 /// Default: 240
690 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
691 pub default_width: Option<f32>,
692}
693
694#[with_fallible_options]
695#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
696pub struct MessageEditorSettings {
697 /// Whether to automatically replace emoji shortcodes with emoji characters.
698 /// For example: typing `:wave:` gets replaced with `👋`.
699 ///
700 /// Default: false
701 pub auto_replace_emoji_shortcode: Option<bool>,
702}
703
704#[with_fallible_options]
705#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
706pub struct FileFinderSettingsContent {
707 /// Whether to show file icons in the file finder.
708 ///
709 /// Default: true
710 pub file_icons: Option<bool>,
711 /// Determines how much space the file finder can take up in relation to the available window width.
712 ///
713 /// Default: small
714 pub modal_max_width: Option<FileFinderWidthContent>,
715 /// Determines whether the file finder should skip focus for the active file in search results.
716 ///
717 /// Default: true
718 pub skip_focus_for_active_in_search: Option<bool>,
719 /// Whether to use gitignored files when searching.
720 /// Only the file Zed had indexed will be used, not necessary all the gitignored files.
721 ///
722 /// Default: Smart
723 pub include_ignored: Option<IncludeIgnoredContent>,
724}
725
726#[derive(
727 Debug,
728 PartialEq,
729 Eq,
730 Clone,
731 Copy,
732 Default,
733 Serialize,
734 Deserialize,
735 JsonSchema,
736 MergeFrom,
737 strum::VariantArray,
738 strum::VariantNames,
739)]
740#[serde(rename_all = "snake_case")]
741pub enum IncludeIgnoredContent {
742 /// Use all gitignored files
743 All,
744 /// Use only the files Zed had indexed
745 Indexed,
746 /// Be smart and search for ignored when called from a gitignored worktree
747 #[default]
748 Smart,
749}
750
751#[derive(
752 Debug,
753 PartialEq,
754 Eq,
755 Clone,
756 Copy,
757 Default,
758 Serialize,
759 Deserialize,
760 JsonSchema,
761 MergeFrom,
762 strum::VariantArray,
763 strum::VariantNames,
764)]
765#[serde(rename_all = "lowercase")]
766pub enum FileFinderWidthContent {
767 #[default]
768 Small,
769 Medium,
770 Large,
771 XLarge,
772 Full,
773}
774
775#[with_fallible_options]
776#[derive(Clone, Default, Serialize, Deserialize, PartialEq, Debug, JsonSchema, MergeFrom)]
777pub struct VimSettingsContent {
778 pub default_mode: Option<ModeContent>,
779 pub toggle_relative_line_numbers: Option<bool>,
780 pub use_system_clipboard: Option<UseSystemClipboard>,
781 pub use_smartcase_find: Option<bool>,
782 /// When enabled, the `:substitute` command replaces all matches in a line
783 /// by default. The 'g' flag then toggles this behavior.,
784 pub gdefault: Option<bool>,
785 pub custom_digraphs: Option<HashMap<String, Arc<str>>>,
786 pub highlight_on_yank_duration: Option<u64>,
787 pub cursor_shape: Option<CursorShapeSettings>,
788}
789
790#[derive(
791 Copy,
792 Clone,
793 Default,
794 Serialize,
795 Deserialize,
796 JsonSchema,
797 MergeFrom,
798 PartialEq,
799 Debug,
800 strum::VariantArray,
801 strum::VariantNames,
802)]
803#[serde(rename_all = "snake_case")]
804pub enum ModeContent {
805 #[default]
806 Normal,
807 Insert,
808}
809
810/// Controls when to use system clipboard.
811#[derive(
812 Copy,
813 Clone,
814 Debug,
815 Serialize,
816 Deserialize,
817 PartialEq,
818 Eq,
819 JsonSchema,
820 MergeFrom,
821 strum::VariantArray,
822 strum::VariantNames,
823)]
824#[serde(rename_all = "snake_case")]
825pub enum UseSystemClipboard {
826 /// Don't use system clipboard.
827 Never,
828 /// Use system clipboard.
829 Always,
830 /// Use system clipboard for yank operations.
831 OnYank,
832}
833
834/// Cursor shape configuration for insert mode in Vim.
835#[derive(
836 Copy,
837 Clone,
838 Debug,
839 Serialize,
840 Deserialize,
841 PartialEq,
842 Eq,
843 JsonSchema,
844 MergeFrom,
845 strum::VariantArray,
846 strum::VariantNames,
847)]
848#[serde(rename_all = "snake_case")]
849pub enum VimInsertModeCursorShape {
850 /// Inherit cursor shape from the editor's base cursor_shape setting.
851 Inherit,
852 /// Vertical bar cursor.
853 Bar,
854 /// Block cursor that surrounds the character.
855 Block,
856 /// Underline cursor.
857 Underline,
858 /// Hollow box cursor.
859 Hollow,
860}
861
862/// The settings for cursor shape.
863#[with_fallible_options]
864#[derive(
865 Copy, Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom,
866)]
867pub struct CursorShapeSettings {
868 /// Cursor shape for the normal mode.
869 ///
870 /// Default: block
871 pub normal: Option<CursorShape>,
872 /// Cursor shape for the replace mode.
873 ///
874 /// Default: underline
875 pub replace: Option<CursorShape>,
876 /// Cursor shape for the visual mode.
877 ///
878 /// Default: block
879 pub visual: Option<CursorShape>,
880 /// Cursor shape for the insert mode.
881 ///
882 /// The default value follows the primary cursor_shape.
883 pub insert: Option<VimInsertModeCursorShape>,
884}
885
886/// Settings specific to journaling
887#[with_fallible_options]
888#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
889pub struct JournalSettingsContent {
890 /// The path of the directory where journal entries are stored.
891 ///
892 /// Default: `~`
893 pub path: Option<String>,
894 /// What format to display the hours in.
895 ///
896 /// Default: hour12
897 pub hour_format: Option<HourFormat>,
898}
899
900#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
901#[serde(rename_all = "snake_case")]
902pub enum HourFormat {
903 #[default]
904 Hour12,
905 Hour24,
906}
907
908#[with_fallible_options]
909#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
910pub struct OutlinePanelSettingsContent {
911 /// Whether to show the outline panel button in the status bar.
912 ///
913 /// Default: true
914 pub button: Option<bool>,
915 /// Customize default width (in pixels) taken by outline panel
916 ///
917 /// Default: 240
918 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
919 pub default_width: Option<f32>,
920 /// The position of outline panel
921 ///
922 /// Default: left
923 pub dock: Option<DockSide>,
924 /// Whether to show file icons in the outline panel.
925 ///
926 /// Default: true
927 pub file_icons: Option<bool>,
928 /// Whether to show folder icons or chevrons for directories in the outline panel.
929 ///
930 /// Default: true
931 pub folder_icons: Option<bool>,
932 /// Whether to show the git status in the outline panel.
933 ///
934 /// Default: true
935 pub git_status: Option<bool>,
936 /// Amount of indentation (in pixels) for nested items.
937 ///
938 /// Default: 20
939 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
940 pub indent_size: Option<f32>,
941 /// Whether to reveal it in the outline panel automatically,
942 /// when a corresponding project entry becomes active.
943 /// Gitignored entries are never auto revealed.
944 ///
945 /// Default: true
946 pub auto_reveal_entries: Option<bool>,
947 /// Whether to fold directories automatically
948 /// when directory has only one directory inside.
949 ///
950 /// Default: true
951 pub auto_fold_dirs: Option<bool>,
952 /// Settings related to indent guides in the outline panel.
953 pub indent_guides: Option<IndentGuidesSettingsContent>,
954 /// Scrollbar-related settings
955 pub scrollbar: Option<ScrollbarSettingsContent>,
956 /// Default depth to expand outline items in the current file.
957 /// The default depth to which outline entries are expanded on reveal.
958 /// - Set to 0 to collapse all items that have children
959 /// - Set to 1 or higher to collapse items at that depth or deeper
960 ///
961 /// Default: 100
962 pub expand_outlines_with_depth: Option<usize>,
963}
964
965#[derive(
966 Clone,
967 Copy,
968 Debug,
969 PartialEq,
970 Eq,
971 Serialize,
972 Deserialize,
973 JsonSchema,
974 MergeFrom,
975 strum::VariantArray,
976 strum::VariantNames,
977)]
978#[serde(rename_all = "snake_case")]
979pub enum DockSide {
980 Left,
981 Right,
982}
983
984#[derive(
985 Copy,
986 Clone,
987 Debug,
988 PartialEq,
989 Eq,
990 Deserialize,
991 Serialize,
992 JsonSchema,
993 MergeFrom,
994 strum::VariantArray,
995 strum::VariantNames,
996)]
997#[serde(rename_all = "snake_case")]
998pub enum ShowIndentGuides {
999 Always,
1000 Never,
1001}
1002
1003#[with_fallible_options]
1004#[derive(
1005 Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq, Default,
1006)]
1007pub struct IndentGuidesSettingsContent {
1008 /// When to show the scrollbar in the outline panel.
1009 pub show: Option<ShowIndentGuides>,
1010}
1011
1012#[derive(Clone, Copy, Default, PartialEq, Debug, JsonSchema, MergeFrom, Deserialize, Serialize)]
1013#[serde(rename_all = "snake_case")]
1014pub enum LineIndicatorFormat {
1015 Short,
1016 #[default]
1017 Long,
1018}
1019
1020/// The settings for the image viewer.
1021#[with_fallible_options]
1022#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
1023pub struct ImageViewerSettingsContent {
1024 /// The unit to use for displaying image file sizes.
1025 ///
1026 /// Default: "binary"
1027 pub unit: Option<ImageFileSizeUnit>,
1028}
1029
1030#[with_fallible_options]
1031#[derive(
1032 Clone,
1033 Copy,
1034 Debug,
1035 Serialize,
1036 Deserialize,
1037 JsonSchema,
1038 MergeFrom,
1039 Default,
1040 PartialEq,
1041 strum::VariantArray,
1042 strum::VariantNames,
1043)]
1044#[serde(rename_all = "snake_case")]
1045pub enum ImageFileSizeUnit {
1046 /// Displays file size in binary units (e.g., KiB, MiB).
1047 #[default]
1048 Binary,
1049 /// Displays file size in decimal units (e.g., KB, MB).
1050 Decimal,
1051}
1052
1053#[with_fallible_options]
1054#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
1055pub struct RemoteSettingsContent {
1056 pub ssh_connections: Option<Vec<SshConnection>>,
1057 pub wsl_connections: Option<Vec<WslConnection>>,
1058 pub dev_container_connections: Option<Vec<DevContainerConnection>>,
1059 pub read_ssh_config: Option<bool>,
1060 pub use_podman: Option<bool>,
1061}
1062
1063#[with_fallible_options]
1064#[derive(
1065 Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom, Hash,
1066)]
1067pub struct DevContainerConnection {
1068 pub name: String,
1069 pub remote_user: String,
1070 pub container_id: String,
1071 pub use_podman: bool,
1072}
1073
1074#[with_fallible_options]
1075#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom)]
1076pub struct SshConnection {
1077 pub host: String,
1078 pub username: Option<String>,
1079 pub port: Option<u16>,
1080 #[serde(default)]
1081 pub args: Vec<String>,
1082 #[serde(default)]
1083 pub projects: collections::BTreeSet<RemoteProject>,
1084 /// Name to use for this server in UI.
1085 pub nickname: Option<String>,
1086 // By default Zed will download the binary to the host directly.
1087 // If this is set to true, Zed will download the binary to your local machine,
1088 // and then upload it over the SSH connection. Useful if your SSH server has
1089 // limited outbound internet access.
1090 pub upload_binary_over_ssh: Option<bool>,
1091
1092 pub port_forwards: Option<Vec<SshPortForwardOption>>,
1093 /// Timeout in seconds for SSH connection and downloading the remote server binary.
1094 /// Defaults to 10 seconds if not specified.
1095 pub connection_timeout: Option<u16>,
1096}
1097
1098#[derive(Clone, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom, Debug)]
1099pub struct WslConnection {
1100 pub distro_name: String,
1101 pub user: Option<String>,
1102 #[serde(default)]
1103 pub projects: BTreeSet<RemoteProject>,
1104}
1105
1106#[with_fallible_options]
1107#[derive(
1108 Clone, Debug, Default, Serialize, PartialEq, Eq, PartialOrd, Ord, Deserialize, JsonSchema,
1109)]
1110pub struct RemoteProject {
1111 pub paths: Vec<String>,
1112}
1113
1114#[with_fallible_options]
1115#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize, JsonSchema, MergeFrom)]
1116pub struct SshPortForwardOption {
1117 pub local_host: Option<String>,
1118 pub local_port: u16,
1119 pub remote_host: Option<String>,
1120 pub remote_port: u16,
1121}
1122
1123/// Settings for configuring REPL display and behavior.
1124#[with_fallible_options]
1125#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
1126pub struct ReplSettingsContent {
1127 /// Maximum number of lines to keep in REPL's scrollback buffer.
1128 /// Clamped with [4, 256] range.
1129 ///
1130 /// Default: 32
1131 pub max_lines: Option<usize>,
1132 /// Maximum number of columns to keep in REPL's scrollback buffer.
1133 /// Clamped with [20, 512] range.
1134 ///
1135 /// Default: 128
1136 pub max_columns: Option<usize>,
1137 /// Whether to show small single-line outputs inline instead of in a block.
1138 ///
1139 /// Default: true
1140 pub inline_output: Option<bool>,
1141 /// Maximum number of characters for an output to be shown inline.
1142 /// Only applies when `inline_output` is true.
1143 ///
1144 /// Default: 50
1145 pub inline_output_max_length: Option<usize>,
1146 /// Maximum number of lines of output to display before scrolling.
1147 /// Set to 0 to disable output height limits.
1148 ///
1149 /// Default: 0
1150 pub output_max_height_lines: Option<usize>,
1151 /// Maximum number of columns of output to display before scaling images.
1152 /// Set to 0 to disable output width limits.
1153 ///
1154 /// Default: 0
1155 pub output_max_width_columns: Option<usize>,
1156}
1157
1158/// Settings for configuring the which-key popup behaviour.
1159#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
1160pub struct WhichKeySettingsContent {
1161 /// Whether to show the which-key popup when holding down key combinations
1162 ///
1163 /// Default: false
1164 pub enabled: Option<bool>,
1165 /// Delay in milliseconds before showing the which-key popup.
1166 ///
1167 /// Default: 700
1168 pub delay_ms: Option<u64>,
1169}
1170
1171#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
1172/// An ExtendingVec in the settings can only accumulate new values.
1173///
1174/// This is useful for things like private files where you only want
1175/// to allow new values to be added.
1176///
1177/// Consider using a HashMap<String, bool> instead of this type
1178/// (like auto_install_extensions) so that user settings files can both add
1179/// and remove values from the set.
1180pub struct ExtendingVec<T>(pub Vec<T>);
1181
1182impl<T> Into<Vec<T>> for ExtendingVec<T> {
1183 fn into(self) -> Vec<T> {
1184 self.0
1185 }
1186}
1187impl<T> From<Vec<T>> for ExtendingVec<T> {
1188 fn from(vec: Vec<T>) -> Self {
1189 ExtendingVec(vec)
1190 }
1191}
1192
1193impl<T: Clone> merge_from::MergeFrom for ExtendingVec<T> {
1194 fn merge_from(&mut self, other: &Self) {
1195 self.0.extend_from_slice(other.0.as_slice());
1196 }
1197}
1198
1199/// A SaturatingBool in the settings can only ever be set to true,
1200/// later attempts to set it to false will be ignored.
1201///
1202/// Used by `disable_ai`.
1203#[derive(Debug, Default, Copy, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
1204pub struct SaturatingBool(pub bool);
1205
1206impl From<bool> for SaturatingBool {
1207 fn from(value: bool) -> Self {
1208 SaturatingBool(value)
1209 }
1210}
1211
1212impl From<SaturatingBool> for bool {
1213 fn from(value: SaturatingBool) -> bool {
1214 value.0
1215 }
1216}
1217
1218impl merge_from::MergeFrom for SaturatingBool {
1219 fn merge_from(&mut self, other: &Self) {
1220 self.0 |= other.0
1221 }
1222}
1223
1224#[derive(
1225 Copy,
1226 Clone,
1227 Default,
1228 Debug,
1229 PartialEq,
1230 Eq,
1231 PartialOrd,
1232 Ord,
1233 Serialize,
1234 Deserialize,
1235 MergeFrom,
1236 JsonSchema,
1237 derive_more::FromStr,
1238)]
1239#[serde(transparent)]
1240pub struct DelayMs(pub u64);
1241
1242impl From<u64> for DelayMs {
1243 fn from(n: u64) -> Self {
1244 Self(n)
1245 }
1246}
1247
1248impl std::fmt::Display for DelayMs {
1249 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1250 write!(f, "{}ms", self.0)
1251 }
1252}