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