Move all default settings from source code into the JSON file

This commit is contained in:
Max Brunsfeld 2022-07-12 11:35:19 -07:00
parent e51dc25e1d
commit ec8a493700
7 changed files with 70 additions and 58 deletions

View file

@ -1,11 +1,17 @@
{ {
"theme": "cave-light", "theme": "cave-dark",
"buffer_font_family": "Zed Mono", "buffer_font_family": "Zed Mono",
"buffer_font_size": 15, "buffer_font_size": 15,
"hover_popover_enabled": true, "hover_popover_enabled": true,
"vim_mode": false, "vim_mode": false,
"autosave": "off", "autosave": "off",
"projects_online_by_default": true, "projects_online_by_default": true,
"enable_language_server": true,
"format_on_save": "language_server",
"preferred_line_length": 80,
"soft_wrap": "none",
"hard_tabs": false,
"tab_size": 4,
"languages_overrides": { "languages_overrides": {
"Plain Text": { "Plain Text": {
"soft_wrap": "preferred_line_length" "soft_wrap": "preferred_line_length"

View file

@ -2010,7 +2010,7 @@ async fn test_formatting_buffer(cx_a: &mut TestAppContext, cx_b: &mut TestAppCon
// host's configuration is honored as opposed to using the guest's settings. // host's configuration is honored as opposed to using the guest's settings.
cx_a.update(|cx| { cx_a.update(|cx| {
cx.update_global(|settings: &mut Settings, _| { cx.update_global(|settings: &mut Settings, _| {
settings.language_settings.format_on_save = Some(FormatOnSave::External { settings.editor_defaults.format_on_save = Some(FormatOnSave::External {
command: "awk".to_string(), command: "awk".to_string(),
arguments: vec!["{sub(/two/,\"{buffer_path}\")}1".to_string()], arguments: vec!["{sub(/two/,\"{buffer_path}\")}1".to_string()],
}); });

View file

@ -983,7 +983,7 @@ pub mod tests {
language.set_theme(&theme); language.set_theme(&theme);
cx.update(|cx| { cx.update(|cx| {
let mut settings = Settings::test(cx); let mut settings = Settings::test(cx);
settings.language_settings.tab_size = Some(2.try_into().unwrap()); settings.editor_defaults.tab_size = Some(2.try_into().unwrap());
cx.set_global(settings); cx.set_global(settings);
}); });

View file

@ -7613,7 +7613,7 @@ mod tests {
let mut cx = EditorTestContext::new(cx).await; let mut cx = EditorTestContext::new(cx).await;
cx.update(|cx| { cx.update(|cx| {
cx.update_global::<Settings, _, _>(|settings, _| { cx.update_global::<Settings, _, _>(|settings, _| {
settings.language_settings.hard_tabs = Some(true); settings.editor_overrides.hard_tabs = Some(true);
}); });
}); });

View file

@ -29,7 +29,8 @@ pub struct Settings {
pub hover_popover_enabled: bool, pub hover_popover_enabled: bool,
pub vim_mode: bool, pub vim_mode: bool,
pub autosave: Autosave, pub autosave: Autosave,
pub language_settings: LanguageSettings, pub editor_defaults: LanguageSettings,
pub editor_overrides: LanguageSettings,
pub language_defaults: HashMap<Arc<str>, LanguageSettings>, pub language_defaults: HashMap<Arc<str>, LanguageSettings>,
pub language_overrides: HashMap<Arc<str>, LanguageSettings>, pub language_overrides: HashMap<Arc<str>, LanguageSettings>,
pub theme: Arc<Theme>, pub theme: Arc<Theme>,
@ -86,11 +87,7 @@ pub struct SettingsFileContent {
#[serde(default)] #[serde(default)]
pub vim_mode: Option<bool>, pub vim_mode: Option<bool>,
#[serde(default)] #[serde(default)]
pub format_on_save: Option<FormatOnSave>,
#[serde(default)]
pub autosave: Option<Autosave>, pub autosave: Option<Autosave>,
#[serde(default)]
pub enable_language_server: Option<bool>,
#[serde(flatten)] #[serde(flatten)]
pub editor: LanguageSettings, pub editor: LanguageSettings,
#[serde(default)] #[serde(default)]
@ -105,8 +102,14 @@ impl Settings {
font_cache: &FontCache, font_cache: &FontCache,
themes: &ThemeRegistry, themes: &ThemeRegistry,
) -> Self { ) -> Self {
let defaults = assets.load("default-settings.json").unwrap(); fn required<T>(value: Option<T>) -> Option<T> {
let defaults: SettingsFileContent = serde_json::from_slice(defaults.as_ref()).unwrap(); assert!(value.is_some(), "missing default setting value");
value
}
let defaults: SettingsFileContent =
serde_json::from_slice(assets.load("default-settings.json").unwrap().as_ref()).unwrap();
Self { Self {
buffer_font_family: font_cache buffer_font_family: font_cache
.load_family(&[defaults.buffer_font_family.as_ref().unwrap()]) .load_family(&[defaults.buffer_font_family.as_ref().unwrap()])
@ -117,15 +120,16 @@ impl Settings {
projects_online_by_default: defaults.projects_online_by_default.unwrap(), projects_online_by_default: defaults.projects_online_by_default.unwrap(),
vim_mode: defaults.vim_mode.unwrap(), vim_mode: defaults.vim_mode.unwrap(),
autosave: defaults.autosave.unwrap(), autosave: defaults.autosave.unwrap(),
language_settings: LanguageSettings { editor_defaults: LanguageSettings {
tab_size: defaults.editor.tab_size, tab_size: required(defaults.editor.tab_size),
hard_tabs: defaults.editor.hard_tabs, hard_tabs: required(defaults.editor.hard_tabs),
soft_wrap: defaults.editor.soft_wrap, soft_wrap: required(defaults.editor.soft_wrap),
preferred_line_length: defaults.editor.preferred_line_length, preferred_line_length: required(defaults.editor.preferred_line_length),
format_on_save: defaults.editor.format_on_save, format_on_save: required(defaults.editor.format_on_save),
enable_language_server: defaults.editor.enable_language_server, enable_language_server: required(defaults.editor.enable_language_server),
}, },
language_defaults: defaults.language_overrides, language_defaults: defaults.language_overrides,
editor_overrides: Default::default(),
language_overrides: Default::default(), language_overrides: Default::default(),
theme: themes.get(&defaults.theme.unwrap()).unwrap(), theme: themes.get(&defaults.theme.unwrap()).unwrap(),
} }
@ -143,48 +147,37 @@ impl Settings {
pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 { pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 {
self.language_setting(language, |settings| settings.tab_size) self.language_setting(language, |settings| settings.tab_size)
.unwrap_or(4.try_into().unwrap())
} }
pub fn hard_tabs(&self, language: Option<&str>) -> bool { pub fn hard_tabs(&self, language: Option<&str>) -> bool {
self.language_setting(language, |settings| settings.hard_tabs) self.language_setting(language, |settings| settings.hard_tabs)
.unwrap_or(false)
} }
pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap { pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap {
self.language_setting(language, |settings| settings.soft_wrap) self.language_setting(language, |settings| settings.soft_wrap)
.unwrap_or(SoftWrap::None)
} }
pub fn preferred_line_length(&self, language: Option<&str>) -> u32 { pub fn preferred_line_length(&self, language: Option<&str>) -> u32 {
self.language_setting(language, |settings| settings.preferred_line_length) self.language_setting(language, |settings| settings.preferred_line_length)
.unwrap_or(80)
} }
pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave { pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave {
self.language_setting(language, |settings| settings.format_on_save.clone()) self.language_setting(language, |settings| settings.format_on_save.clone())
.unwrap_or(FormatOnSave::LanguageServer)
} }
pub fn enable_language_server(&self, language: Option<&str>) -> bool { pub fn enable_language_server(&self, language: Option<&str>) -> bool {
self.language_setting(language, |settings| settings.enable_language_server) self.language_setting(language, |settings| settings.enable_language_server)
.unwrap_or(true)
} }
fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> Option<R> fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> R
where where
F: Fn(&LanguageSettings) -> Option<R>, F: Fn(&LanguageSettings) -> Option<R>,
{ {
let mut language_override = None; None.or_else(|| language.and_then(|l| self.language_overrides.get(l).and_then(&f)))
let mut language_default = None; .or_else(|| f(&self.editor_overrides))
if let Some(language) = language { .or_else(|| language.and_then(|l| self.language_defaults.get(l).and_then(&f)))
language_override = self.language_overrides.get(language).and_then(&f); .or_else(|| f(&self.editor_defaults))
language_default = self.language_defaults.get(language).and_then(&f); .expect("missing default")
}
language_override
.or_else(|| f(&self.language_settings))
.or(language_default)
} }
#[cfg(any(test, feature = "test-support"))] #[cfg(any(test, feature = "test-support"))]
@ -196,7 +189,15 @@ impl Settings {
hover_popover_enabled: true, hover_popover_enabled: true,
vim_mode: false, vim_mode: false,
autosave: Autosave::Off, autosave: Autosave::Off,
language_settings: Default::default(), editor_defaults: LanguageSettings {
tab_size: Some(4.try_into().unwrap()),
hard_tabs: Some(false),
soft_wrap: Some(SoftWrap::None),
preferred_line_length: Some(80),
format_on_save: Some(FormatOnSave::LanguageServer),
enable_language_server: Some(true),
},
editor_overrides: Default::default(),
language_defaults: Default::default(), language_defaults: Default::default(),
language_overrides: Default::default(), language_overrides: Default::default(),
projects_online_by_default: true, projects_online_by_default: true,
@ -238,18 +239,19 @@ impl Settings {
merge(&mut self.hover_popover_enabled, data.hover_popover_enabled); merge(&mut self.hover_popover_enabled, data.hover_popover_enabled);
merge(&mut self.vim_mode, data.vim_mode); merge(&mut self.vim_mode, data.vim_mode);
merge(&mut self.autosave, data.autosave); merge(&mut self.autosave, data.autosave);
merge_option( merge_option(
&mut self.language_settings.format_on_save, &mut self.editor_overrides.format_on_save,
data.format_on_save.clone(), data.editor.format_on_save.clone(),
); );
merge_option( merge_option(
&mut self.language_settings.enable_language_server, &mut self.editor_overrides.enable_language_server,
data.enable_language_server, data.editor.enable_language_server,
); );
merge_option(&mut self.language_settings.soft_wrap, data.editor.soft_wrap); merge_option(&mut self.editor_overrides.soft_wrap, data.editor.soft_wrap);
merge_option(&mut self.language_settings.tab_size, data.editor.tab_size); merge_option(&mut self.editor_overrides.tab_size, data.editor.tab_size);
merge_option( merge_option(
&mut self.language_settings.preferred_line_length, &mut self.editor_overrides.preferred_line_length,
data.editor.preferred_line_length, data.editor.preferred_line_length,
); );

View file

@ -12,8 +12,6 @@ use std::{collections::HashMap, sync::Arc};
pub use theme_registry::*; pub use theme_registry::*;
pub const DEFAULT_THEME_NAME: &'static str = "cave-dark";
#[derive(Deserialize, Default)] #[derive(Deserialize, Default)]
pub struct Theme { pub struct Theme {
#[serde(default)] #[serde(default)]

View file

@ -400,7 +400,7 @@ mod tests {
collections::HashSet, collections::HashSet,
path::{Path, PathBuf}, path::{Path, PathBuf},
}; };
use theme::{Theme, ThemeRegistry, DEFAULT_THEME_NAME}; use theme::ThemeRegistry;
use workspace::{ use workspace::{
open_paths, pane, Item, ItemHandle, NewFile, Pane, SplitDirection, WorkspaceHandle, open_paths, pane, Item, ItemHandle, NewFile, Pane, SplitDirection, WorkspaceHandle,
}; };
@ -1530,23 +1530,29 @@ mod tests {
} }
#[gpui::test] #[gpui::test]
fn test_bundled_themes(cx: &mut MutableAppContext) { fn test_bundled_settings_and_themes(cx: &mut MutableAppContext) {
cx.platform()
.fonts()
.add_fonts(&[
Assets
.load("fonts/zed-sans/zed-sans-extended.ttf")
.unwrap()
.to_vec()
.into(),
Assets
.load("fonts/zed-mono/zed-mono-extended.ttf")
.unwrap()
.to_vec()
.into(),
])
.unwrap();
let themes = ThemeRegistry::new(Assets, cx.font_cache().clone()); let themes = ThemeRegistry::new(Assets, cx.font_cache().clone());
let settings = Settings::defaults(Assets, cx.font_cache(), &themes);
lazy_static::lazy_static! {
static ref DEFAULT_THEME: parking_lot::Mutex<Option<Arc<Theme>>> = Default::default();
static ref FONTS: Vec<Arc<Vec<u8>>> = vec![
Assets.load("fonts/zed-sans/zed-sans-extended.ttf").unwrap().to_vec().into(),
Assets.load("fonts/zed-mono/zed-mono-extended.ttf").unwrap().to_vec().into(),
];
}
cx.platform().fonts().add_fonts(&FONTS).unwrap();
let mut has_default_theme = false; let mut has_default_theme = false;
for theme_name in themes.list() { for theme_name in themes.list() {
let theme = themes.get(&theme_name).unwrap(); let theme = themes.get(&theme_name).unwrap();
if theme.name == DEFAULT_THEME_NAME { if theme.name == settings.theme.name {
has_default_theme = true; has_default_theme = true;
} }
assert_eq!(theme.name, theme_name); assert_eq!(theme.name, theme_name);