settings.rs

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