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