1mod keymap_file;
2pub mod settings_file;
3pub mod watched_json;
4
5use anyhow::{bail, Result};
6use gpui::{
7 font_cache::{FamilyId, FontCache},
8 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},
19 statement::Statement,
20};
21use std::{collections::HashMap, fmt::Write as _, 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};
27
28#[derive(Clone)]
29pub struct Settings {
30 pub experiments: FeatureFlags,
31 pub buffer_font_family: FamilyId,
32 pub default_buffer_font_size: f32,
33 pub buffer_font_size: f32,
34 pub active_pane_magnification: f32,
35 pub cursor_blink: bool,
36 pub confirm_quit: bool,
37 pub hover_popover_enabled: bool,
38 pub show_completions_on_input: bool,
39 pub vim_mode: bool,
40 pub autosave: Autosave,
41 pub default_dock_anchor: DockAnchor,
42 pub editor_defaults: EditorSettings,
43 pub editor_overrides: EditorSettings,
44 pub git: GitSettings,
45 pub git_overrides: GitSettings,
46 pub journal_defaults: JournalSettings,
47 pub journal_overrides: JournalSettings,
48 pub terminal_defaults: TerminalSettings,
49 pub terminal_overrides: TerminalSettings,
50 pub language_defaults: HashMap<Arc<str>, EditorSettings>,
51 pub language_overrides: HashMap<Arc<str>, EditorSettings>,
52 pub lsp: HashMap<Arc<str>, LspSettings>,
53 pub theme: Arc<Theme>,
54 pub telemetry_defaults: TelemetrySettings,
55 pub telemetry_overrides: TelemetrySettings,
56 pub staff_mode: bool,
57}
58
59#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
60pub struct TelemetrySettings {
61 diagnostics: Option<bool>,
62 metrics: Option<bool>,
63}
64
65impl TelemetrySettings {
66 pub fn metrics(&self) -> bool {
67 self.metrics.unwrap()
68 }
69 pub fn diagnostics(&self) -> bool {
70 self.diagnostics.unwrap()
71 }
72}
73
74#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
75pub struct FeatureFlags {
76 pub experimental_themes: bool,
77}
78
79impl FeatureFlags {
80 pub fn keymap_files(&self) -> Vec<&'static str> {
81 vec![]
82 }
83}
84
85#[derive(Copy, Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
86pub struct GitSettings {
87 pub git_gutter: Option<GitGutter>,
88 pub gutter_debounce: Option<u64>,
89}
90
91#[derive(Clone, Copy, Debug, Default, Serialize, Deserialize, JsonSchema)]
92#[serde(rename_all = "snake_case")]
93pub enum GitGutter {
94 #[default]
95 TrackedFiles,
96 Hide,
97}
98
99pub struct GitGutterConfig {}
100
101#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
102pub struct EditorSettings {
103 pub tab_size: Option<NonZeroU32>,
104 pub hard_tabs: Option<bool>,
105 pub soft_wrap: Option<SoftWrap>,
106 pub preferred_line_length: Option<u32>,
107 pub format_on_save: Option<FormatOnSave>,
108 pub formatter: Option<Formatter>,
109 pub enable_language_server: Option<bool>,
110}
111
112#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
113#[serde(rename_all = "snake_case")]
114pub enum SoftWrap {
115 None,
116 EditorWidth,
117 PreferredLineLength,
118}
119#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
120#[serde(rename_all = "snake_case")]
121pub enum FormatOnSave {
122 On,
123 Off,
124 LanguageServer,
125 External {
126 command: String,
127 arguments: Vec<String>,
128 },
129}
130
131#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
132#[serde(rename_all = "snake_case")]
133pub enum Formatter {
134 LanguageServer,
135 External {
136 command: String,
137 arguments: Vec<String>,
138 },
139}
140
141#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
142#[serde(rename_all = "snake_case")]
143pub enum Autosave {
144 Off,
145 AfterDelay { milliseconds: u64 },
146 OnFocusChange,
147 OnWindowChange,
148}
149
150#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
151pub struct JournalSettings {
152 pub path: Option<String>,
153 pub hour_format: Option<HourFormat>,
154}
155
156impl Default for JournalSettings {
157 fn default() -> Self {
158 Self {
159 path: Some("~".into()),
160 hour_format: Some(Default::default()),
161 }
162 }
163}
164
165#[derive(Clone, Debug, Serialize, Deserialize, JsonSchema)]
166#[serde(rename_all = "snake_case")]
167pub enum HourFormat {
168 Hour12,
169 Hour24,
170}
171
172impl Default for HourFormat {
173 fn default() -> Self {
174 Self::Hour12
175 }
176}
177
178#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
179pub struct TerminalSettings {
180 pub shell: Option<Shell>,
181 pub working_directory: Option<WorkingDirectory>,
182 pub font_size: Option<f32>,
183 pub font_family: Option<String>,
184 pub env: Option<HashMap<String, String>>,
185 pub blinking: Option<TerminalBlink>,
186 pub alternate_scroll: Option<AlternateScroll>,
187 pub option_as_meta: Option<bool>,
188 pub copy_on_select: Option<bool>,
189}
190
191#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
192#[serde(rename_all = "snake_case")]
193pub enum TerminalBlink {
194 Off,
195 TerminalControlled,
196 On,
197}
198
199impl Default for TerminalBlink {
200 fn default() -> Self {
201 TerminalBlink::TerminalControlled
202 }
203}
204
205#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
206#[serde(rename_all = "snake_case")]
207pub enum Shell {
208 System,
209 Program(String),
210 WithArguments { program: String, args: Vec<String> },
211}
212
213impl Default for Shell {
214 fn default() -> Self {
215 Shell::System
216 }
217}
218
219#[derive(Clone, Copy, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
220#[serde(rename_all = "snake_case")]
221pub enum AlternateScroll {
222 On,
223 Off,
224}
225
226impl Default for AlternateScroll {
227 fn default() -> Self {
228 AlternateScroll::On
229 }
230}
231
232#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
233#[serde(rename_all = "snake_case")]
234pub enum WorkingDirectory {
235 CurrentProjectDirectory,
236 FirstProjectDirectory,
237 AlwaysHome,
238 Always { directory: String },
239}
240
241impl Default for WorkingDirectory {
242 fn default() -> Self {
243 Self::CurrentProjectDirectory
244 }
245}
246
247#[derive(PartialEq, Eq, Debug, Default, Copy, Clone, Hash, Serialize, Deserialize, JsonSchema)]
248#[serde(rename_all = "snake_case")]
249pub enum DockAnchor {
250 #[default]
251 Bottom,
252 Right,
253 Expanded,
254}
255
256impl Bind for DockAnchor {
257 fn bind(&self, statement: &Statement, start_index: i32) -> anyhow::Result<i32> {
258 match self {
259 DockAnchor::Bottom => "Bottom",
260 DockAnchor::Right => "Right",
261 DockAnchor::Expanded => "Expanded",
262 }
263 .bind(statement, start_index)
264 }
265}
266
267impl Column for DockAnchor {
268 fn column(statement: &mut Statement, start_index: i32) -> anyhow::Result<(Self, i32)> {
269 String::column(statement, start_index).and_then(|(anchor_text, next_index)| {
270 Ok((
271 match anchor_text.as_ref() {
272 "Bottom" => DockAnchor::Bottom,
273 "Right" => DockAnchor::Right,
274 "Expanded" => DockAnchor::Expanded,
275 _ => bail!("Stored dock anchor is incorrect"),
276 },
277 next_index,
278 ))
279 })
280 }
281}
282
283#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema)]
284pub struct SettingsFileContent {
285 pub experiments: Option<FeatureFlags>,
286 #[serde(default)]
287 pub projects_online_by_default: Option<bool>,
288 #[serde(default)]
289 pub buffer_font_family: Option<String>,
290 #[serde(default)]
291 pub buffer_font_size: Option<f32>,
292 #[serde(default)]
293 pub active_pane_magnification: Option<f32>,
294 #[serde(default)]
295 pub cursor_blink: Option<bool>,
296 #[serde(default)]
297 pub confirm_quit: Option<bool>,
298 #[serde(default)]
299 pub hover_popover_enabled: Option<bool>,
300 #[serde(default)]
301 pub show_completions_on_input: Option<bool>,
302 #[serde(default)]
303 pub vim_mode: Option<bool>,
304 #[serde(default)]
305 pub autosave: Option<Autosave>,
306 #[serde(default)]
307 pub default_dock_anchor: Option<DockAnchor>,
308 #[serde(flatten)]
309 pub editor: EditorSettings,
310 #[serde(default)]
311 pub journal: JournalSettings,
312 #[serde(default)]
313 pub terminal: TerminalSettings,
314 #[serde(default)]
315 pub git: Option<GitSettings>,
316 #[serde(default)]
317 #[serde(alias = "language_overrides")]
318 pub languages: HashMap<Arc<str>, EditorSettings>,
319 #[serde(default)]
320 pub lsp: HashMap<Arc<str>, LspSettings>,
321 #[serde(default)]
322 pub theme: Option<String>,
323 #[serde(default)]
324 pub telemetry: TelemetrySettings,
325 #[serde(default)]
326 pub staff_mode: Option<bool>,
327}
328
329#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
330#[serde(rename_all = "snake_case")]
331pub struct LspSettings {
332 pub initialization_options: Option<Value>,
333}
334
335impl Settings {
336 /// Fill out the settings corresponding to the default.json file, overrides will be set later
337 pub fn defaults(
338 assets: impl AssetSource,
339 font_cache: &FontCache,
340 themes: &ThemeRegistry,
341 ) -> Self {
342 #[track_caller]
343 fn required<T>(value: Option<T>) -> Option<T> {
344 assert!(value.is_some(), "missing default setting value");
345 value
346 }
347
348 let defaults: SettingsFileContent = parse_json_with_comments(
349 str::from_utf8(assets.load("settings/default.json").unwrap().as_ref()).unwrap(),
350 )
351 .unwrap();
352
353 Self {
354 experiments: FeatureFlags::default(),
355 buffer_font_family: font_cache
356 .load_family(&[defaults.buffer_font_family.as_ref().unwrap()])
357 .unwrap(),
358 buffer_font_size: defaults.buffer_font_size.unwrap(),
359 active_pane_magnification: defaults.active_pane_magnification.unwrap(),
360 default_buffer_font_size: defaults.buffer_font_size.unwrap(),
361 confirm_quit: defaults.confirm_quit.unwrap(),
362 cursor_blink: defaults.cursor_blink.unwrap(),
363 hover_popover_enabled: defaults.hover_popover_enabled.unwrap(),
364 show_completions_on_input: defaults.show_completions_on_input.unwrap(),
365 vim_mode: defaults.vim_mode.unwrap(),
366 autosave: defaults.autosave.unwrap(),
367 default_dock_anchor: defaults.default_dock_anchor.unwrap(),
368 editor_defaults: EditorSettings {
369 tab_size: required(defaults.editor.tab_size),
370 hard_tabs: required(defaults.editor.hard_tabs),
371 soft_wrap: required(defaults.editor.soft_wrap),
372 preferred_line_length: required(defaults.editor.preferred_line_length),
373 format_on_save: required(defaults.editor.format_on_save),
374 formatter: required(defaults.editor.formatter),
375 enable_language_server: required(defaults.editor.enable_language_server),
376 },
377 editor_overrides: Default::default(),
378 git: defaults.git.unwrap(),
379 git_overrides: Default::default(),
380 journal_defaults: defaults.journal,
381 journal_overrides: Default::default(),
382 terminal_defaults: defaults.terminal,
383 terminal_overrides: Default::default(),
384 language_defaults: defaults.languages,
385 language_overrides: Default::default(),
386 lsp: defaults.lsp.clone(),
387 theme: themes.get(&defaults.theme.unwrap()).unwrap(),
388 telemetry_defaults: defaults.telemetry,
389 telemetry_overrides: Default::default(),
390 staff_mode: false,
391 }
392 }
393
394 // Fill out the overrride and etc. settings from the user's settings.json
395 pub fn set_user_settings(
396 &mut self,
397 data: SettingsFileContent,
398 theme_registry: &ThemeRegistry,
399 font_cache: &FontCache,
400 ) {
401 if let Some(value) = &data.buffer_font_family {
402 if let Some(id) = font_cache.load_family(&[value]).log_err() {
403 self.buffer_font_family = id;
404 }
405 }
406 if let Some(value) = &data.theme {
407 if let Some(theme) = theme_registry.get(value).log_err() {
408 self.theme = theme;
409 }
410 }
411
412 merge(&mut self.buffer_font_size, data.buffer_font_size);
413 merge(
414 &mut self.active_pane_magnification,
415 data.active_pane_magnification,
416 );
417 merge(&mut self.default_buffer_font_size, data.buffer_font_size);
418 merge(&mut self.cursor_blink, data.cursor_blink);
419 merge(&mut self.confirm_quit, data.confirm_quit);
420 merge(&mut self.hover_popover_enabled, data.hover_popover_enabled);
421 merge(
422 &mut self.show_completions_on_input,
423 data.show_completions_on_input,
424 );
425 merge(&mut self.vim_mode, data.vim_mode);
426 merge(&mut self.autosave, data.autosave);
427 merge(&mut self.experiments, data.experiments);
428 merge(&mut self.staff_mode, data.staff_mode);
429 merge(&mut self.default_dock_anchor, data.default_dock_anchor);
430
431 // Ensure terminal font is loaded, so we can request it in terminal_element layout
432 if let Some(terminal_font) = &data.terminal.font_family {
433 font_cache.load_family(&[terminal_font]).log_err();
434 }
435
436 self.editor_overrides = data.editor;
437 self.git_overrides = data.git.unwrap_or_default();
438 self.journal_overrides = data.journal;
439 self.terminal_defaults.font_size = data.terminal.font_size;
440 self.terminal_overrides.copy_on_select = data.terminal.copy_on_select;
441 self.terminal_overrides = data.terminal;
442 self.language_overrides = data.languages;
443 self.telemetry_overrides = data.telemetry;
444 self.lsp = data.lsp;
445 }
446
447 pub fn with_language_defaults(
448 mut self,
449 language_name: impl Into<Arc<str>>,
450 overrides: EditorSettings,
451 ) -> Self {
452 self.language_defaults
453 .insert(language_name.into(), overrides);
454 self
455 }
456
457 pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 {
458 self.language_setting(language, |settings| settings.tab_size)
459 }
460
461 pub fn hard_tabs(&self, language: Option<&str>) -> bool {
462 self.language_setting(language, |settings| settings.hard_tabs)
463 }
464
465 pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap {
466 self.language_setting(language, |settings| settings.soft_wrap)
467 }
468
469 pub fn preferred_line_length(&self, language: Option<&str>) -> u32 {
470 self.language_setting(language, |settings| settings.preferred_line_length)
471 }
472
473 pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave {
474 self.language_setting(language, |settings| settings.format_on_save.clone())
475 }
476
477 pub fn formatter(&self, language: Option<&str>) -> Formatter {
478 self.language_setting(language, |settings| settings.formatter.clone())
479 }
480
481 pub fn enable_language_server(&self, language: Option<&str>) -> bool {
482 self.language_setting(language, |settings| settings.enable_language_server)
483 }
484
485 fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> R
486 where
487 F: Fn(&EditorSettings) -> Option<R>,
488 {
489 None.or_else(|| language.and_then(|l| self.language_overrides.get(l).and_then(&f)))
490 .or_else(|| f(&self.editor_overrides))
491 .or_else(|| language.and_then(|l| self.language_defaults.get(l).and_then(&f)))
492 .or_else(|| f(&self.editor_defaults))
493 .expect("missing default")
494 }
495
496 pub fn git_gutter(&self) -> GitGutter {
497 self.git_overrides.git_gutter.unwrap_or_else(|| {
498 self.git
499 .git_gutter
500 .expect("git_gutter should be some by setting setup")
501 })
502 }
503
504 fn terminal_setting<F, R: Default + Clone>(&self, f: F) -> R
505 where
506 F: Fn(&TerminalSettings) -> Option<&R>,
507 {
508 f(&self.terminal_overrides)
509 .or_else(|| f(&self.terminal_defaults))
510 .cloned()
511 .unwrap_or_else(|| R::default())
512 }
513
514 pub fn telemetry(&self) -> TelemetrySettings {
515 TelemetrySettings {
516 diagnostics: Some(self.telemetry_diagnostics()),
517 metrics: Some(self.telemetry_metrics()),
518 }
519 }
520
521 pub fn telemetry_diagnostics(&self) -> bool {
522 self.telemetry_overrides
523 .diagnostics
524 .or(self.telemetry_defaults.diagnostics)
525 .expect("missing default")
526 }
527
528 pub fn telemetry_metrics(&self) -> bool {
529 self.telemetry_overrides
530 .metrics
531 .or(self.telemetry_defaults.metrics)
532 .expect("missing default")
533 }
534
535 pub fn terminal_scroll(&self) -> AlternateScroll {
536 self.terminal_setting(|terminal_setting| terminal_setting.alternate_scroll.as_ref())
537 }
538
539 pub fn terminal_shell(&self) -> Shell {
540 self.terminal_setting(|terminal_setting| terminal_setting.shell.as_ref())
541 }
542
543 pub fn terminal_env(&self) -> HashMap<String, String> {
544 self.terminal_setting(|terminal_setting| terminal_setting.env.as_ref())
545 }
546
547 pub fn terminal_strategy(&self) -> WorkingDirectory {
548 self.terminal_setting(|terminal_setting| terminal_setting.working_directory.as_ref())
549 }
550
551 #[cfg(any(test, feature = "test-support"))]
552 pub fn test(cx: &gpui::AppContext) -> Settings {
553 Settings {
554 experiments: FeatureFlags::default(),
555 buffer_font_family: cx.font_cache().load_family(&["Monaco"]).unwrap(),
556 buffer_font_size: 14.,
557 active_pane_magnification: 1.,
558 default_buffer_font_size: 14.,
559 confirm_quit: false,
560 cursor_blink: true,
561 hover_popover_enabled: true,
562 show_completions_on_input: true,
563 vim_mode: false,
564 autosave: Autosave::Off,
565 default_dock_anchor: DockAnchor::Bottom,
566 editor_defaults: EditorSettings {
567 tab_size: Some(4.try_into().unwrap()),
568 hard_tabs: Some(false),
569 soft_wrap: Some(SoftWrap::None),
570 preferred_line_length: Some(80),
571 format_on_save: Some(FormatOnSave::On),
572 formatter: Some(Formatter::LanguageServer),
573 enable_language_server: Some(true),
574 },
575 editor_overrides: Default::default(),
576 journal_defaults: Default::default(),
577 journal_overrides: Default::default(),
578 terminal_defaults: Default::default(),
579 terminal_overrides: Default::default(),
580 git: Default::default(),
581 git_overrides: Default::default(),
582 language_defaults: Default::default(),
583 language_overrides: Default::default(),
584 lsp: Default::default(),
585 theme: gpui::fonts::with_font_cache(cx.font_cache().clone(), Default::default),
586 telemetry_defaults: TelemetrySettings {
587 diagnostics: Some(true),
588 metrics: Some(true),
589 },
590 telemetry_overrides: Default::default(),
591 staff_mode: false,
592 }
593 }
594
595 #[cfg(any(test, feature = "test-support"))]
596 pub fn test_async(cx: &mut gpui::TestAppContext) {
597 cx.update(|cx| {
598 let settings = Self::test(cx);
599 cx.set_global(settings);
600 });
601 }
602}
603
604pub fn settings_file_json_schema(
605 theme_names: Vec<String>,
606 language_names: &[String],
607) -> serde_json::Value {
608 let settings = SchemaSettings::draft07().with(|settings| {
609 settings.option_add_null_type = false;
610 });
611 let generator = SchemaGenerator::new(settings);
612 let mut root_schema = generator.into_root_schema_for::<SettingsFileContent>();
613
614 // Create a schema for a theme name.
615 let theme_name_schema = SchemaObject {
616 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
617 enum_values: Some(theme_names.into_iter().map(Value::String).collect()),
618 ..Default::default()
619 };
620
621 // Create a schema for a 'languages overrides' object, associating editor
622 // settings with specific langauges.
623 assert!(root_schema.definitions.contains_key("EditorSettings"));
624 let languages_object_schema = SchemaObject {
625 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Object))),
626 object: Some(Box::new(ObjectValidation {
627 properties: language_names
628 .iter()
629 .map(|name| {
630 (
631 name.clone(),
632 Schema::new_ref("#/definitions/EditorSettings".into()),
633 )
634 })
635 .collect(),
636 ..Default::default()
637 })),
638 ..Default::default()
639 };
640
641 // Add these new schemas as definitions, and modify properties of the root
642 // schema to reference them.
643 root_schema.definitions.extend([
644 ("ThemeName".into(), theme_name_schema.into()),
645 ("Languages".into(), languages_object_schema.into()),
646 ]);
647 let root_schema_object = &mut root_schema.schema.object.as_mut().unwrap();
648
649 // Avoid automcomplete for non-user facing settings
650 root_schema_object.properties.remove("staff_mode");
651 root_schema_object.properties.extend([
652 (
653 "theme".to_owned(),
654 Schema::new_ref("#/definitions/ThemeName".into()),
655 ),
656 (
657 "languages".to_owned(),
658 Schema::new_ref("#/definitions/Languages".into()),
659 ),
660 // For backward compatibility
661 (
662 "language_overrides".to_owned(),
663 Schema::new_ref("#/definitions/Languages".into()),
664 ),
665 ]);
666
667 serde_json::to_value(root_schema).unwrap()
668}
669
670/// Expects the key to be unquoted, and the value to be valid JSON
671/// (e.g. values should be unquoted for numbers and bools, quoted for strings)
672pub fn write_top_level_setting(
673 mut settings_content: String,
674 top_level_key: &str,
675 new_val: &str,
676) -> String {
677 let mut parser = tree_sitter::Parser::new();
678 parser.set_language(tree_sitter_json::language()).unwrap();
679 let tree = parser.parse(&settings_content, None).unwrap();
680
681 let mut cursor = tree_sitter::QueryCursor::new();
682
683 let query = Query::new(
684 tree_sitter_json::language(),
685 "
686 (document
687 (object
688 (pair
689 key: (string) @key
690 value: (_) @value)))
691 ",
692 )
693 .unwrap();
694
695 let mut first_key_start = None;
696 let mut existing_value_range = None;
697 let matches = cursor.matches(&query, tree.root_node(), settings_content.as_bytes());
698 for mat in matches {
699 if mat.captures.len() != 2 {
700 continue;
701 }
702
703 let key = mat.captures[0];
704 let value = mat.captures[1];
705
706 first_key_start.get_or_insert_with(|| key.node.start_byte());
707
708 if let Some(key_text) = settings_content.get(key.node.byte_range()) {
709 if key_text == format!("\"{top_level_key}\"") {
710 existing_value_range = Some(value.node.byte_range());
711 break;
712 }
713 }
714 }
715
716 match (first_key_start, existing_value_range) {
717 (None, None) => {
718 // No document, create a new object and overwrite
719 settings_content.clear();
720 write!(
721 settings_content,
722 "{{\n \"{}\": {new_val}\n}}\n",
723 top_level_key
724 )
725 .unwrap();
726 }
727
728 (_, Some(existing_value_range)) => {
729 // Existing theme key, overwrite
730 settings_content.replace_range(existing_value_range, &new_val);
731 }
732
733 (Some(first_key_start), None) => {
734 // No existing theme key, but other settings. Prepend new theme settings and
735 // match style of first key
736 let mut row = 0;
737 let mut column = 0;
738 for (ix, char) in settings_content.char_indices() {
739 if ix == first_key_start {
740 break;
741 }
742 if char == '\n' {
743 row += 1;
744 column = 0;
745 } else {
746 column += char.len_utf8();
747 }
748 }
749
750 let content = format!(r#""{top_level_key}": {new_val},"#);
751 settings_content.insert_str(first_key_start, &content);
752
753 if row > 0 {
754 settings_content.insert_str(
755 first_key_start + content.len(),
756 &format!("\n{:width$}", ' ', width = column),
757 )
758 } else {
759 settings_content.insert_str(first_key_start + content.len(), " ")
760 }
761 }
762 }
763
764 settings_content
765}
766
767fn merge<T: Copy>(target: &mut T, value: Option<T>) {
768 if let Some(value) = value {
769 *target = value;
770 }
771}
772
773pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
774 Ok(serde_json::from_reader(
775 json_comments::CommentSettings::c_style().strip_comments(content.as_bytes()),
776 )?)
777}
778
779#[cfg(test)]
780mod tests {
781 use crate::write_top_level_setting;
782 use unindent::Unindent;
783
784 #[test]
785 fn test_write_theme_into_settings_with_theme() {
786 let settings = r#"
787 {
788 "theme": "One Dark"
789 }
790 "#
791 .unindent();
792
793 let new_settings = r#"
794 {
795 "theme": "summerfruit-light"
796 }
797 "#
798 .unindent();
799
800 let settings_after_theme =
801 write_top_level_setting(settings, "theme", "\"summerfruit-light\"");
802
803 assert_eq!(settings_after_theme, new_settings)
804 }
805
806 #[test]
807 fn test_write_theme_into_empty_settings() {
808 let settings = r#"
809 {
810 }
811 "#
812 .unindent();
813
814 let new_settings = r#"
815 {
816 "theme": "summerfruit-light"
817 }
818 "#
819 .unindent();
820
821 let settings_after_theme =
822 write_top_level_setting(settings, "theme", "\"summerfruit-light\"");
823
824 assert_eq!(settings_after_theme, new_settings)
825 }
826
827 #[test]
828 fn test_write_theme_into_no_settings() {
829 let settings = "".to_string();
830
831 let new_settings = r#"
832 {
833 "theme": "summerfruit-light"
834 }
835 "#
836 .unindent();
837
838 let settings_after_theme =
839 write_top_level_setting(settings, "theme", "\"summerfruit-light\"");
840
841 assert_eq!(settings_after_theme, new_settings)
842 }
843
844 #[test]
845 fn test_write_theme_into_single_line_settings_without_theme() {
846 let settings = r#"{ "a": "", "ok": true }"#.to_string();
847 let new_settings = r#"{ "theme": "summerfruit-light", "a": "", "ok": true }"#;
848
849 let settings_after_theme =
850 write_top_level_setting(settings, "theme", "\"summerfruit-light\"");
851
852 assert_eq!(settings_after_theme, new_settings)
853 }
854
855 #[test]
856 fn test_write_theme_pre_object_whitespace() {
857 let settings = r#" { "a": "", "ok": true }"#.to_string();
858 let new_settings = r#" { "theme": "summerfruit-light", "a": "", "ok": true }"#;
859
860 let settings_after_theme =
861 write_top_level_setting(settings, "theme", "\"summerfruit-light\"");
862
863 assert_eq!(settings_after_theme, new_settings)
864 }
865
866 #[test]
867 fn test_write_theme_into_multi_line_settings_without_theme() {
868 let settings = r#"
869 {
870 "a": "b"
871 }
872 "#
873 .unindent();
874
875 let new_settings = r#"
876 {
877 "theme": "summerfruit-light",
878 "a": "b"
879 }
880 "#
881 .unindent();
882
883 let settings_after_theme =
884 write_top_level_setting(settings, "theme", "\"summerfruit-light\"");
885
886 assert_eq!(settings_after_theme, new_settings)
887 }
888}