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