1mod keymap_file;
2
3use anyhow::Result;
4use gpui::{
5 font_cache::{FamilyId, FontCache},
6 AssetSource,
7};
8use schemars::{
9 gen::{SchemaGenerator, SchemaSettings},
10 schema::{InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec},
11 JsonSchema,
12};
13use serde::{de::DeserializeOwned, Deserialize};
14use serde_json::Value;
15use std::{collections::HashMap, num::NonZeroU32, str, sync::Arc};
16use theme::{Theme, ThemeRegistry};
17use util::ResultExt as _;
18
19pub use keymap_file::{keymap_file_json_schema, KeymapFileContent};
20
21#[derive(Clone)]
22pub struct Settings {
23 pub experiments: FeatureFlags,
24 pub projects_online_by_default: bool,
25 pub buffer_font_family: FamilyId,
26 pub default_buffer_font_size: f32,
27 pub buffer_font_size: f32,
28 pub hover_popover_enabled: bool,
29 pub show_completions_on_input: bool,
30 pub vim_mode: bool,
31 pub autosave: Autosave,
32 pub default_dock_anchor: DockAnchor,
33 pub editor_defaults: EditorSettings,
34 pub editor_overrides: EditorSettings,
35 pub journal_defaults: JournalSettings,
36 pub journal_overrides: JournalSettings,
37 pub terminal_defaults: TerminalSettings,
38 pub terminal_overrides: TerminalSettings,
39 pub language_defaults: HashMap<Arc<str>, EditorSettings>,
40 pub language_overrides: HashMap<Arc<str>, EditorSettings>,
41 pub lsp: HashMap<Arc<str>, LspSettings>,
42 pub theme: Arc<Theme>,
43 pub staff_mode: bool,
44}
45
46#[derive(Copy, Clone, Debug, Default, Deserialize, JsonSchema)]
47pub struct FeatureFlags {
48 pub experimental_themes: bool,
49}
50
51impl FeatureFlags {
52 pub fn keymap_files(&self) -> Vec<&'static str> {
53 vec![]
54 }
55}
56
57#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
58pub struct EditorSettings {
59 pub tab_size: Option<NonZeroU32>,
60 pub hard_tabs: Option<bool>,
61 pub soft_wrap: Option<SoftWrap>,
62 pub preferred_line_length: Option<u32>,
63 pub format_on_save: Option<FormatOnSave>,
64 pub formatter: Option<Formatter>,
65 pub enable_language_server: Option<bool>,
66}
67
68#[derive(Copy, Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
69#[serde(rename_all = "snake_case")]
70pub enum SoftWrap {
71 None,
72 EditorWidth,
73 PreferredLineLength,
74}
75#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
76#[serde(rename_all = "snake_case")]
77pub enum FormatOnSave {
78 On,
79 Off,
80 LanguageServer,
81 External {
82 command: String,
83 arguments: Vec<String>,
84 },
85}
86
87#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
88#[serde(rename_all = "snake_case")]
89pub enum Formatter {
90 LanguageServer,
91 External {
92 command: String,
93 arguments: Vec<String>,
94 },
95}
96
97#[derive(Copy, Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
98#[serde(rename_all = "snake_case")]
99pub enum Autosave {
100 Off,
101 AfterDelay { milliseconds: u64 },
102 OnFocusChange,
103 OnWindowChange,
104}
105
106#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
107pub struct JournalSettings {
108 pub journal_directory: Option<JournalDirectory>,
109 pub hour_format: Option<HourFormat>,
110}
111
112#[derive(Clone, Debug, Deserialize, JsonSchema)]
113#[serde(rename_all = "snake_case")]
114pub enum JournalDirectory {
115 AlwaysHome,
116 Always { directory: String },
117}
118
119#[derive(Clone, Debug, Deserialize, JsonSchema)]
120#[serde(rename_all = "snake_case")]
121pub enum HourFormat {
122 Hour12,
123 Hour24,
124}
125
126#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
127pub struct TerminalSettings {
128 pub shell: Option<Shell>,
129 pub working_directory: Option<WorkingDirectory>,
130 pub font_size: Option<f32>,
131 pub font_family: Option<String>,
132 pub env: Option<HashMap<String, String>>,
133 pub blinking: Option<TerminalBlink>,
134 pub alternate_scroll: Option<AlternateScroll>,
135 pub option_as_meta: Option<bool>,
136}
137
138#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
139#[serde(rename_all = "snake_case")]
140pub enum TerminalBlink {
141 Off,
142 TerminalControlled,
143 On,
144}
145
146impl Default for TerminalBlink {
147 fn default() -> Self {
148 TerminalBlink::TerminalControlled
149 }
150}
151
152#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
153#[serde(rename_all = "snake_case")]
154pub enum Shell {
155 System,
156 Program(String),
157 WithArguments { program: String, args: Vec<String> },
158}
159
160impl Default for Shell {
161 fn default() -> Self {
162 Shell::System
163 }
164}
165
166#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
167#[serde(rename_all = "snake_case")]
168pub enum AlternateScroll {
169 On,
170 Off,
171}
172
173impl Default for AlternateScroll {
174 fn default() -> Self {
175 AlternateScroll::On
176 }
177}
178
179#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
180#[serde(rename_all = "snake_case")]
181pub enum WorkingDirectory {
182 CurrentProjectDirectory,
183 FirstProjectDirectory,
184 AlwaysHome,
185 Always { directory: String },
186}
187
188#[derive(PartialEq, Eq, Debug, Default, Copy, Clone, Hash, Deserialize, JsonSchema)]
189#[serde(rename_all = "snake_case")]
190pub enum DockAnchor {
191 #[default]
192 Bottom,
193 Right,
194 Expanded,
195}
196
197#[derive(Clone, Debug, Default, Deserialize, JsonSchema)]
198pub struct SettingsFileContent {
199 pub experiments: Option<FeatureFlags>,
200 #[serde(default)]
201 pub projects_online_by_default: Option<bool>,
202 #[serde(default)]
203 pub buffer_font_family: Option<String>,
204 #[serde(default)]
205 pub buffer_font_size: Option<f32>,
206 #[serde(default)]
207 pub hover_popover_enabled: Option<bool>,
208 #[serde(default)]
209 pub show_completions_on_input: Option<bool>,
210 #[serde(default)]
211 pub vim_mode: Option<bool>,
212 #[serde(default)]
213 pub autosave: Option<Autosave>,
214 #[serde(default)]
215 pub default_dock_anchor: Option<DockAnchor>,
216 #[serde(flatten)]
217 pub editor: EditorSettings,
218 #[serde(default)]
219 pub journal: JournalSettings,
220 #[serde(default)]
221 pub terminal: TerminalSettings,
222 #[serde(default)]
223 #[serde(alias = "language_overrides")]
224 pub languages: HashMap<Arc<str>, EditorSettings>,
225 #[serde(default)]
226 pub lsp: HashMap<Arc<str>, LspSettings>,
227 #[serde(default)]
228 pub theme: Option<String>,
229 #[serde(default)]
230 pub staff_mode: Option<bool>,
231}
232
233#[derive(Clone, Debug, Deserialize, PartialEq, Eq, JsonSchema)]
234#[serde(rename_all = "snake_case")]
235pub struct LspSettings {
236 pub initialization_options: Option<Value>,
237}
238
239impl Settings {
240 pub fn defaults(
241 assets: impl AssetSource,
242 font_cache: &FontCache,
243 themes: &ThemeRegistry,
244 ) -> Self {
245 #[track_caller]
246 fn required<T>(value: Option<T>) -> Option<T> {
247 assert!(value.is_some(), "missing default setting value");
248 value
249 }
250
251 let defaults: SettingsFileContent = parse_json_with_comments(
252 str::from_utf8(assets.load("settings/default.json").unwrap().as_ref()).unwrap(),
253 )
254 .unwrap();
255
256 Self {
257 experiments: FeatureFlags::default(),
258 buffer_font_family: font_cache
259 .load_family(&[defaults.buffer_font_family.as_ref().unwrap()])
260 .unwrap(),
261 buffer_font_size: defaults.buffer_font_size.unwrap(),
262 default_buffer_font_size: defaults.buffer_font_size.unwrap(),
263 hover_popover_enabled: defaults.hover_popover_enabled.unwrap(),
264 show_completions_on_input: defaults.show_completions_on_input.unwrap(),
265 projects_online_by_default: defaults.projects_online_by_default.unwrap(),
266 vim_mode: defaults.vim_mode.unwrap(),
267 autosave: defaults.autosave.unwrap(),
268 default_dock_anchor: defaults.default_dock_anchor.unwrap(),
269 editor_defaults: EditorSettings {
270 tab_size: required(defaults.editor.tab_size),
271 hard_tabs: required(defaults.editor.hard_tabs),
272 soft_wrap: required(defaults.editor.soft_wrap),
273 preferred_line_length: required(defaults.editor.preferred_line_length),
274 format_on_save: required(defaults.editor.format_on_save),
275 formatter: required(defaults.editor.formatter),
276 enable_language_server: required(defaults.editor.enable_language_server),
277 },
278 editor_overrides: Default::default(),
279 journal_defaults: Default::default(),
280 journal_overrides: Default::default(),
281 terminal_defaults: Default::default(),
282 terminal_overrides: Default::default(),
283 language_defaults: defaults.languages,
284 language_overrides: Default::default(),
285 lsp: defaults.lsp.clone(),
286 theme: themes.get(&defaults.theme.unwrap()).unwrap(),
287
288 staff_mode: false,
289 }
290 }
291
292 pub fn set_user_settings(
293 &mut self,
294 data: SettingsFileContent,
295 theme_registry: &ThemeRegistry,
296 font_cache: &FontCache,
297 ) {
298 if let Some(value) = &data.buffer_font_family {
299 if let Some(id) = font_cache.load_family(&[value]).log_err() {
300 self.buffer_font_family = id;
301 }
302 }
303 if let Some(value) = &data.theme {
304 if let Some(theme) = theme_registry.get(value).log_err() {
305 self.theme = theme;
306 }
307 }
308
309 merge(
310 &mut self.projects_online_by_default,
311 data.projects_online_by_default,
312 );
313 merge(&mut self.buffer_font_size, data.buffer_font_size);
314 merge(&mut self.default_buffer_font_size, data.buffer_font_size);
315 merge(&mut self.hover_popover_enabled, data.hover_popover_enabled);
316 merge(
317 &mut self.show_completions_on_input,
318 data.show_completions_on_input,
319 );
320 merge(&mut self.vim_mode, data.vim_mode);
321 merge(&mut self.autosave, data.autosave);
322 merge(&mut self.experiments, data.experiments);
323 merge(&mut self.staff_mode, data.staff_mode);
324 merge(&mut self.default_dock_anchor, data.default_dock_anchor);
325
326 // Ensure terminal font is loaded, so we can request it in terminal_element layout
327 if let Some(terminal_font) = &data.terminal.font_family {
328 font_cache.load_family(&[terminal_font]).log_err();
329 }
330
331 self.editor_overrides = data.editor;
332 self.journal_overrides = data.journal;
333 self.terminal_defaults.font_size = data.terminal.font_size;
334 self.terminal_overrides = data.terminal;
335 self.language_overrides = data.languages;
336 self.lsp = data.lsp;
337 }
338
339 pub fn with_language_defaults(
340 mut self,
341 language_name: impl Into<Arc<str>>,
342 overrides: EditorSettings,
343 ) -> Self {
344 self.language_defaults
345 .insert(language_name.into(), overrides);
346 self
347 }
348
349 pub fn tab_size(&self, language: Option<&str>) -> NonZeroU32 {
350 self.language_setting(language, |settings| settings.tab_size)
351 }
352
353 pub fn hard_tabs(&self, language: Option<&str>) -> bool {
354 self.language_setting(language, |settings| settings.hard_tabs)
355 }
356
357 pub fn soft_wrap(&self, language: Option<&str>) -> SoftWrap {
358 self.language_setting(language, |settings| settings.soft_wrap)
359 }
360
361 pub fn preferred_line_length(&self, language: Option<&str>) -> u32 {
362 self.language_setting(language, |settings| settings.preferred_line_length)
363 }
364
365 pub fn format_on_save(&self, language: Option<&str>) -> FormatOnSave {
366 self.language_setting(language, |settings| settings.format_on_save.clone())
367 }
368
369 pub fn formatter(&self, language: Option<&str>) -> Formatter {
370 self.language_setting(language, |settings| settings.formatter.clone())
371 }
372
373 pub fn enable_language_server(&self, language: Option<&str>) -> bool {
374 self.language_setting(language, |settings| settings.enable_language_server)
375 }
376
377 fn language_setting<F, R>(&self, language: Option<&str>, f: F) -> R
378 where
379 F: Fn(&EditorSettings) -> Option<R>,
380 {
381 None.or_else(|| language.and_then(|l| self.language_overrides.get(l).and_then(&f)))
382 .or_else(|| f(&self.editor_overrides))
383 .or_else(|| language.and_then(|l| self.language_defaults.get(l).and_then(&f)))
384 .or_else(|| f(&self.editor_defaults))
385 .expect("missing default")
386 }
387
388 #[cfg(any(test, feature = "test-support"))]
389 pub fn test(cx: &gpui::AppContext) -> Settings {
390 Settings {
391 experiments: FeatureFlags::default(),
392 buffer_font_family: cx.font_cache().load_family(&["Monaco"]).unwrap(),
393 buffer_font_size: 14.,
394 default_buffer_font_size: 14.,
395 hover_popover_enabled: true,
396 show_completions_on_input: true,
397 vim_mode: false,
398 autosave: Autosave::Off,
399 default_dock_anchor: DockAnchor::Bottom,
400 editor_defaults: EditorSettings {
401 tab_size: Some(4.try_into().unwrap()),
402 hard_tabs: Some(false),
403 soft_wrap: Some(SoftWrap::None),
404 preferred_line_length: Some(80),
405 format_on_save: Some(FormatOnSave::On),
406 formatter: Some(Formatter::LanguageServer),
407 enable_language_server: Some(true),
408 },
409 editor_overrides: Default::default(),
410 journal_defaults: Default::default(),
411 journal_overrides: Default::default(),
412 terminal_defaults: Default::default(),
413 terminal_overrides: Default::default(),
414 language_defaults: Default::default(),
415 language_overrides: Default::default(),
416 lsp: Default::default(),
417 projects_online_by_default: true,
418 theme: gpui::fonts::with_font_cache(cx.font_cache().clone(), Default::default),
419 staff_mode: false,
420 }
421 }
422
423 #[cfg(any(test, feature = "test-support"))]
424 pub fn test_async(cx: &mut gpui::TestAppContext) {
425 cx.update(|cx| {
426 let settings = Self::test(cx);
427 cx.set_global(settings);
428 });
429 }
430}
431
432pub fn settings_file_json_schema(
433 theme_names: Vec<String>,
434 language_names: &[String],
435) -> serde_json::Value {
436 let settings = SchemaSettings::draft07().with(|settings| {
437 settings.option_add_null_type = false;
438 });
439 let generator = SchemaGenerator::new(settings);
440 let mut root_schema = generator.into_root_schema_for::<SettingsFileContent>();
441
442 // Create a schema for a theme name.
443 let theme_name_schema = SchemaObject {
444 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::String))),
445 enum_values: Some(theme_names.into_iter().map(Value::String).collect()),
446 ..Default::default()
447 };
448
449 // Create a schema for a 'languages overrides' object, associating editor
450 // settings with specific langauges.
451 assert!(root_schema.definitions.contains_key("EditorSettings"));
452 let languages_object_schema = SchemaObject {
453 instance_type: Some(SingleOrVec::Single(Box::new(InstanceType::Object))),
454 object: Some(Box::new(ObjectValidation {
455 properties: language_names
456 .iter()
457 .map(|name| {
458 (
459 name.clone(),
460 Schema::new_ref("#/definitions/EditorSettings".into()),
461 )
462 })
463 .collect(),
464 ..Default::default()
465 })),
466 ..Default::default()
467 };
468
469 // Add these new schemas as definitions, and modify properties of the root
470 // schema to reference them.
471 root_schema.definitions.extend([
472 ("ThemeName".into(), theme_name_schema.into()),
473 ("Languages".into(), languages_object_schema.into()),
474 ]);
475 let root_schema_object = &mut root_schema.schema.object.as_mut().unwrap();
476
477 // Avoid automcomplete for non-user facing settings
478 root_schema_object.properties.remove("staff_mode");
479 root_schema_object.properties.extend([
480 (
481 "theme".to_owned(),
482 Schema::new_ref("#/definitions/ThemeName".into()),
483 ),
484 (
485 "languages".to_owned(),
486 Schema::new_ref("#/definitions/Languages".into()),
487 ),
488 // For backward compatibility
489 (
490 "language_overrides".to_owned(),
491 Schema::new_ref("#/definitions/Languages".into()),
492 ),
493 ]);
494
495 serde_json::to_value(root_schema).unwrap()
496}
497
498fn merge<T: Copy>(target: &mut T, value: Option<T>) {
499 if let Some(value) = value {
500 *target = value;
501 }
502}
503
504pub fn parse_json_with_comments<T: DeserializeOwned>(content: &str) -> Result<T> {
505 Ok(serde_json::from_reader(
506 json_comments::CommentSettings::c_style().strip_comments(content.as_bytes()),
507 )?)
508}