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