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
624#[derive(
625 Default,
626 Copy,
627 Clone,
628 Debug,
629 Serialize,
630 Deserialize,
631 JsonSchema,
632 MergeFrom,
633 PartialEq,
634 Eq,
635 strum::VariantArray,
636 strum::VariantNames,
637)]
638#[serde(rename_all = "snake_case")]
639pub enum StatusStyle {
640 #[default]
641 Icon,
642 LabelColor,
643}
644
645#[with_fallible_options]
646#[derive(
647 Copy, Clone, Default, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq,
648)]
649pub struct ScrollbarSettings {
650 pub show: Option<ShowScrollbar>,
651}
652
653#[with_fallible_options]
654#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
655pub struct NotificationPanelSettingsContent {
656 /// Whether to show the panel button in the status bar.
657 ///
658 /// Default: true
659 pub button: Option<bool>,
660 /// Where to dock the panel.
661 ///
662 /// Default: right
663 pub dock: Option<DockPosition>,
664 /// Default width of the panel in pixels.
665 ///
666 /// Default: 300
667 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
668 pub default_width: Option<f32>,
669}
670
671#[with_fallible_options]
672#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
673pub struct PanelSettingsContent {
674 /// Whether to show the panel button in the status bar.
675 ///
676 /// Default: true
677 pub button: Option<bool>,
678 /// Where to dock the panel.
679 ///
680 /// Default: left
681 pub dock: Option<DockPosition>,
682 /// Default width of the panel in pixels.
683 ///
684 /// Default: 240
685 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
686 pub default_width: Option<f32>,
687}
688
689#[with_fallible_options]
690#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
691pub struct MessageEditorSettings {
692 /// Whether to automatically replace emoji shortcodes with emoji characters.
693 /// For example: typing `:wave:` gets replaced with `👋`.
694 ///
695 /// Default: false
696 pub auto_replace_emoji_shortcode: Option<bool>,
697}
698
699#[with_fallible_options]
700#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
701pub struct FileFinderSettingsContent {
702 /// Whether to show file icons in the file finder.
703 ///
704 /// Default: true
705 pub file_icons: Option<bool>,
706 /// Determines how much space the file finder can take up in relation to the available window width.
707 ///
708 /// Default: small
709 pub modal_max_width: Option<FileFinderWidthContent>,
710 /// Determines whether the file finder should skip focus for the active file in search results.
711 ///
712 /// Default: true
713 pub skip_focus_for_active_in_search: Option<bool>,
714 /// Determines whether to show the git status in the file finder
715 ///
716 /// Default: true
717 pub git_status: Option<bool>,
718 /// Whether to use gitignored files when searching.
719 /// Only the file Zed had indexed will be used, not necessary all the gitignored files.
720 ///
721 /// Default: Smart
722 pub include_ignored: Option<IncludeIgnoredContent>,
723}
724
725#[derive(
726 Debug,
727 PartialEq,
728 Eq,
729 Clone,
730 Copy,
731 Default,
732 Serialize,
733 Deserialize,
734 JsonSchema,
735 MergeFrom,
736 strum::VariantArray,
737 strum::VariantNames,
738)]
739#[serde(rename_all = "snake_case")]
740pub enum IncludeIgnoredContent {
741 /// Use all gitignored files
742 All,
743 /// Use only the files Zed had indexed
744 Indexed,
745 /// Be smart and search for ignored when called from a gitignored worktree
746 #[default]
747 Smart,
748}
749
750#[derive(
751 Debug,
752 PartialEq,
753 Eq,
754 Clone,
755 Copy,
756 Default,
757 Serialize,
758 Deserialize,
759 JsonSchema,
760 MergeFrom,
761 strum::VariantArray,
762 strum::VariantNames,
763)]
764#[serde(rename_all = "lowercase")]
765pub enum FileFinderWidthContent {
766 #[default]
767 Small,
768 Medium,
769 Large,
770 XLarge,
771 Full,
772}
773
774#[with_fallible_options]
775#[derive(Clone, Default, Serialize, Deserialize, PartialEq, Debug, JsonSchema, MergeFrom)]
776pub struct VimSettingsContent {
777 pub default_mode: Option<ModeContent>,
778 pub toggle_relative_line_numbers: Option<bool>,
779 pub use_system_clipboard: Option<UseSystemClipboard>,
780 pub use_smartcase_find: Option<bool>,
781 /// When enabled, the `:substitute` command replaces all matches in a line
782 /// by default. The 'g' flag then toggles this behavior.,
783 pub gdefault: Option<bool>,
784 pub custom_digraphs: Option<HashMap<String, Arc<str>>>,
785 pub highlight_on_yank_duration: Option<u64>,
786 pub cursor_shape: Option<CursorShapeSettings>,
787}
788
789#[derive(
790 Copy,
791 Clone,
792 Default,
793 Serialize,
794 Deserialize,
795 JsonSchema,
796 MergeFrom,
797 PartialEq,
798 Debug,
799 strum::VariantArray,
800 strum::VariantNames,
801)]
802#[serde(rename_all = "snake_case")]
803pub enum ModeContent {
804 #[default]
805 Normal,
806 Insert,
807}
808
809/// Controls when to use system clipboard.
810#[derive(
811 Copy,
812 Clone,
813 Debug,
814 Serialize,
815 Deserialize,
816 PartialEq,
817 Eq,
818 JsonSchema,
819 MergeFrom,
820 strum::VariantArray,
821 strum::VariantNames,
822)]
823#[serde(rename_all = "snake_case")]
824pub enum UseSystemClipboard {
825 /// Don't use system clipboard.
826 Never,
827 /// Use system clipboard.
828 Always,
829 /// Use system clipboard for yank operations.
830 OnYank,
831}
832
833/// Cursor shape configuration for insert mode in Vim.
834#[derive(
835 Copy,
836 Clone,
837 Debug,
838 Serialize,
839 Deserialize,
840 PartialEq,
841 Eq,
842 JsonSchema,
843 MergeFrom,
844 strum::VariantArray,
845 strum::VariantNames,
846)]
847#[serde(rename_all = "snake_case")]
848pub enum VimInsertModeCursorShape {
849 /// Inherit cursor shape from the editor's base cursor_shape setting.
850 Inherit,
851 /// Vertical bar cursor.
852 Bar,
853 /// Block cursor that surrounds the character.
854 Block,
855 /// Underline cursor.
856 Underline,
857 /// Hollow box cursor.
858 Hollow,
859}
860
861/// The settings for cursor shape.
862#[with_fallible_options]
863#[derive(
864 Copy, Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom,
865)]
866pub struct CursorShapeSettings {
867 /// Cursor shape for the normal mode.
868 ///
869 /// Default: block
870 pub normal: Option<CursorShape>,
871 /// Cursor shape for the replace mode.
872 ///
873 /// Default: underline
874 pub replace: Option<CursorShape>,
875 /// Cursor shape for the visual mode.
876 ///
877 /// Default: block
878 pub visual: Option<CursorShape>,
879 /// Cursor shape for the insert mode.
880 ///
881 /// The default value follows the primary cursor_shape.
882 pub insert: Option<VimInsertModeCursorShape>,
883}
884
885/// Settings specific to journaling
886#[with_fallible_options]
887#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
888pub struct JournalSettingsContent {
889 /// The path of the directory where journal entries are stored.
890 ///
891 /// Default: `~`
892 pub path: Option<String>,
893 /// What format to display the hours in.
894 ///
895 /// Default: hour12
896 pub hour_format: Option<HourFormat>,
897}
898
899#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
900#[serde(rename_all = "snake_case")]
901pub enum HourFormat {
902 #[default]
903 Hour12,
904 Hour24,
905}
906
907#[with_fallible_options]
908#[derive(Clone, Default, Serialize, Deserialize, JsonSchema, MergeFrom, Debug, PartialEq)]
909pub struct OutlinePanelSettingsContent {
910 /// Whether to show the outline panel button in the status bar.
911 ///
912 /// Default: true
913 pub button: Option<bool>,
914 /// Customize default width (in pixels) taken by outline panel
915 ///
916 /// Default: 240
917 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
918 pub default_width: Option<f32>,
919 /// The position of outline panel
920 ///
921 /// Default: left
922 pub dock: Option<DockSide>,
923 /// Whether to show file icons in the outline panel.
924 ///
925 /// Default: true
926 pub file_icons: Option<bool>,
927 /// Whether to show folder icons or chevrons for directories in the outline panel.
928 ///
929 /// Default: true
930 pub folder_icons: Option<bool>,
931 /// Whether to show the git status in the outline panel.
932 ///
933 /// Default: true
934 pub git_status: Option<bool>,
935 /// Amount of indentation (in pixels) for nested items.
936 ///
937 /// Default: 20
938 #[serde(serialize_with = "crate::serialize_optional_f32_with_two_decimal_places")]
939 pub indent_size: Option<f32>,
940 /// Whether to reveal it in the outline panel automatically,
941 /// when a corresponding project entry becomes active.
942 /// Gitignored entries are never auto revealed.
943 ///
944 /// Default: true
945 pub auto_reveal_entries: Option<bool>,
946 /// Whether to fold directories automatically
947 /// when directory has only one directory inside.
948 ///
949 /// Default: true
950 pub auto_fold_dirs: Option<bool>,
951 /// Settings related to indent guides in the outline panel.
952 pub indent_guides: Option<IndentGuidesSettingsContent>,
953 /// Scrollbar-related settings
954 pub scrollbar: Option<ScrollbarSettingsContent>,
955 /// Default depth to expand outline items in the current file.
956 /// The default depth to which outline entries are expanded on reveal.
957 /// - Set to 0 to collapse all items that have children
958 /// - Set to 1 or higher to collapse items at that depth or deeper
959 ///
960 /// Default: 100
961 pub expand_outlines_with_depth: Option<usize>,
962}
963
964#[derive(
965 Clone,
966 Copy,
967 Debug,
968 PartialEq,
969 Eq,
970 Serialize,
971 Deserialize,
972 JsonSchema,
973 MergeFrom,
974 strum::VariantArray,
975 strum::VariantNames,
976)]
977#[serde(rename_all = "snake_case")]
978pub enum DockSide {
979 Left,
980 Right,
981}
982
983#[derive(
984 Copy,
985 Clone,
986 Debug,
987 PartialEq,
988 Eq,
989 Deserialize,
990 Serialize,
991 JsonSchema,
992 MergeFrom,
993 strum::VariantArray,
994 strum::VariantNames,
995)]
996#[serde(rename_all = "snake_case")]
997pub enum ShowIndentGuides {
998 Always,
999 Never,
1000}
1001
1002#[with_fallible_options]
1003#[derive(
1004 Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq, Eq, Default,
1005)]
1006pub struct IndentGuidesSettingsContent {
1007 /// When to show the scrollbar in the outline panel.
1008 pub show: Option<ShowIndentGuides>,
1009}
1010
1011#[derive(Clone, Copy, Default, PartialEq, Debug, JsonSchema, MergeFrom, Deserialize, Serialize)]
1012#[serde(rename_all = "snake_case")]
1013pub enum LineIndicatorFormat {
1014 Short,
1015 #[default]
1016 Long,
1017}
1018
1019/// The settings for the image viewer.
1020#[with_fallible_options]
1021#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema, MergeFrom, Default, PartialEq)]
1022pub struct ImageViewerSettingsContent {
1023 /// The unit to use for displaying image file sizes.
1024 ///
1025 /// Default: "binary"
1026 pub unit: Option<ImageFileSizeUnit>,
1027}
1028
1029#[with_fallible_options]
1030#[derive(
1031 Clone,
1032 Copy,
1033 Debug,
1034 Serialize,
1035 Deserialize,
1036 JsonSchema,
1037 MergeFrom,
1038 Default,
1039 PartialEq,
1040 strum::VariantArray,
1041 strum::VariantNames,
1042)]
1043#[serde(rename_all = "snake_case")]
1044pub enum ImageFileSizeUnit {
1045 /// Displays file size in binary units (e.g., KiB, MiB).
1046 #[default]
1047 Binary,
1048 /// Displays file size in decimal units (e.g., KB, MB).
1049 Decimal,
1050}
1051
1052#[with_fallible_options]
1053#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, MergeFrom, PartialEq)]
1054pub struct RemoteSettingsContent {
1055 pub ssh_connections: Option<Vec<SshConnection>>,
1056 pub wsl_connections: Option<Vec<WslConnection>>,
1057 pub dev_container_connections: Option<Vec<DevContainerConnection>>,
1058 pub read_ssh_config: Option<bool>,
1059 pub use_podman: Option<bool>,
1060}
1061
1062#[with_fallible_options]
1063#[derive(
1064 Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema, MergeFrom, Hash,
1065)]
1066pub struct DevContainerConnection {
1067 pub name: String,
1068 pub remote_user: String,
1069 pub container_id: String,
1070 pub use_podman: bool,
1071}
1072
1073#[with_fallible_options]
1074#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom)]
1075pub struct SshConnection {
1076 pub host: String,
1077 pub username: Option<String>,
1078 pub port: Option<u16>,
1079 #[serde(default)]
1080 pub args: Vec<String>,
1081 #[serde(default)]
1082 pub projects: collections::BTreeSet<RemoteProject>,
1083 /// Name to use for this server in UI.
1084 pub nickname: Option<String>,
1085 // By default Zed will download the binary to the host directly.
1086 // If this is set to true, Zed will download the binary to your local machine,
1087 // and then upload it over the SSH connection. Useful if your SSH server has
1088 // limited outbound internet access.
1089 pub upload_binary_over_ssh: Option<bool>,
1090
1091 pub port_forwards: Option<Vec<SshPortForwardOption>>,
1092 /// Timeout in seconds for SSH connection and downloading the remote server binary.
1093 /// Defaults to 10 seconds if not specified.
1094 pub connection_timeout: Option<u16>,
1095}
1096
1097#[derive(Clone, Default, Serialize, Deserialize, PartialEq, JsonSchema, MergeFrom, Debug)]
1098pub struct WslConnection {
1099 pub distro_name: String,
1100 pub user: Option<String>,
1101 #[serde(default)]
1102 pub projects: BTreeSet<RemoteProject>,
1103}
1104
1105#[with_fallible_options]
1106#[derive(
1107 Clone, Debug, Default, Serialize, PartialEq, Eq, PartialOrd, Ord, Deserialize, JsonSchema,
1108)]
1109pub struct RemoteProject {
1110 pub paths: Vec<String>,
1111}
1112
1113#[with_fallible_options]
1114#[derive(Debug, Clone, PartialEq, Eq, Hash, Deserialize, Serialize, JsonSchema, MergeFrom)]
1115pub struct SshPortForwardOption {
1116 pub local_host: Option<String>,
1117 pub local_port: u16,
1118 pub remote_host: Option<String>,
1119 pub remote_port: u16,
1120}
1121
1122/// Settings for configuring REPL display and behavior.
1123#[with_fallible_options]
1124#[derive(Clone, Debug, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
1125pub struct ReplSettingsContent {
1126 /// Maximum number of lines to keep in REPL's scrollback buffer.
1127 /// Clamped with [4, 256] range.
1128 ///
1129 /// Default: 32
1130 pub max_lines: Option<usize>,
1131 /// Maximum number of columns to keep in REPL's scrollback buffer.
1132 /// Clamped with [20, 512] range.
1133 ///
1134 /// Default: 128
1135 pub max_columns: Option<usize>,
1136 /// Whether to show small single-line outputs inline instead of in a block.
1137 ///
1138 /// Default: true
1139 pub inline_output: Option<bool>,
1140 /// Maximum number of characters for an output to be shown inline.
1141 /// Only applies when `inline_output` is true.
1142 ///
1143 /// Default: 50
1144 pub inline_output_max_length: Option<usize>,
1145 /// Maximum number of lines of output to display before scrolling.
1146 /// Set to 0 to disable output height limits.
1147 ///
1148 /// Default: 0
1149 pub output_max_height_lines: Option<usize>,
1150 /// Maximum number of columns of output to display before scaling images.
1151 /// Set to 0 to disable output width limits.
1152 ///
1153 /// Default: 0
1154 pub output_max_width_columns: Option<usize>,
1155}
1156
1157/// Settings for configuring the which-key popup behaviour.
1158#[derive(Clone, Debug, Default, PartialEq, Serialize, Deserialize, JsonSchema, MergeFrom)]
1159pub struct WhichKeySettingsContent {
1160 /// Whether to show the which-key popup when holding down key combinations
1161 ///
1162 /// Default: false
1163 pub enabled: Option<bool>,
1164 /// Delay in milliseconds before showing the which-key popup.
1165 ///
1166 /// Default: 700
1167 pub delay_ms: Option<u64>,
1168}
1169
1170#[derive(Default, Debug, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
1171/// An ExtendingVec in the settings can only accumulate new values.
1172///
1173/// This is useful for things like private files where you only want
1174/// to allow new values to be added.
1175///
1176/// Consider using a HashMap<String, bool> instead of this type
1177/// (like auto_install_extensions) so that user settings files can both add
1178/// and remove values from the set.
1179pub struct ExtendingVec<T>(pub Vec<T>);
1180
1181impl<T> Into<Vec<T>> for ExtendingVec<T> {
1182 fn into(self) -> Vec<T> {
1183 self.0
1184 }
1185}
1186impl<T> From<Vec<T>> for ExtendingVec<T> {
1187 fn from(vec: Vec<T>) -> Self {
1188 ExtendingVec(vec)
1189 }
1190}
1191
1192impl<T: Clone> merge_from::MergeFrom for ExtendingVec<T> {
1193 fn merge_from(&mut self, other: &Self) {
1194 self.0.extend_from_slice(other.0.as_slice());
1195 }
1196}
1197
1198/// A SaturatingBool in the settings can only ever be set to true,
1199/// later attempts to set it to false will be ignored.
1200///
1201/// Used by `disable_ai`.
1202#[derive(Debug, Default, Copy, Clone, PartialEq, Serialize, Deserialize, JsonSchema)]
1203pub struct SaturatingBool(pub bool);
1204
1205impl From<bool> for SaturatingBool {
1206 fn from(value: bool) -> Self {
1207 SaturatingBool(value)
1208 }
1209}
1210
1211impl From<SaturatingBool> for bool {
1212 fn from(value: SaturatingBool) -> bool {
1213 value.0
1214 }
1215}
1216
1217impl merge_from::MergeFrom for SaturatingBool {
1218 fn merge_from(&mut self, other: &Self) {
1219 self.0 |= other.0
1220 }
1221}
1222
1223#[derive(
1224 Copy,
1225 Clone,
1226 Default,
1227 Debug,
1228 PartialEq,
1229 Eq,
1230 PartialOrd,
1231 Ord,
1232 Serialize,
1233 Deserialize,
1234 MergeFrom,
1235 JsonSchema,
1236 derive_more::FromStr,
1237)]
1238#[serde(transparent)]
1239pub struct DelayMs(pub u64);
1240
1241impl From<u64> for DelayMs {
1242 fn from(n: u64) -> Self {
1243 Self(n)
1244 }
1245}
1246
1247impl std::fmt::Display for DelayMs {
1248 fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
1249 write!(f, "{}ms", self.0)
1250 }
1251}