1//! Provides `language`-related settings.
2
3use crate::{File, Language, LanguageServerName};
4use anyhow::Result;
5use collections::{HashMap, HashSet};
6use globset::GlobMatcher;
7use gpui::AppContext;
8use itertools::{Either, Itertools};
9use schemars::{
10 schema::{InstanceType, ObjectValidation, Schema, SchemaObject},
11 JsonSchema,
12};
13use serde::{Deserialize, Serialize};
14use settings::{Settings, SettingsLocation, SettingsSources};
15use std::{num::NonZeroU32, path::Path, sync::Arc};
16use util::serde::default_true;
17
18impl<'a> Into<SettingsLocation<'a>> for &'a dyn File {
19 fn into(self) -> SettingsLocation<'a> {
20 SettingsLocation {
21 worktree_id: self.worktree_id(),
22 path: self.path().as_ref(),
23 }
24 }
25}
26
27/// Initializes the language settings.
28pub fn init(cx: &mut AppContext) {
29 AllLanguageSettings::register(cx);
30}
31
32/// Returns the settings for the specified language from the provided file.
33pub fn language_settings<'a>(
34 language: Option<&Arc<Language>>,
35 file: Option<&Arc<dyn File>>,
36 cx: &'a AppContext,
37) -> &'a LanguageSettings {
38 let language_name = language.map(|l| l.name());
39 all_language_settings(file, cx).language(language_name.as_deref())
40}
41
42/// Returns the settings for all languages from the provided file.
43pub fn all_language_settings<'a>(
44 file: Option<&Arc<dyn File>>,
45 cx: &'a AppContext,
46) -> &'a AllLanguageSettings {
47 let location = file.map(|f| f.as_ref().into());
48 AllLanguageSettings::get(location, cx)
49}
50
51/// The settings for all languages.
52#[derive(Debug, Clone)]
53pub struct AllLanguageSettings {
54 /// The inline completion settings.
55 pub inline_completions: InlineCompletionSettings,
56 defaults: LanguageSettings,
57 languages: HashMap<Arc<str>, LanguageSettings>,
58 pub(crate) file_types: HashMap<Arc<str>, Vec<String>>,
59}
60
61/// The settings for a particular language.
62#[derive(Debug, Clone, Deserialize)]
63pub struct LanguageSettings {
64 /// How many columns a tab should occupy.
65 pub tab_size: NonZeroU32,
66 /// Whether to indent lines using tab characters, as opposed to multiple
67 /// spaces.
68 pub hard_tabs: bool,
69 /// How to soft-wrap long lines of text.
70 pub soft_wrap: SoftWrap,
71 /// The column at which to soft-wrap lines, for buffers where soft-wrap
72 /// is enabled.
73 pub preferred_line_length: u32,
74 /// Whether to show wrap guides in the editor. Setting this to true will
75 /// show a guide at the 'preferred_line_length' value if softwrap is set to
76 /// 'preferred_line_length', and will show any additional guides as specified
77 /// by the 'wrap_guides' setting.
78 pub show_wrap_guides: bool,
79 /// Character counts at which to show wrap guides in the editor.
80 pub wrap_guides: Vec<usize>,
81 /// Whether or not to perform a buffer format before saving.
82 pub format_on_save: FormatOnSave,
83 /// Whether or not to remove any trailing whitespace from lines of a buffer
84 /// before saving it.
85 pub remove_trailing_whitespace_on_save: bool,
86 /// Whether or not to ensure there's a single newline at the end of a buffer
87 /// when saving it.
88 pub ensure_final_newline_on_save: bool,
89 /// How to perform a buffer format.
90 pub formatter: Formatter,
91 /// Zed's Prettier integration settings.
92 /// If Prettier is enabled, Zed will use this for its Prettier instance for any applicable file, if
93 /// the project has no other Prettier installed.
94 pub prettier: HashMap<String, serde_json::Value>,
95 /// Whether to use language servers to provide code intelligence.
96 pub enable_language_server: bool,
97 /// The list of language servers to use (or disable) for this language.
98 ///
99 /// This array should consist of language server IDs, as well as the following
100 /// special tokens:
101 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
102 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
103 pub language_servers: Vec<Arc<str>>,
104 /// Controls whether inline completions are shown immediately (true)
105 /// or manually by triggering `editor::ShowInlineCompletion` (false).
106 pub show_inline_completions: bool,
107 /// Whether to show tabs and spaces in the editor.
108 pub show_whitespaces: ShowWhitespaceSetting,
109 /// Whether to start a new line with a comment when a previous line is a comment as well.
110 pub extend_comment_on_newline: bool,
111 /// Inlay hint related settings.
112 pub inlay_hints: InlayHintSettings,
113 /// Whether to automatically close brackets.
114 pub use_autoclose: bool,
115 // Controls how the editor handles the autoclosed characters.
116 pub always_treat_brackets_as_autoclosed: bool,
117 /// Which code actions to run on save
118 pub code_actions_on_format: HashMap<String, bool>,
119}
120
121impl LanguageSettings {
122 /// A token representing the rest of the available language servers.
123 const REST_OF_LANGUAGE_SERVERS: &'static str = "...";
124
125 /// Returns the customized list of language servers from the list of
126 /// available language servers.
127 pub fn customized_language_servers(
128 &self,
129 available_language_servers: &[LanguageServerName],
130 ) -> Vec<LanguageServerName> {
131 Self::resolve_language_servers(&self.language_servers, available_language_servers)
132 }
133
134 pub(crate) fn resolve_language_servers(
135 configured_language_servers: &[Arc<str>],
136 available_language_servers: &[LanguageServerName],
137 ) -> Vec<LanguageServerName> {
138 let (disabled_language_servers, enabled_language_servers): (Vec<Arc<str>>, Vec<Arc<str>>) =
139 configured_language_servers.iter().partition_map(
140 |language_server| match language_server.strip_prefix('!') {
141 Some(disabled) => Either::Left(disabled.into()),
142 None => Either::Right(language_server.clone()),
143 },
144 );
145
146 let rest = available_language_servers
147 .into_iter()
148 .filter(|&available_language_server| {
149 !disabled_language_servers.contains(&&available_language_server.0)
150 && !enabled_language_servers.contains(&&available_language_server.0)
151 })
152 .cloned()
153 .collect::<Vec<_>>();
154
155 enabled_language_servers
156 .into_iter()
157 .flat_map(|language_server| {
158 if language_server.as_ref() == Self::REST_OF_LANGUAGE_SERVERS {
159 rest.clone()
160 } else {
161 vec![LanguageServerName(language_server.clone())]
162 }
163 })
164 .collect::<Vec<_>>()
165 }
166}
167
168/// The provider that supplies inline completions.
169#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
170#[serde(rename_all = "snake_case")]
171pub enum InlineCompletionProvider {
172 None,
173 #[default]
174 Copilot,
175 Supermaven,
176}
177
178/// The settings for inline completions, such as [GitHub Copilot](https://github.com/features/copilot)
179/// or [Supermaven](https://supermaven.com).
180#[derive(Clone, Debug, Default)]
181pub struct InlineCompletionSettings {
182 /// The provider that supplies inline completions.
183 pub provider: InlineCompletionProvider,
184 /// A list of globs representing files that inline completions should be disabled for.
185 pub disabled_globs: Vec<GlobMatcher>,
186}
187
188/// The settings for all languages.
189#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
190pub struct AllLanguageSettingsContent {
191 /// The settings for enabling/disabling features.
192 #[serde(default)]
193 pub features: Option<FeaturesContent>,
194 /// The inline completion settings.
195 #[serde(default, alias = "copilot")]
196 pub inline_completions: Option<InlineCompletionSettingsContent>,
197 /// The default language settings.
198 #[serde(flatten)]
199 pub defaults: LanguageSettingsContent,
200 /// The settings for individual languages.
201 #[serde(default, alias = "language_overrides")]
202 pub languages: HashMap<Arc<str>, LanguageSettingsContent>,
203 /// Settings for associating file extensions and filenames
204 /// with languages.
205 #[serde(default)]
206 pub file_types: HashMap<Arc<str>, Vec<String>>,
207}
208
209/// The settings for a particular language.
210#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
211pub struct LanguageSettingsContent {
212 /// How many columns a tab should occupy.
213 ///
214 /// Default: 4
215 #[serde(default)]
216 pub tab_size: Option<NonZeroU32>,
217 /// Whether to indent lines using tab characters, as opposed to multiple
218 /// spaces.
219 ///
220 /// Default: false
221 #[serde(default)]
222 pub hard_tabs: Option<bool>,
223 /// How to soft-wrap long lines of text.
224 ///
225 /// Default: none
226 #[serde(default)]
227 pub soft_wrap: Option<SoftWrap>,
228 /// The column at which to soft-wrap lines, for buffers where soft-wrap
229 /// is enabled.
230 ///
231 /// Default: 80
232 #[serde(default)]
233 pub preferred_line_length: Option<u32>,
234 /// Whether to show wrap guides in the editor. Setting this to true will
235 /// show a guide at the 'preferred_line_length' value if softwrap is set to
236 /// 'preferred_line_length', and will show any additional guides as specified
237 /// by the 'wrap_guides' setting.
238 ///
239 /// Default: true
240 #[serde(default)]
241 pub show_wrap_guides: Option<bool>,
242 /// Character counts at which to show wrap guides in the editor.
243 ///
244 /// Default: []
245 #[serde(default)]
246 pub wrap_guides: Option<Vec<usize>>,
247 /// Whether or not to perform a buffer format before saving.
248 ///
249 /// Default: on
250 #[serde(default)]
251 pub format_on_save: Option<FormatOnSave>,
252 /// Whether or not to remove any trailing whitespace from lines of a buffer
253 /// before saving it.
254 ///
255 /// Default: true
256 #[serde(default)]
257 pub remove_trailing_whitespace_on_save: Option<bool>,
258 /// Whether or not to ensure there's a single newline at the end of a buffer
259 /// when saving it.
260 ///
261 /// Default: true
262 #[serde(default)]
263 pub ensure_final_newline_on_save: Option<bool>,
264 /// How to perform a buffer format.
265 ///
266 /// Default: auto
267 #[serde(default)]
268 pub formatter: Option<Formatter>,
269 /// Zed's Prettier integration settings.
270 /// If Prettier is enabled, Zed will use this for its Prettier instance for any applicable file, if
271 /// the project has no other Prettier installed.
272 ///
273 /// Default: {}
274 #[serde(default)]
275 pub prettier: Option<HashMap<String, serde_json::Value>>,
276 /// Whether to use language servers to provide code intelligence.
277 ///
278 /// Default: true
279 #[serde(default)]
280 pub enable_language_server: Option<bool>,
281 /// The list of language servers to use (or disable) for this language.
282 ///
283 /// This array should consist of language server IDs, as well as the following
284 /// special tokens:
285 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
286 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
287 ///
288 /// Default: ["..."]
289 #[serde(default)]
290 pub language_servers: Option<Vec<Arc<str>>>,
291 /// Controls whether inline completions are shown immediately (true)
292 /// or manually by triggering `editor::ShowInlineCompletion` (false).
293 ///
294 /// Default: true
295 #[serde(default, alias = "show_copilot_suggestions")]
296 pub show_inline_completions: Option<bool>,
297 /// Whether to show tabs and spaces in the editor.
298 #[serde(default)]
299 pub show_whitespaces: Option<ShowWhitespaceSetting>,
300 /// Whether to start a new line with a comment when a previous line is a comment as well.
301 ///
302 /// Default: true
303 #[serde(default)]
304 pub extend_comment_on_newline: Option<bool>,
305 /// Inlay hint related settings.
306 #[serde(default)]
307 pub inlay_hints: Option<InlayHintSettings>,
308 /// Whether to automatically type closing characters for you. For example,
309 /// when you type (, Zed will automatically add a closing ) at the correct position.
310 ///
311 /// Default: true
312 pub use_autoclose: Option<bool>,
313 // Controls how the editor handles the autoclosed characters.
314 // When set to `false`(default), skipping over and auto-removing of the closing characters
315 // happen only for auto-inserted characters.
316 // Otherwise(when `true`), the closing characters are always skipped over and auto-removed
317 // no matter how they were inserted.
318 ///
319 /// Default: false
320 pub always_treat_brackets_as_autoclosed: Option<bool>,
321 /// Which code actions to run on save after the formatter.
322 /// These are not run if formatting is off.
323 ///
324 /// Default: {} (or {"source.organizeImports": true} for Go).
325 pub code_actions_on_format: Option<HashMap<String, bool>>,
326}
327
328/// The contents of the inline completion settings.
329#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
330pub struct InlineCompletionSettingsContent {
331 /// A list of globs representing files that inline completions should be disabled for.
332 #[serde(default)]
333 pub disabled_globs: Option<Vec<String>>,
334}
335
336/// The settings for enabling/disabling features.
337#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema)]
338#[serde(rename_all = "snake_case")]
339pub struct FeaturesContent {
340 /// Whether the GitHub Copilot feature is enabled.
341 pub copilot: Option<bool>,
342 /// Determines which inline completion provider to use.
343 pub inline_completion_provider: Option<InlineCompletionProvider>,
344}
345
346/// Controls the soft-wrapping behavior in the editor.
347#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
348#[serde(rename_all = "snake_case")]
349pub enum SoftWrap {
350 /// Do not soft wrap.
351 None,
352 /// Prefer a single line generally, unless an overly long line is encountered.
353 PreferLine,
354 /// Soft wrap lines that overflow the editor
355 EditorWidth,
356 /// Soft wrap lines at the preferred line length
357 PreferredLineLength,
358}
359
360/// Controls the behavior of formatting files when they are saved.
361#[derive(Debug, Clone, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
362#[serde(rename_all = "snake_case")]
363pub enum FormatOnSave {
364 /// Files should be formatted on save.
365 On,
366 /// Files should not be formatted on save.
367 Off,
368 /// Files should be formatted using the current language server.
369 LanguageServer,
370 /// The external program to use to format the files on save.
371 External {
372 /// The external program to run.
373 command: Arc<str>,
374 /// The arguments to pass to the program.
375 arguments: Arc<[String]>,
376 },
377 /// Files should be formatted using code actions executed by language servers.
378 CodeActions(HashMap<String, bool>),
379}
380
381/// Controls how whitespace should be displayedin the editor.
382#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
383#[serde(rename_all = "snake_case")]
384pub enum ShowWhitespaceSetting {
385 /// Draw whitespace only for the selected text.
386 Selection,
387 /// Do not draw any tabs or spaces.
388 None,
389 /// Draw all invisible symbols.
390 All,
391}
392
393/// Controls which formatter should be used when formatting code.
394#[derive(Clone, Debug, Default, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
395#[serde(rename_all = "snake_case")]
396pub enum Formatter {
397 /// Format files using Zed's Prettier integration (if applicable),
398 /// or falling back to formatting via language server.
399 #[default]
400 Auto,
401 /// Format code using the current language server.
402 LanguageServer,
403 /// Format code using Zed's Prettier integration.
404 Prettier,
405 /// Format code using an external command.
406 External {
407 /// The external program to run.
408 command: Arc<str>,
409 /// The arguments to pass to the program.
410 arguments: Arc<[String]>,
411 },
412 /// Files should be formatted using code actions executed by language servers.
413 CodeActions(HashMap<String, bool>),
414}
415
416/// The settings for inlay hints.
417#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
418pub struct InlayHintSettings {
419 /// Global switch to toggle hints on and off.
420 ///
421 /// Default: false
422 #[serde(default)]
423 pub enabled: bool,
424 /// Whether type hints should be shown.
425 ///
426 /// Default: true
427 #[serde(default = "default_true")]
428 pub show_type_hints: bool,
429 /// Whether parameter hints should be shown.
430 ///
431 /// Default: true
432 #[serde(default = "default_true")]
433 pub show_parameter_hints: bool,
434 /// Whether other hints should be shown.
435 ///
436 /// Default: true
437 #[serde(default = "default_true")]
438 pub show_other_hints: bool,
439 /// Whether or not to debounce inlay hints updates after buffer edits.
440 ///
441 /// Set to 0 to disable debouncing.
442 ///
443 /// Default: 700
444 #[serde(default = "edit_debounce_ms")]
445 pub edit_debounce_ms: u64,
446 /// Whether or not to debounce inlay hints updates after buffer scrolls.
447 ///
448 /// Set to 0 to disable debouncing.
449 ///
450 /// Default: 50
451 #[serde(default = "scroll_debounce_ms")]
452 pub scroll_debounce_ms: u64,
453}
454
455fn edit_debounce_ms() -> u64 {
456 700
457}
458
459fn scroll_debounce_ms() -> u64 {
460 50
461}
462
463impl InlayHintSettings {
464 /// Returns the kinds of inlay hints that are enabled based on the settings.
465 pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
466 let mut kinds = HashSet::default();
467 if self.show_type_hints {
468 kinds.insert(Some(InlayHintKind::Type));
469 }
470 if self.show_parameter_hints {
471 kinds.insert(Some(InlayHintKind::Parameter));
472 }
473 if self.show_other_hints {
474 kinds.insert(None);
475 }
476 kinds
477 }
478}
479
480impl AllLanguageSettings {
481 /// Returns the [`LanguageSettings`] for the language with the specified name.
482 pub fn language<'a>(&'a self, language_name: Option<&str>) -> &'a LanguageSettings {
483 if let Some(name) = language_name {
484 if let Some(overrides) = self.languages.get(name) {
485 return overrides;
486 }
487 }
488 &self.defaults
489 }
490
491 /// Returns whether inline completions are enabled for the given path.
492 pub fn inline_completions_enabled_for_path(&self, path: &Path) -> bool {
493 !self
494 .inline_completions
495 .disabled_globs
496 .iter()
497 .any(|glob| glob.is_match(path))
498 }
499
500 /// Returns whether inline completions are enabled for the given language and path.
501 pub fn inline_completions_enabled(
502 &self,
503 language: Option<&Arc<Language>>,
504 path: Option<&Path>,
505 ) -> bool {
506 if let Some(path) = path {
507 if !self.inline_completions_enabled_for_path(path) {
508 return false;
509 }
510 }
511
512 self.language(language.map(|l| l.name()).as_deref())
513 .show_inline_completions
514 }
515}
516
517/// The kind of an inlay hint.
518#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
519pub enum InlayHintKind {
520 /// An inlay hint for a type.
521 Type,
522 /// An inlay hint for a parameter.
523 Parameter,
524}
525
526impl InlayHintKind {
527 /// Returns the [`InlayHintKind`] from the given name.
528 ///
529 /// Returns `None` if `name` does not match any of the expected
530 /// string representations.
531 pub fn from_name(name: &str) -> Option<Self> {
532 match name {
533 "type" => Some(InlayHintKind::Type),
534 "parameter" => Some(InlayHintKind::Parameter),
535 _ => None,
536 }
537 }
538
539 /// Returns the name of this [`InlayHintKind`].
540 pub fn name(&self) -> &'static str {
541 match self {
542 InlayHintKind::Type => "type",
543 InlayHintKind::Parameter => "parameter",
544 }
545 }
546}
547
548impl settings::Settings for AllLanguageSettings {
549 const KEY: Option<&'static str> = None;
550
551 type FileContent = AllLanguageSettingsContent;
552
553 fn load(sources: SettingsSources<Self::FileContent>, _: &mut AppContext) -> Result<Self> {
554 let default_value = sources.default;
555
556 // A default is provided for all settings.
557 let mut defaults: LanguageSettings =
558 serde_json::from_value(serde_json::to_value(&default_value.defaults)?)?;
559
560 let mut languages = HashMap::default();
561 for (language_name, settings) in &default_value.languages {
562 let mut language_settings = defaults.clone();
563 merge_settings(&mut language_settings, settings);
564 languages.insert(language_name.clone(), language_settings);
565 }
566
567 let mut copilot_enabled = default_value.features.as_ref().and_then(|f| f.copilot);
568 let mut inline_completion_provider = default_value
569 .features
570 .as_ref()
571 .and_then(|f| f.inline_completion_provider);
572 let mut completion_globs = default_value
573 .inline_completions
574 .as_ref()
575 .and_then(|c| c.disabled_globs.as_ref())
576 .ok_or_else(Self::missing_default)?;
577
578 let mut file_types: HashMap<Arc<str>, Vec<String>> = HashMap::default();
579 for user_settings in sources.customizations() {
580 if let Some(copilot) = user_settings.features.as_ref().and_then(|f| f.copilot) {
581 copilot_enabled = Some(copilot);
582 }
583 if let Some(provider) = user_settings
584 .features
585 .as_ref()
586 .and_then(|f| f.inline_completion_provider)
587 {
588 inline_completion_provider = Some(provider);
589 }
590 if let Some(globs) = user_settings
591 .inline_completions
592 .as_ref()
593 .and_then(|f| f.disabled_globs.as_ref())
594 {
595 completion_globs = globs;
596 }
597
598 // A user's global settings override the default global settings and
599 // all default language-specific settings.
600 merge_settings(&mut defaults, &user_settings.defaults);
601 for language_settings in languages.values_mut() {
602 merge_settings(language_settings, &user_settings.defaults);
603 }
604
605 // A user's language-specific settings override default language-specific settings.
606 for (language_name, user_language_settings) in &user_settings.languages {
607 merge_settings(
608 languages
609 .entry(language_name.clone())
610 .or_insert_with(|| defaults.clone()),
611 user_language_settings,
612 );
613 }
614
615 for (language, suffixes) in &user_settings.file_types {
616 file_types
617 .entry(language.clone())
618 .or_default()
619 .extend_from_slice(suffixes);
620 }
621 }
622
623 Ok(Self {
624 inline_completions: InlineCompletionSettings {
625 provider: if let Some(provider) = inline_completion_provider {
626 provider
627 } else if copilot_enabled.unwrap_or(true) {
628 InlineCompletionProvider::Copilot
629 } else {
630 InlineCompletionProvider::None
631 },
632 disabled_globs: completion_globs
633 .iter()
634 .filter_map(|g| Some(globset::Glob::new(g).ok()?.compile_matcher()))
635 .collect(),
636 },
637 defaults,
638 languages,
639 file_types,
640 })
641 }
642
643 fn json_schema(
644 generator: &mut schemars::gen::SchemaGenerator,
645 params: &settings::SettingsJsonSchemaParams,
646 _: &AppContext,
647 ) -> schemars::schema::RootSchema {
648 let mut root_schema = generator.root_schema_for::<Self::FileContent>();
649
650 // Create a schema for a 'languages overrides' object, associating editor
651 // settings with specific languages.
652 assert!(root_schema
653 .definitions
654 .contains_key("LanguageSettingsContent"));
655
656 let languages_object_schema = SchemaObject {
657 instance_type: Some(InstanceType::Object.into()),
658 object: Some(Box::new(ObjectValidation {
659 properties: params
660 .language_names
661 .iter()
662 .map(|name| {
663 (
664 name.clone(),
665 Schema::new_ref("#/definitions/LanguageSettingsContent".into()),
666 )
667 })
668 .collect(),
669 ..Default::default()
670 })),
671 ..Default::default()
672 };
673
674 root_schema
675 .definitions
676 .extend([("Languages".into(), languages_object_schema.into())]);
677
678 root_schema
679 .schema
680 .object
681 .as_mut()
682 .unwrap()
683 .properties
684 .extend([
685 (
686 "languages".to_owned(),
687 Schema::new_ref("#/definitions/Languages".into()),
688 ),
689 // For backward compatibility
690 (
691 "language_overrides".to_owned(),
692 Schema::new_ref("#/definitions/Languages".into()),
693 ),
694 ]);
695
696 root_schema
697 }
698}
699
700fn merge_settings(settings: &mut LanguageSettings, src: &LanguageSettingsContent) {
701 fn merge<T>(target: &mut T, value: Option<T>) {
702 if let Some(value) = value {
703 *target = value;
704 }
705 }
706
707 merge(&mut settings.tab_size, src.tab_size);
708 merge(&mut settings.hard_tabs, src.hard_tabs);
709 merge(&mut settings.soft_wrap, src.soft_wrap);
710 merge(&mut settings.use_autoclose, src.use_autoclose);
711 merge(
712 &mut settings.always_treat_brackets_as_autoclosed,
713 src.always_treat_brackets_as_autoclosed,
714 );
715 merge(&mut settings.show_wrap_guides, src.show_wrap_guides);
716 merge(&mut settings.wrap_guides, src.wrap_guides.clone());
717 merge(
718 &mut settings.code_actions_on_format,
719 src.code_actions_on_format.clone(),
720 );
721
722 merge(
723 &mut settings.preferred_line_length,
724 src.preferred_line_length,
725 );
726 merge(&mut settings.formatter, src.formatter.clone());
727 merge(&mut settings.prettier, src.prettier.clone());
728 merge(&mut settings.format_on_save, src.format_on_save.clone());
729 merge(
730 &mut settings.remove_trailing_whitespace_on_save,
731 src.remove_trailing_whitespace_on_save,
732 );
733 merge(
734 &mut settings.ensure_final_newline_on_save,
735 src.ensure_final_newline_on_save,
736 );
737 merge(
738 &mut settings.enable_language_server,
739 src.enable_language_server,
740 );
741 merge(&mut settings.language_servers, src.language_servers.clone());
742 merge(
743 &mut settings.show_inline_completions,
744 src.show_inline_completions,
745 );
746 merge(&mut settings.show_whitespaces, src.show_whitespaces);
747 merge(
748 &mut settings.extend_comment_on_newline,
749 src.extend_comment_on_newline,
750 );
751 merge(&mut settings.inlay_hints, src.inlay_hints);
752}
753
754#[cfg(test)]
755mod tests {
756 use super::*;
757
758 #[test]
759 pub fn test_resolve_language_servers() {
760 fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
761 names
762 .into_iter()
763 .copied()
764 .map(|name| LanguageServerName(name.into()))
765 .collect::<Vec<_>>()
766 }
767
768 let available_language_servers = language_server_names(&[
769 "typescript-language-server",
770 "biome",
771 "deno",
772 "eslint",
773 "tailwind",
774 ]);
775
776 // A value of just `["..."]` is the same as taking all of the available language servers.
777 assert_eq!(
778 LanguageSettings::resolve_language_servers(
779 &[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
780 &available_language_servers,
781 ),
782 available_language_servers
783 );
784
785 // Referencing one of the available language servers will change its order.
786 assert_eq!(
787 LanguageSettings::resolve_language_servers(
788 &[
789 "biome".into(),
790 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
791 "deno".into()
792 ],
793 &available_language_servers
794 ),
795 language_server_names(&[
796 "biome",
797 "typescript-language-server",
798 "eslint",
799 "tailwind",
800 "deno",
801 ])
802 );
803
804 // Negating an available language server removes it from the list.
805 assert_eq!(
806 LanguageSettings::resolve_language_servers(
807 &[
808 "deno".into(),
809 "!typescript-language-server".into(),
810 "!biome".into(),
811 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
812 ],
813 &available_language_servers
814 ),
815 language_server_names(&["deno", "eslint", "tailwind"])
816 );
817
818 // Adding a language server not in the list of available language servers adds it to the list.
819 assert_eq!(
820 LanguageSettings::resolve_language_servers(
821 &[
822 "my-cool-language-server".into(),
823 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
824 ],
825 &available_language_servers
826 ),
827 language_server_names(&[
828 "my-cool-language-server",
829 "typescript-language-server",
830 "biome",
831 "deno",
832 "eslint",
833 "tailwind",
834 ])
835 );
836 }
837}