1mod keymap_file;
2pub mod settings_file;
3pub mod watched_json;
4
5use anyhow::{bail, Result};
6use gpui::{
7 font_cache::{FamilyId, FontCache},
8 fonts, AssetSource,
9};
10use schemars::{
11 gen::{SchemaGenerator, SchemaSettings},
12 schema::{InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec},
13 JsonSchema,
14};
15use serde::{de::DeserializeOwned, Deserialize, Serialize};
16use serde_json::Value;
17use sqlez::{
18 bindable::{Bind, Column, StaticColumnCount},
19 statement::Statement,
20};
21use std::{collections::HashMap, num::NonZeroU32, str, sync::Arc};
22use theme::{Theme, ThemeRegistry};
23use tree_sitter::Query;
24use util::ResultExt as _;
25
26pub use keymap_file::{keymap_file_json_schema, KeymapFileContent};
27pub use watched_json::watch_files;
28
29#[derive(Clone)]
30pub struct Settings {
31 pub buffer_font_family_name: String,
32 pub buffer_font_features: fonts::Features,
33 pub buffer_font_family: FamilyId,
34 pub default_buffer_font_size: f32,
35 pub enable_copilot_integration: bool,
36 pub buffer_font_size: f32,
37 pub active_pane_magnification: f32,
38 pub cursor_blink: bool,
39 pub confirm_quit: bool,
40 pub hover_popover_enabled: bool,
41 pub show_completions_on_input: bool,
42 pub show_call_status_icon: bool,
43 pub vim_mode: bool,
44 pub autosave: Autosave,
45 pub default_dock_anchor: DockAnchor,
46 pub editor_defaults: EditorSettings,
47 pub editor_overrides: EditorSettings,
48 pub git: GitSettings,
49 pub git_overrides: GitSettings,
50 pub journal_defaults: JournalSettings,
51 pub journal_overrides: JournalSettings,
52 pub terminal_defaults: TerminalSettings,
53 pub terminal_overrides: TerminalSettings,
54 pub language_defaults: HashMap<Arc<str>, EditorSettings>,
55 pub language_overrides: HashMap<Arc<str>, EditorSettings>,
56 pub lsp: HashMap<Arc<str>, LspSettings>,
57 pub theme: Arc<Theme>,
58 pub telemetry_defaults: TelemetrySettings,
59 pub telemetry_overrides: TelemetrySettings,
60 pub auto_update: bool,
61 pub base_keymap: BaseKeymap,
62}
63
64#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq, Default)]
65#[serde(rename_all = "snake_case")]
66pub enum CopilotSettings {
67 #[default]
68 On,
69 Off,
70}
71
72impl From<CopilotSettings> for bool {
73 fn from(value: CopilotSettings) -> Self {
74 match value {
75 CopilotSettings::On => true,
76 CopilotSettings::Off => false,
77 }
78 }
79}
80
81impl CopilotSettings {
82 pub fn is_on(&self) -> bool {
83 <CopilotSettings as Into<bool>>::into(*self)
84 }
85}
86
87#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq, Default)]
88pub enum BaseKeymap {
89 #[default]
90 VSCode,
91 JetBrains,
92 SublimeText,
93 Atom,
94 TextMate,
95}
96
97impl BaseKeymap {
98 pub const OPTIONS: [(&'static str, Self); 5] = [
99 ("VSCode (Default)", Self::VSCode),
100 ("Atom", Self::Atom),
101 ("JetBrains", Self::JetBrains),
102 ("Sublime Text", Self::SublimeText),
103 ("TextMate", Self::TextMate),
104 ];
105
106 pub fn asset_path(&self) -> Option<&'static str> {
107 match self {
108 BaseKeymap::JetBrains => Some("keymaps/jetbrains.json"),
109 BaseKeymap::SublimeText => Some("keymaps/sublime_text.json"),
110 BaseKeymap::Atom => Some("keymaps/atom.json"),
111 BaseKeymap::TextMate => Some("keymaps/textmate.json"),
112 BaseKeymap::VSCode => None,
113 }
114 }
115
116 pub fn names() -> impl Iterator<Item = &'static str> {
117 Self::OPTIONS.iter().map(|(name, _)| *name)
118 }
119
120 pub fn from_names(option: &str) -> BaseKeymap {
121 Self::OPTIONS
122 .iter()
123 .copied()
124 .find_map(|(name, value)| (name == option).then(|| value))
125 .unwrap_or_default()
126 }
127}
128
129#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
130pub struct TelemetrySettings {
131 diagnostics: Option<bool>,
132 metrics: Option<bool>,
133}
134
135impl TelemetrySettings {
136 pub fn metrics(&self) -> bool {
137 self.metrics.unwrap()
138 }
139
140 pub fn diagnostics(&self) -> bool {
141 self.diagnostics.unwrap()
142 }
143
144 pub fn set_metrics(&mut self, value: bool) {
145 self.metrics = Some(value);
146 }
147
148 pub fn set_diagnostics(&mut self, value: bool) {
149 self.diagnostics = Some(value);
150 }
151}
152
153#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
154pub struct GitSettings {
155 pub git_gutter: Option<GitGutter>,
156 pub gutter_debounce: Option<u64>,
157}
158
159#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, JsonSchema)]
160#[serde(rename_all = "snake_case")]
161pub enum GitGutter {
162 #[default]
163 TrackedFiles,
164 Hide,
165}
166
167pub struct GitGutterConfig {}
168
169#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
170pub struct EditorSettings {
171 pub tab_size: Option<NonZeroU32>,
172 pub hard_tabs: Option<bool>,
173 pub soft_wrap: Option<SoftWrap>,
174 pub preferred_line_length: Option<u32>,
175 pub format_on_save: Option<FormatOnSave>,
176 pub remove_trailing_whitespace_on_save: Option<bool>,
177 pub ensure_final_newline_on_save: Option<bool>,
178 pub formatter: Option<Formatter>,
179 pub enable_language_server: Option<bool>,
180 pub copilot: Option<OnOff>,
181}
182
183#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
184#[serde(rename_all = "snake_case")]
185pub enum OnOff {
186 On,
187 Off,
188}
189
190impl OnOff {
191 pub fn as_bool(&self) -> bool {
192 match self {
193 OnOff::On => true,
194 OnOff::Off => false,
195 }
196 }
197
198 pub fn from_bool(value: bool) -> OnOff {
199 match value {
200 true => OnOff::On,
201 false => OnOff::Off,
202 }
203 }
204}
205
206impl From<OnOff> for bool {
207 fn from(value: OnOff) -> bool {
208 value.as_bool()
209 }
210}
211
212impl From<bool> for OnOff {
213 fn from(value: bool) -> OnOff {
214 OnOff::from_bool(value)
215 }
216}
217
218#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
219#[serde(rename_all = "snake_case")]
220pub enum SoftWrap {
221 None,
222 EditorWidth,
223 PreferredLineLength,
224}
225#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
226#[serde(rename_all = "snake_case")]
227pub enum FormatOnSave {
228 On,
229 Off,
230 LanguageServer,
231 External {
232 command: String,
233 arguments: Vec<String>,
234 },
235}
236
237#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
238#[serde(rename_all = "snake_case")]
239pub enum Formatter {
240 LanguageServer,
241 External {
242 command: String,
243 arguments: Vec<String>,
244 },
245}
246
247#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
248#[serde(rename_all = "snake_case")]
249pub enum Autosave {
250 Off,
251 AfterDelay { milliseconds: u64 },
252 OnFocusChange,
253 OnWindowChange,
254}
255
256#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
257pub struct JournalSettings {
258 pub path: Option<String>,
259 pub hour_format: Option<HourFormat>,
260}
261
262impl Default for JournalSettings {
263 fn default() -> Self {
264 Self {
265 path: Some("~".into()),
266 hour_format: Some(Default::default()),
267 }
268 }
269}
270
271#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
272#[serde(rename_all = "snake_case")]
273pub enum HourFormat {
274 Hour12,
275 Hour24,
276}
277
278impl Default for HourFormat {
279 fn default() -> Self {
280 Self::Hour12
281 }
282}
283
284#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
285pub struct TerminalSettings {
286 pub shell: Option<Shell>,
287 pub working_directory: Option<WorkingDirectory>,
288 pub font_size: Option<f32>,
289 pub font_family: Option<String>,
290 pub font_features: Option<fonts::Features>,
291 pub env: Option<HashMap<String, String>>,
292 pub blinking: Option<TerminalBlink>,
293 pub alternate_scroll: Option<AlternateScroll>,
294 pub option_as_meta: Option<bool>,
295 pub copy_on_select: Option<bool>,
296}
297
298#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
299#[serde(rename_all = "snake_case")]
300pub enum TerminalBlink {
301 Off,
302 TerminalControlled,
303 On,
304}
305
306impl Default for TerminalBlink {
307 fn default() -> Self {
308 TerminalBlink::TerminalControlled
309 }
310}
311
312#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
313#[serde(rename_all = "snake_case")]
314pub enum Shell {
315 System,
316 Program(String),
317 WithArguments { program: String, args: Vec<String> },
318}
319
320impl Default for Shell {
321 fn default() -> Self {
322 Shell::System
323 }
324}
325
326#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
327#[serde(rename_all = "snake_case")]
328pub enum AlternateScroll {
329 On,
330 Off,
331}
332
333impl Default for AlternateScroll {
334 fn default() -> Self {
335 AlternateScroll::On
336 }
337}
338
339#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
340#[serde(rename_all = "snake_case")]
341pub enum WorkingDirectory {
342 CurrentProjectDirectory,
343 FirstProjectDirectory,
344 AlwaysHome,
345 Always { directory: String },
346}
347
348impl Default for WorkingDirectory {
349 fn default() -> Self {
350 Self::CurrentProjectDirectory
351 }
352}
353
354#[derive(PartialEq, Eq, Debug, Default, Copy, Clone, Hash, Serialize, Deserialize, JsonSchema)]
355#[serde(rename_all = "snake_case")]
356pub enum DockAnchor {
357 #[default]
358 Bottom,
359 Right,
360 Expanded,
361}
362
363impl StaticColumnCount for DockAnchor {}
364impl Bind for DockAnchor {
365 fn bind(&self, statement: &Statement, start_index: i32) -> anyhow::Result<i32> {
366 match self {
367 DockAnchor::Bottom => "Bottom",
368 DockAnchor::Right => "Right",
369 DockAnchor::Expanded => "Expanded",
370 }
371 .bind(statement, start_index)
372 }
373}
374
375impl Column for DockAnchor {
376 fn column(statement: &mut Statement, start_index: i32) -> anyhow::Result<(Self, i32)> {
377 String::column(statement, start_index).and_then(|(anchor_text, next_index)| {
378 Ok((
379 match anchor_text.as_ref() {
380 "Bottom" => DockAnchor::Bottom,
381 "Right" => DockAnchor::Right,
382 "Expanded" => DockAnchor::Expanded,
383 _ => bail!("Stored dock anchor is incorrect"),
384 },
385 next_index,
386 ))
387 })
388 }
389}
390
391#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
392pub struct SettingsFileContent {
393 #[serde(default)]
394 pub buffer_font_family: Option<String>,
395 #[serde(default)]
396 pub buffer_font_size: Option<f32>,
397 #[serde(default)]
398 pub buffer_font_features: Option<fonts::Features>,
399 #[serde(default)]
400 pub active_pane_magnification: Option<f32>,
401 #[serde(default)]
402 pub cursor_blink: Option<bool>,
403 #[serde(default)]
404 pub confirm_quit: Option<bool>,
405 #[serde(default)]
406 pub hover_popover_enabled: Option<bool>,
407 #[serde(default)]
408 pub show_completions_on_input: Option<bool>,
409 #[serde(default)]
410 pub show_call_status_icon: Option<bool>,
411 #[serde(default)]
412 pub vim_mode: Option<bool>,
413 #[serde(default)]
414 pub autosave: Option<Autosave>,
415 #[serde(default)]
416 pub default_dock_anchor: Option<DockAnchor>,
417 #[serde(flatten)]
418 pub editor: EditorSettings,
419 #[serde(default)]
420 pub journal: JournalSettings,
421 #[serde(default)]
422 pub terminal: TerminalSettings,
423 #[serde(default)]
424 pub git: Option<GitSettings>,
425 #[serde(default)]
426 #[serde(alias = "language_overrides")]
427 pub languages: HashMap<Arc<str>, EditorSettings>,
428 #[serde(default)]
429 pub lsp: HashMap<Arc<str>, LspSettings>,
430 #[serde(default)]
431 pub theme: Option<String>,
432 #[serde(default)]
433 pub telemetry: TelemetrySettings,
434 #[serde(default)]
435 pub auto_update: Option<bool>,
436 #[serde(default)]
437 pub base_keymap: Option<BaseKeymap>,
438 #[serde(default)]
439 pub enable_copilot_integration: Option<bool>,
440}
441
442#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
443#[serde(rename_all = "snake_case")]
444pub struct LspSettings {
445 pub initialization_options: Option<Value>,
446}
447
448impl Settings {
449 /// Fill out the settings corresponding to the default.json file, overrides will be set later
450 pub fn defaults(
451 assets: impl AssetSource,
452 font_cache: &FontCache,
453 themes: &ThemeRegistry,
454 ) -> Self {
455 #[track_caller]
456 fn required<T>(value: Option<T>) -> Option<T> {
457 assert!(value.is_some(), "missing default setting value");
458 value
459 }
460
461 let defaults: SettingsFileContent = parse_json_with_comments(
462 str::from_utf8(assets.load("settings/default.json").unwrap().as_ref()).unwrap(),
463 )
464 .unwrap();
465
466 let buffer_font_features = defaults.buffer_font_features.unwrap();
467 Self {
468 buffer_font_family: font_cache
469 .load_family(
470 &[defaults.buffer_font_family.as_ref().unwrap()],
471 &buffer_font_features,
472 )
473 .unwrap(),
474 buffer_font_family_name: defaults.buffer_font_family.unwrap(),
475 buffer_font_features,
476 buffer_font_size: defaults.buffer_font_size.unwrap(),
477 active_pane_magnification: defaults.active_pane_magnification.unwrap(),
478 default_buffer_font_size: defaults.buffer_font_size.unwrap(),
479 confirm_quit: defaults.confirm_quit.unwrap(),
480 cursor_blink: defaults.cursor_blink.unwrap(),
481 hover_popover_enabled: defaults.hover_popover_enabled.unwrap(),
482 show_completions_on_input: defaults.show_completions_on_input.unwrap(),
483 show_call_status_icon: defaults.show_call_status_icon.unwrap(),
484 vim_mode: defaults.vim_mode.unwrap(),
485 autosave: defaults.autosave.unwrap(),
486 default_dock_anchor: defaults.default_dock_anchor.unwrap(),
487 editor_defaults: EditorSettings {
488 tab_size: required(defaults.editor.tab_size),
489 hard_tabs: required(defaults.editor.hard_tabs),
490 soft_wrap: required(defaults.editor.soft_wrap),
491 preferred_line_length: required(defaults.editor.preferred_line_length),
492 remove_trailing_whitespace_on_save: required(
493 defaults.editor.remove_trailing_whitespace_on_save,
494 ),
495 ensure_final_newline_on_save: required(
496 defaults.editor.ensure_final_newline_on_save,
497 ),
498 format_on_save: required(defaults.editor.format_on_save),
499 formatter: required(defaults.editor.formatter),
500 enable_language_server: required(defaults.editor.enable_language_server),
501 copilot: required(defaults.editor.copilot),
502 },
503 editor_overrides: Default::default(),
504 git: defaults.git.unwrap(),
505 git_overrides: Default::default(),
506 journal_defaults: defaults.journal,
507 journal_overrides: Default::default(),
508 terminal_defaults: defaults.terminal,
509 terminal_overrides: Default::default(),
510 language_defaults: defaults.languages,
511 language_overrides: Default::default(),
512 lsp: defaults.lsp.clone(),
513 theme: themes.get(&defaults.theme.unwrap()).unwrap(),
514 telemetry_defaults: defaults.telemetry,
515 telemetry_overrides: Default::default(),
516 auto_update: defaults.auto_update.unwrap(),
517 base_keymap: Default::default(),
518 enable_copilot_integration: defaults.enable_copilot_integration.unwrap(),
519 }
520 }
521
522 // Fill out the overrride and etc. settings from the user's settings.json
523 pub fn set_user_settings(
524 &mut self,
525 data: SettingsFileContent,
526 theme_registry: &ThemeRegistry,
527 font_cache: &FontCache,
528 ) {
529 let mut family_changed = false;
530 if let Some(value) = data.buffer_font_family {
531 self.buffer_font_family_name = value;
532 family_changed = true;
533 }
534 if let Some(value) = data.buffer_font_features {
535 self.buffer_font_features = value;
536 family_changed = true;
537 }
538 if family_changed {
539 if let Some(id) = font_cache
540 .load_family(&[&self.buffer_font_family_name], &self.buffer_font_features)
541 .log_err()
542 {
543 self.buffer_font_family = id;
544 }
545 }
546
547 if let Some(value) = &data.theme {
548 if let Some(theme) = theme_registry.get(value).log_err() {
549 self.theme = theme;
550 }
551 }
552
553 merge(&mut self.buffer_font_size, data.buffer_font_size);
554 merge(
555 &mut self.active_pane_magnification,
556 data.active_pane_magnification,
557 );
558 merge(&mut self.default_buffer_font_size, data.buffer_font_size);
559 merge(&mut self.cursor_blink, data.cursor_blink);
560 merge(&mut self.confirm_quit, data.confirm_quit);
561 merge(&mut self.hover_popover_enabled, data.hover_popover_enabled);
562 merge(
563 &mut self.show_completions_on_input,
564 data.show_completions_on_input,
565 );
566 merge(&mut self.vim_mode, data.vim_mode);
567 merge(&mut self.autosave, data.autosave);
568 merge(&mut self.default_dock_anchor, data.default_dock_anchor);
569 merge(&mut self.base_keymap, data.base_keymap);
570
571 self.editor_overrides = data.editor;
572 self.git_overrides = data.git.unwrap_or_default();
573 self.journal_overrides = data.journal;
574 self.terminal_defaults.font_size = data.terminal.font_size;
575 self.terminal_overrides.copy_on_select = data.terminal.copy_on_select;
576 self.terminal_overrides = data.terminal;
577 self.language_overrides = data.languages;
578 self.telemetry_overrides = data.telemetry;
579 self.lsp = data.lsp;
580 merge(&mut self.auto_update, data.auto_update);
581 }
582
583 pub fn with_language_defaults(
584 mut self,
585 language_name: impl Into<Arc<str>>,
586 overrides: EditorSettings,
587 ) -> Self {
588 self.language_defaults
589 .insert(language_name.into(), overrides);
590 self
591 }
592
593 pub fn copilot_on(&self, language: Option<&str>) -> bool {
594 if self.enable_copilot_integration {
595 self.language_setting(language, |settings| settings.copilot.map(Into::into))
596 } else {
597 false
598 }
599 }
600
601 pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 {
602 self.language_setting(language, |settings| settings.tab_size)
603 }
604
605 pub fn hard_tabs(&self, language: Option<&str>) -> bool {
606 self.language_setting(language, |settings| settings.hard_tabs)
607 }
608
609 pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap {
610 self.language_setting(language, |settings| settings.soft_wrap)
611 }
612
613 pub fn preferred_line_length(&self, language: Option<&str>) -> u32 {
614 self.language_setting(language, |settings| settings.preferred_line_length)
615 }
616
617 pub fn remove_trailing_whitespace_on_save(&self, language: Option<&str>) -> bool {
618 self.language_setting(language, |settings| {
619 settings.remove_trailing_whitespace_on_save.clone()
620 })
621 }
622
623 pub fn ensure_final_newline_on_save(&self, language: Option<&str>) -> bool {
624 self.language_setting(language, |settings| {
625 settings.ensure_final_newline_on_save.clone()
626 })
627 }
628
629 pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave {
630 self.language_setting(language, |settings| settings.format_on_save.clone())
631 }
632
633 pub fn formatter(&self, language: Option<&str>) -> Formatter {
634 self.language_setting(language, |settings| settings.formatter.clone())
635 }
636
637 pub fn enable_language_server(&self, language: Option<&str>) -> bool {
638 self.language_setting(language, |settings| settings.enable_language_server)
639 }
640
641 fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> R
642 where
643 F: Fn(&EditorSettings) -> Option<R>,
644 {
645 None.or_else(|| language.and_then(|l| self.language_overrides.get(l).and_then(&f)))
646 .or_else(|| f(&self.editor_overrides))
647 .or_else(|| language.and_then(|l| self.language_defaults.get(l).and_then(&f)))
648 .or_else(|| f(&self.editor_defaults))
649 .expect("missing default")
650 }
651
652 pub fn git_gutter(&self) -> GitGutter {
653 self.git_overrides.git_gutter.unwrap_or_else(|| {
654 self.git
655 .git_gutter
656 .expect("git_gutter should be some by setting setup")
657 })
658 }
659
660 fn terminal_setting<F, R: Default + Clone>(&self, f: F) -> R
661 where
662 F: Fn(&TerminalSettings) -> Option<&R>,
663 {
664 f(&self.terminal_overrides)
665 .or_else(|| f(&self.terminal_defaults))
666 .cloned()
667 .unwrap_or_else(|| R::default())
668 }
669
670 pub fn telemetry(&self) -> TelemetrySettings {
671 TelemetrySettings {
672 diagnostics: Some(self.telemetry_diagnostics()),
673 metrics: Some(self.telemetry_metrics()),
674 }
675 }
676
677 pub fn telemetry_diagnostics(&self) -> bool {
678 self.telemetry_overrides
679 .diagnostics
680 .or(self.telemetry_defaults.diagnostics)
681 .expect("missing default")
682 }
683
684 pub fn telemetry_metrics(&self) -> bool {
685 self.telemetry_overrides
686 .metrics
687 .or(self.telemetry_defaults.metrics)
688 .expect("missing default")
689 }
690
691 pub fn terminal_scroll(&self) -> AlternateScroll {
692 self.terminal_setting(|terminal_setting| terminal_setting.alternate_scroll.as_ref())
693 }
694
695 pub fn terminal_shell(&self) -> Shell {
696 self.terminal_setting(|terminal_setting| terminal_setting.shell.as_ref())
697 }
698
699 pub fn terminal_env(&self) -> HashMap<String, String> {
700 self.terminal_setting(|terminal_setting| terminal_setting.env.as_ref())
701 }
702
703 pub fn terminal_strategy(&self) -> WorkingDirectory {
704 self.terminal_setting(|terminal_setting| terminal_setting.working_directory.as_ref())
705 }
706
707 #[cfg(any(test, feature = "test-support"))]
708 pub fn test(cx: &gpui::AppContext) -> Settings {
709 Settings {
710 buffer_font_family_name: "Monaco".to_string(),
711 buffer_font_features: Default::default(),
712 buffer_font_family: cx
713 .font_cache()
714 .load_family(&["Monaco"], &Default::default())
715 .unwrap(),
716 buffer_font_size: 14.,
717 active_pane_magnification: 1.,
718 default_buffer_font_size: 14.,
719 confirm_quit: false,
720 cursor_blink: true,
721 hover_popover_enabled: true,
722 show_completions_on_input: true,
723 show_call_status_icon: true,
724 vim_mode: false,
725 autosave: Autosave::Off,
726 default_dock_anchor: DockAnchor::Bottom,
727 editor_defaults: EditorSettings {
728 tab_size: Some(4.try_into().unwrap()),
729 hard_tabs: Some(false),
730 soft_wrap: Some(SoftWrap::None),
731 preferred_line_length: Some(80),
732 remove_trailing_whitespace_on_save: Some(true),
733 ensure_final_newline_on_save: Some(true),
734 format_on_save: Some(FormatOnSave::On),
735 formatter: Some(Formatter::LanguageServer),
736 enable_language_server: Some(true),
737 copilot: Some(OnOff::On),
738 },
739 editor_overrides: Default::default(),
740 journal_defaults: Default::default(),
741 journal_overrides: Default::default(),
742 terminal_defaults: Default::default(),
743 terminal_overrides: Default::default(),
744 git: Default::default(),
745 git_overrides: Default::default(),
746 language_defaults: Default::default(),
747 language_overrides: Default::default(),
748 lsp: Default::default(),
749 theme: gpui::fonts::with_font_cache(cx.font_cache().clone(), Default::default),
750 telemetry_defaults: TelemetrySettings {
751 diagnostics: Some(true),
752 metrics: Some(true),
753 },
754 telemetry_overrides: Default::default(),
755 auto_update: true,
756 base_keymap: Default::default(),
757 enable_copilot_integration: true,
758 }
759 }
760
761 #[cfg(any(test, feature = "test-support"))]
762 pub fn test_async(cx: &mut gpui::TestAppContext) {
763 cx.update(|cx| {
764 let settings = Self::test(cx);
765 cx.set_global(settings);
766 });
767 }
768}
769
770pub fn settings_file_json_schema(
771 theme_names: Vec<String>,
772 language_names: &[String],
773) -> serde_json::Value {
774 let settings = SchemaSettings::draft07().with(|settings| {
775 settings.option_add_null_type = false;
776 });
777 let generator = SchemaGenerator::new(settings);
778 let mut root_schema = generator.into_root_schema_for::<SettingsFileContent>();
779
780 // Create a schema for a theme name.
781 let theme_name_schema = SchemaObject {
782 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
783 enum_values: Some(theme_names.into_iter().map(Value::String).collect()),
784 ..Default::default()
785 };
786
787 // Create a schema for a 'languages overrides' object, associating editor
788 // settings with specific langauges.
789 assert!(root_schema.definitions.contains_key("EditorSettings"));
790 let languages_object_schema = SchemaObject {
791 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Object))),
792 object: Some(Box::new(ObjectValidation {
793 properties: language_names
794 .iter()
795 .map(|name| {
796 (
797 name.clone(),
798 Schema::new_ref("#/definitions/EditorSettings".into()),
799 )
800 })
801 .collect(),
802 ..Default::default()
803 })),
804 ..Default::default()
805 };
806
807 // Add these new schemas as definitions, and modify properties of the root
808 // schema to reference them.
809 root_schema.definitions.extend([
810 ("ThemeName".into(), theme_name_schema.into()),
811 ("Languages".into(), languages_object_schema.into()),
812 ]);
813 let root_schema_object = &mut root_schema.schema.object.as_mut().unwrap();
814
815 root_schema_object.properties.extend([
816 (
817 "theme".to_owned(),
818 Schema::new_ref("#/definitions/ThemeName".into()),
819 ),
820 (
821 "languages".to_owned(),
822 Schema::new_ref("#/definitions/Languages".into()),
823 ),
824 // For backward compatibility
825 (
826 "language_overrides".to_owned(),
827 Schema::new_ref("#/definitions/Languages".into()),
828 ),
829 ]);
830
831 serde_json::to_value(root_schema).unwrap()
832}
833
834fn merge<T: Copy>(target: &mut T, value: Option<T>) {
835 if let Some(value) = value {
836 *target = value;
837 }
838}
839
840pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
841 Ok(serde_json::from_reader(
842 json_comments::CommentSettings::c_style().strip_comments(content.as_bytes()),
843 )?)
844}
845
846fn write_settings_key(settings_content: &mut String, key_path: &[&str], new_value: &Value) {
847 let mut parser = tree_sitter::Parser::new();
848 parser.set_language(tree_sitter_json::language()).unwrap();
849 let tree = parser.parse(&settings_content, None).unwrap();
850
851 let mut cursor = tree_sitter::QueryCursor::new();
852
853 let query = Query::new(
854 tree_sitter_json::language(),
855 "
856 (pair
857 key: (string) @key
858 value: (_) @value)
859 ",
860 )
861 .unwrap();
862
863 let mut depth = 0;
864 let mut first_key_start = None;
865 let mut existing_value_range = 0..settings_content.len();
866 let matches = cursor.matches(&query, tree.root_node(), settings_content.as_bytes());
867 for mat in matches {
868 if mat.captures.len() != 2 {
869 continue;
870 }
871
872 let key_range = mat.captures[0].node.byte_range();
873 let value_range = mat.captures[1].node.byte_range();
874
875 if key_range.start > existing_value_range.end {
876 break;
877 }
878
879 first_key_start.get_or_insert_with(|| key_range.start);
880
881 let found_key = settings_content
882 .get(key_range.clone())
883 .map(|key_text| key_text == format!("\"{}\"", key_path[depth]))
884 .unwrap_or(false);
885
886 if found_key {
887 existing_value_range = value_range;
888 depth += 1;
889
890 if depth == key_path.len() {
891 break;
892 } else {
893 first_key_start = None;
894 }
895 }
896 }
897
898 // We found the exact key we want, insert the new value
899 if depth == key_path.len() {
900 let new_val = serde_json::to_string_pretty(new_value)
901 .expect("Could not serialize new json field to string");
902 settings_content.replace_range(existing_value_range, &new_val);
903 } else {
904 // We have key paths, construct the sub objects
905 let new_key = key_path[depth];
906
907 // We don't have the key, construct the nested objects
908 let mut new_value = serde_json::to_value(new_value).unwrap();
909 for key in key_path[(depth + 1)..].iter().rev() {
910 new_value = serde_json::json!({ key.to_string(): new_value });
911 }
912
913 if let Some(first_key_start) = first_key_start {
914 let mut row = 0;
915 let mut column = 0;
916 for (ix, char) in settings_content.char_indices() {
917 if ix == first_key_start {
918 break;
919 }
920 if char == '\n' {
921 row += 1;
922 column = 0;
923 } else {
924 column += char.len_utf8();
925 }
926 }
927
928 if row > 0 {
929 let new_val = to_pretty_json(&new_value, column, column);
930 let content = format!(r#""{new_key}": {new_val},"#);
931 settings_content.insert_str(first_key_start, &content);
932
933 settings_content.insert_str(
934 first_key_start + content.len(),
935 &format!("\n{:width$}", ' ', width = column),
936 )
937 } else {
938 let new_val = serde_json::to_string(&new_value).unwrap();
939 let mut content = format!(r#""{new_key}": {new_val},"#);
940 content.push(' ');
941 settings_content.insert_str(first_key_start, &content);
942 }
943 } else {
944 dbg!("here???");
945 new_value = serde_json::json!({ new_key.to_string(): new_value });
946 let indent_prefix_len = 4 * depth;
947 let new_val = to_pretty_json(&new_value, 4, indent_prefix_len);
948
949 settings_content.replace_range(existing_value_range, &new_val);
950 if depth == 0 {
951 settings_content.push('\n');
952 }
953 }
954 }
955}
956
957fn to_pretty_json(
958 value: &serde_json::Value,
959 indent_size: usize,
960 indent_prefix_len: usize,
961) -> String {
962 const SPACES: [u8; 32] = [b' '; 32];
963
964 debug_assert!(indent_size <= SPACES.len());
965 debug_assert!(indent_prefix_len <= SPACES.len());
966
967 let mut output = Vec::new();
968 let mut ser = serde_json::Serializer::with_formatter(
969 &mut output,
970 serde_json::ser::PrettyFormatter::with_indent(&SPACES[0..indent_size.min(SPACES.len())]),
971 );
972
973 value.serialize(&mut ser).unwrap();
974 let text = String::from_utf8(output).unwrap();
975
976 let mut adjusted_text = String::new();
977 for (i, line) in text.split('\n').enumerate() {
978 if i > 0 {
979 adjusted_text.push_str(str::from_utf8(&SPACES[0..indent_prefix_len]).unwrap());
980 }
981 adjusted_text.push_str(line);
982 adjusted_text.push('\n');
983 }
984 adjusted_text.pop();
985 adjusted_text
986}
987
988pub fn update_settings_file(
989 mut text: String,
990 mut old_file_content: SettingsFileContent,
991 update: impl FnOnce(&mut SettingsFileContent),
992) -> String {
993 let mut new_file_content = old_file_content.clone();
994
995 update(&mut new_file_content);
996
997 if new_file_content.languages.len() != old_file_content.languages.len() {
998 for language in new_file_content.languages.keys() {
999 old_file_content
1000 .languages
1001 .entry(language.clone())
1002 .or_default();
1003 }
1004 for language in old_file_content.languages.keys() {
1005 new_file_content
1006 .languages
1007 .entry(language.clone())
1008 .or_default();
1009 }
1010 }
1011
1012 let old_object = to_json_object(old_file_content);
1013 let new_object = to_json_object(new_file_content);
1014
1015 fn apply_changes_to_json_text(
1016 old_object: &serde_json::Map<String, Value>,
1017 new_object: &serde_json::Map<String, Value>,
1018 current_key_path: Vec<&str>,
1019 json_text: &mut String,
1020 ) {
1021 for (key, old_value) in old_object.iter() {
1022 // We know that these two are from the same shape of object, so we can just unwrap
1023 let new_value = new_object.get(key).unwrap();
1024
1025 if old_value != new_value {
1026 match new_value {
1027 Value::Bool(_) | Value::Number(_) | Value::String(_) => {
1028 let mut key_path = current_key_path.clone();
1029 key_path.push(key);
1030 write_settings_key(json_text, &key_path, &new_value);
1031 }
1032 Value::Object(new_sub_object) => {
1033 let mut key_path = current_key_path.clone();
1034 key_path.push(key);
1035 if let Value::Object(old_sub_object) = old_value {
1036 apply_changes_to_json_text(
1037 old_sub_object,
1038 new_sub_object,
1039 key_path,
1040 json_text,
1041 );
1042 } else {
1043 unimplemented!("This function doesn't support changing values from simple values to objects yet");
1044 }
1045 }
1046 Value::Null | Value::Array(_) => {
1047 unimplemented!("We only support objects and simple values");
1048 }
1049 }
1050 }
1051 }
1052 }
1053
1054 apply_changes_to_json_text(&old_object, &new_object, vec![], &mut text);
1055
1056 text
1057}
1058
1059fn to_json_object(settings_file: SettingsFileContent) -> serde_json::Map<String, Value> {
1060 let tmp = serde_json::to_value(settings_file).unwrap();
1061 match tmp {
1062 Value::Object(map) => map,
1063 _ => unreachable!("SettingsFileContent represents a JSON map"),
1064 }
1065}
1066
1067#[cfg(test)]
1068mod tests {
1069 use super::*;
1070 use unindent::Unindent;
1071
1072 fn assert_new_settings<S1: Into<String>, S2: Into<String>>(
1073 old_json: S1,
1074 update: fn(&mut SettingsFileContent),
1075 expected_new_json: S2,
1076 ) {
1077 let old_json = old_json.into();
1078 let old_content: SettingsFileContent = serde_json::from_str(&old_json).unwrap_or_default();
1079 let new_json = update_settings_file(old_json, old_content, update);
1080 pretty_assertions::assert_eq!(new_json, expected_new_json.into());
1081 }
1082
1083 #[test]
1084 fn test_update_copilot() {
1085 assert_new_settings(
1086 r#"
1087 {
1088 "languages": {
1089 "JSON": {
1090 "copilot": "off"
1091 }
1092 }
1093 }
1094 "#
1095 .unindent(),
1096 |settings| {
1097 settings.editor.copilot = Some(OnOff::On);
1098 },
1099 r#"
1100 {
1101 "copilot": "on",
1102 "languages": {
1103 "JSON": {
1104 "copilot": "off"
1105 }
1106 }
1107 }
1108 "#
1109 .unindent(),
1110 );
1111 }
1112
1113 #[test]
1114 fn test_update_langauge_copilot() {
1115 assert_new_settings(
1116 r#"
1117 {
1118 "languages": {
1119 "JSON": {
1120 "copilot": "off"
1121 }
1122 }
1123 }
1124 "#
1125 .unindent(),
1126 |settings| {
1127 settings.languages.insert(
1128 "Rust".into(),
1129 EditorSettings {
1130 copilot: Some(OnOff::On),
1131 ..Default::default()
1132 },
1133 );
1134 },
1135 r#"
1136 {
1137 "languages": {
1138 "Rust": {
1139 "copilot": "on"
1140 },
1141 "JSON": {
1142 "copilot": "off"
1143 }
1144 }
1145 }
1146 "#
1147 .unindent(),
1148 );
1149 }
1150
1151 #[test]
1152 fn test_update_telemetry_setting_multiple_fields() {
1153 assert_new_settings(
1154 r#"
1155 {
1156 "telemetry": {
1157 "metrics": false,
1158 "diagnostics": false
1159 }
1160 }
1161 "#
1162 .unindent(),
1163 |settings| {
1164 settings.telemetry.set_diagnostics(true);
1165 settings.telemetry.set_metrics(true);
1166 },
1167 r#"
1168 {
1169 "telemetry": {
1170 "metrics": true,
1171 "diagnostics": true
1172 }
1173 }
1174 "#
1175 .unindent(),
1176 );
1177 }
1178
1179 #[test]
1180 fn test_update_telemetry_setting_weird_formatting() {
1181 assert_new_settings(
1182 r#"{
1183 "telemetry": { "metrics": false, "diagnostics": true }
1184 }"#
1185 .unindent(),
1186 |settings| settings.telemetry.set_diagnostics(false),
1187 r#"{
1188 "telemetry": { "metrics": false, "diagnostics": false }
1189 }"#
1190 .unindent(),
1191 );
1192 }
1193
1194 #[test]
1195 fn test_update_telemetry_setting_other_fields() {
1196 assert_new_settings(
1197 r#"
1198 {
1199 "telemetry": {
1200 "metrics": false,
1201 "diagnostics": true
1202 }
1203 }
1204 "#
1205 .unindent(),
1206 |settings| settings.telemetry.set_diagnostics(false),
1207 r#"
1208 {
1209 "telemetry": {
1210 "metrics": false,
1211 "diagnostics": false
1212 }
1213 }
1214 "#
1215 .unindent(),
1216 );
1217 }
1218
1219 #[test]
1220 fn test_update_telemetry_setting_empty_telemetry() {
1221 assert_new_settings(
1222 r#"
1223 {
1224 "telemetry": {}
1225 }
1226 "#
1227 .unindent(),
1228 |settings| settings.telemetry.set_diagnostics(false),
1229 r#"
1230 {
1231 "telemetry": {
1232 "diagnostics": false
1233 }
1234 }
1235 "#
1236 .unindent(),
1237 );
1238 }
1239
1240 #[test]
1241 fn test_update_telemetry_setting_pre_existing() {
1242 assert_new_settings(
1243 r#"
1244 {
1245 "telemetry": {
1246 "diagnostics": true
1247 }
1248 }
1249 "#
1250 .unindent(),
1251 |settings| settings.telemetry.set_diagnostics(false),
1252 r#"
1253 {
1254 "telemetry": {
1255 "diagnostics": false
1256 }
1257 }
1258 "#
1259 .unindent(),
1260 );
1261 }
1262
1263 #[test]
1264 fn test_update_telemetry_setting() {
1265 assert_new_settings(
1266 "{}",
1267 |settings| settings.telemetry.set_diagnostics(true),
1268 r#"
1269 {
1270 "telemetry": {
1271 "diagnostics": true
1272 }
1273 }
1274 "#
1275 .unindent(),
1276 );
1277 }
1278
1279 #[test]
1280 fn test_update_object_empty_doc() {
1281 assert_new_settings(
1282 "",
1283 |settings| settings.telemetry.set_diagnostics(true),
1284 r#"
1285 {
1286 "telemetry": {
1287 "diagnostics": true
1288 }
1289 }
1290 "#
1291 .unindent(),
1292 );
1293 }
1294
1295 #[test]
1296 fn test_write_theme_into_settings_with_theme() {
1297 assert_new_settings(
1298 r#"
1299 {
1300 "theme": "One Dark"
1301 }
1302 "#
1303 .unindent(),
1304 |settings| settings.theme = Some("summerfruit-light".to_string()),
1305 r#"
1306 {
1307 "theme": "summerfruit-light"
1308 }
1309 "#
1310 .unindent(),
1311 );
1312 }
1313
1314 #[test]
1315 fn test_write_theme_into_empty_settings() {
1316 assert_new_settings(
1317 r#"
1318 {
1319 }
1320 "#
1321 .unindent(),
1322 |settings| settings.theme = Some("summerfruit-light".to_string()),
1323 r#"
1324 {
1325 "theme": "summerfruit-light"
1326 }
1327 "#
1328 .unindent(),
1329 );
1330 }
1331
1332 #[test]
1333 fn write_key_no_document() {
1334 assert_new_settings(
1335 "",
1336 |settings| settings.theme = Some("summerfruit-light".to_string()),
1337 r#"
1338 {
1339 "theme": "summerfruit-light"
1340 }
1341 "#
1342 .unindent(),
1343 );
1344 }
1345
1346 #[test]
1347 fn test_write_theme_into_single_line_settings_without_theme() {
1348 assert_new_settings(
1349 r#"{ "a": "", "ok": true }"#,
1350 |settings| settings.theme = Some("summerfruit-light".to_string()),
1351 r#"{ "theme": "summerfruit-light", "a": "", "ok": true }"#,
1352 );
1353 }
1354
1355 #[test]
1356 fn test_write_theme_pre_object_whitespace() {
1357 assert_new_settings(
1358 r#" { "a": "", "ok": true }"#,
1359 |settings| settings.theme = Some("summerfruit-light".to_string()),
1360 r#" { "theme": "summerfruit-light", "a": "", "ok": true }"#.unindent(),
1361 );
1362 }
1363
1364 #[test]
1365 fn test_write_theme_into_multi_line_settings_without_theme() {
1366 assert_new_settings(
1367 r#"
1368 {
1369 "a": "b"
1370 }
1371 "#
1372 .unindent(),
1373 |settings| settings.theme = Some("summerfruit-light".to_string()),
1374 r#"
1375 {
1376 "theme": "summerfruit-light",
1377 "a": "b"
1378 }
1379 "#
1380 .unindent(),
1381 );
1382 }
1383}