1//! Provides `language`-related settings.
2
3use crate::{File, Language, LanguageName, LanguageServerName};
4use anyhow::Result;
5use collections::{HashMap, HashSet};
6use core::slice;
7use globset::{Glob, GlobMatcher, GlobSet, GlobSetBuilder};
8use gpui::AppContext;
9use itertools::{Either, Itertools};
10use schemars::{
11 schema::{InstanceType, ObjectValidation, Schema, SchemaObject, SingleOrVec},
12 JsonSchema,
13};
14use serde::{
15 de::{self, IntoDeserializer, MapAccess, SeqAccess, Visitor},
16 Deserialize, Deserializer, Serialize,
17};
18use serde_json::Value;
19use settings::{add_references_to_properties, Settings, SettingsLocation, SettingsSources};
20use std::{num::NonZeroU32, path::Path, sync::Arc};
21use util::serde::default_true;
22
23/// Initializes the language settings.
24pub fn init(cx: &mut AppContext) {
25 AllLanguageSettings::register(cx);
26}
27
28/// Returns the settings for the specified language from the provided file.
29pub fn language_settings<'a>(
30 language: Option<&Arc<Language>>,
31 file: Option<&Arc<dyn File>>,
32 cx: &'a AppContext,
33) -> &'a LanguageSettings {
34 let language_name = language.map(|l| l.name());
35 all_language_settings(file, cx).language(language_name.as_ref())
36}
37
38/// Returns the settings for all languages from the provided file.
39pub fn all_language_settings<'a>(
40 file: Option<&Arc<dyn File>>,
41 cx: &'a AppContext,
42) -> &'a AllLanguageSettings {
43 let location = file.map(|f| SettingsLocation {
44 worktree_id: f.worktree_id(cx),
45 path: f.path().as_ref(),
46 });
47 AllLanguageSettings::get(location, cx)
48}
49
50/// The settings for all languages.
51#[derive(Debug, Clone)]
52pub struct AllLanguageSettings {
53 /// The inline completion settings.
54 pub inline_completions: InlineCompletionSettings,
55 defaults: LanguageSettings,
56 languages: HashMap<LanguageName, LanguageSettings>,
57 pub(crate) file_types: HashMap<Arc<str>, GlobSet>,
58}
59
60/// The settings for a particular language.
61#[derive(Debug, Clone, Deserialize)]
62pub struct LanguageSettings {
63 /// How many columns a tab should occupy.
64 pub tab_size: NonZeroU32,
65 /// Whether to indent lines using tab characters, as opposed to multiple
66 /// spaces.
67 pub hard_tabs: bool,
68 /// How to soft-wrap long lines of text.
69 pub soft_wrap: SoftWrap,
70 /// The column at which to soft-wrap lines, for buffers where soft-wrap
71 /// is enabled.
72 pub preferred_line_length: u32,
73 // Whether to show wrap guides (vertical rulers) in the editor.
74 // Setting this to true will show a guide at the 'preferred_line_length' value
75 // if softwrap is set to 'preferred_line_length', and will show any
76 // additional guides as specified by the 'wrap_guides' setting.
77 pub show_wrap_guides: bool,
78 /// Character counts at which to show wrap guides (vertical rulers) in the editor.
79 pub wrap_guides: Vec<usize>,
80 /// Indent guide related settings.
81 pub indent_guides: IndentGuideSettings,
82 /// Whether or not to perform a buffer format before saving.
83 pub format_on_save: FormatOnSave,
84 /// Whether or not to remove any trailing whitespace from lines of a buffer
85 /// before saving it.
86 pub remove_trailing_whitespace_on_save: bool,
87 /// Whether or not to ensure there's a single newline at the end of a buffer
88 /// when saving it.
89 pub ensure_final_newline_on_save: bool,
90 /// How to perform a buffer format.
91 pub formatter: SelectedFormatter,
92 /// Zed's Prettier integration settings.
93 pub prettier: PrettierSettings,
94 /// Whether to use language servers to provide code intelligence.
95 pub enable_language_server: bool,
96 /// The list of language servers to use (or disable) for this language.
97 ///
98 /// This array should consist of language server IDs, as well as the following
99 /// special tokens:
100 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
101 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
102 pub language_servers: Vec<String>,
103 /// Controls whether inline completions are shown immediately (true)
104 /// or manually by triggering `editor::ShowInlineCompletion` (false).
105 pub show_inline_completions: bool,
106 /// Whether to show tabs and spaces in the editor.
107 pub show_whitespaces: ShowWhitespaceSetting,
108 /// Whether to start a new line with a comment when a previous line is a comment as well.
109 pub extend_comment_on_newline: bool,
110 /// Inlay hint related settings.
111 pub inlay_hints: InlayHintSettings,
112 /// Whether to automatically close brackets.
113 pub use_autoclose: bool,
114 /// Whether to automatically surround text with brackets.
115 pub use_auto_surround: bool,
116 /// Whether to use additional LSP queries to format (and amend) the code after
117 /// every "trigger" symbol input, defined by LSP server capabilities.
118 pub use_on_type_format: bool,
119 // Controls how the editor handles the autoclosed characters.
120 pub always_treat_brackets_as_autoclosed: bool,
121 /// Which code actions to run on save
122 pub code_actions_on_format: HashMap<String, bool>,
123 /// Whether to perform linked edits
124 pub linked_edits: bool,
125 /// Task configuration for this language.
126 pub tasks: LanguageTaskConfig,
127}
128
129impl LanguageSettings {
130 /// A token representing the rest of the available language servers.
131 const REST_OF_LANGUAGE_SERVERS: &'static str = "...";
132
133 /// Returns the customized list of language servers from the list of
134 /// available language servers.
135 pub fn customized_language_servers(
136 &self,
137 available_language_servers: &[LanguageServerName],
138 ) -> Vec<LanguageServerName> {
139 Self::resolve_language_servers(&self.language_servers, available_language_servers)
140 }
141
142 pub(crate) fn resolve_language_servers(
143 configured_language_servers: &[String],
144 available_language_servers: &[LanguageServerName],
145 ) -> Vec<LanguageServerName> {
146 let (disabled_language_servers, enabled_language_servers): (
147 Vec<LanguageServerName>,
148 Vec<LanguageServerName>,
149 ) = configured_language_servers.iter().partition_map(
150 |language_server| match language_server.strip_prefix('!') {
151 Some(disabled) => Either::Left(LanguageServerName(disabled.to_string().into())),
152 None => Either::Right(LanguageServerName(language_server.clone().into())),
153 },
154 );
155
156 let rest = available_language_servers
157 .iter()
158 .filter(|&available_language_server| {
159 !disabled_language_servers.contains(&available_language_server)
160 && !enabled_language_servers.contains(&available_language_server)
161 })
162 .cloned()
163 .collect::<Vec<_>>();
164
165 enabled_language_servers
166 .into_iter()
167 .flat_map(|language_server| {
168 if language_server.0.as_ref() == Self::REST_OF_LANGUAGE_SERVERS {
169 rest.clone()
170 } else {
171 vec![language_server.clone()]
172 }
173 })
174 .collect::<Vec<_>>()
175 }
176}
177
178/// The provider that supplies inline completions.
179#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
180#[serde(rename_all = "snake_case")]
181pub enum InlineCompletionProvider {
182 None,
183 #[default]
184 Copilot,
185 Supermaven,
186}
187
188/// The settings for inline completions, such as [GitHub Copilot](https://github.com/features/copilot)
189/// or [Supermaven](https://supermaven.com).
190#[derive(Clone, Debug, Default)]
191pub struct InlineCompletionSettings {
192 /// The provider that supplies inline completions.
193 pub provider: InlineCompletionProvider,
194 /// A list of globs representing files that inline completions should be disabled for.
195 pub disabled_globs: Vec<GlobMatcher>,
196}
197
198/// The settings for all languages.
199#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
200pub struct AllLanguageSettingsContent {
201 /// The settings for enabling/disabling features.
202 #[serde(default)]
203 pub features: Option<FeaturesContent>,
204 /// The inline completion settings.
205 #[serde(default)]
206 pub inline_completions: Option<InlineCompletionSettingsContent>,
207 /// The default language settings.
208 #[serde(flatten)]
209 pub defaults: LanguageSettingsContent,
210 /// The settings for individual languages.
211 #[serde(default)]
212 pub languages: HashMap<LanguageName, LanguageSettingsContent>,
213 /// Settings for associating file extensions and filenames
214 /// with languages.
215 #[serde(default)]
216 pub file_types: HashMap<Arc<str>, Vec<String>>,
217}
218
219/// The settings for a particular language.
220#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
221pub struct LanguageSettingsContent {
222 /// How many columns a tab should occupy.
223 ///
224 /// Default: 4
225 #[serde(default)]
226 pub tab_size: Option<NonZeroU32>,
227 /// Whether to indent lines using tab characters, as opposed to multiple
228 /// spaces.
229 ///
230 /// Default: false
231 #[serde(default)]
232 pub hard_tabs: Option<bool>,
233 /// How to soft-wrap long lines of text.
234 ///
235 /// Default: none
236 #[serde(default)]
237 pub soft_wrap: Option<SoftWrap>,
238 /// The column at which to soft-wrap lines, for buffers where soft-wrap
239 /// is enabled.
240 ///
241 /// Default: 80
242 #[serde(default)]
243 pub preferred_line_length: Option<u32>,
244 /// Whether to show wrap guides in the editor. Setting this to true will
245 /// show a guide at the 'preferred_line_length' value if softwrap is set to
246 /// 'preferred_line_length', and will show any additional guides as specified
247 /// by the 'wrap_guides' setting.
248 ///
249 /// Default: true
250 #[serde(default)]
251 pub show_wrap_guides: Option<bool>,
252 /// Character counts at which to show wrap guides in the editor.
253 ///
254 /// Default: []
255 #[serde(default)]
256 pub wrap_guides: Option<Vec<usize>>,
257 /// Indent guide related settings.
258 #[serde(default)]
259 pub indent_guides: Option<IndentGuideSettings>,
260 /// Whether or not to perform a buffer format before saving.
261 ///
262 /// Default: on
263 #[serde(default)]
264 pub format_on_save: Option<FormatOnSave>,
265 /// Whether or not to remove any trailing whitespace from lines of a buffer
266 /// before saving it.
267 ///
268 /// Default: true
269 #[serde(default)]
270 pub remove_trailing_whitespace_on_save: Option<bool>,
271 /// Whether or not to ensure there's a single newline at the end of a buffer
272 /// when saving it.
273 ///
274 /// Default: true
275 #[serde(default)]
276 pub ensure_final_newline_on_save: Option<bool>,
277 /// How to perform a buffer format.
278 ///
279 /// Default: auto
280 #[serde(default)]
281 pub formatter: Option<SelectedFormatter>,
282 /// Zed's Prettier integration settings.
283 /// Allows to enable/disable formatting with Prettier
284 /// and configure default Prettier, used when no project-level Prettier installation is found.
285 ///
286 /// Default: off
287 #[serde(default)]
288 pub prettier: Option<PrettierSettings>,
289 /// Whether to use language servers to provide code intelligence.
290 ///
291 /// Default: true
292 #[serde(default)]
293 pub enable_language_server: Option<bool>,
294 /// The list of language servers to use (or disable) for this language.
295 ///
296 /// This array should consist of language server IDs, as well as the following
297 /// special tokens:
298 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
299 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
300 ///
301 /// Default: ["..."]
302 #[serde(default)]
303 pub language_servers: Option<Vec<String>>,
304 /// Controls whether inline completions are shown immediately (true)
305 /// or manually by triggering `editor::ShowInlineCompletion` (false).
306 ///
307 /// Default: true
308 #[serde(default)]
309 pub show_inline_completions: Option<bool>,
310 /// Whether to show tabs and spaces in the editor.
311 #[serde(default)]
312 pub show_whitespaces: Option<ShowWhitespaceSetting>,
313 /// Whether to start a new line with a comment when a previous line is a comment as well.
314 ///
315 /// Default: true
316 #[serde(default)]
317 pub extend_comment_on_newline: Option<bool>,
318 /// Inlay hint related settings.
319 #[serde(default)]
320 pub inlay_hints: Option<InlayHintSettings>,
321 /// Whether to automatically type closing characters for you. For example,
322 /// when you type (, Zed will automatically add a closing ) at the correct position.
323 ///
324 /// Default: true
325 pub use_autoclose: Option<bool>,
326 /// Whether to automatically surround text with characters for you. For example,
327 /// when you select text and type (, Zed will automatically surround text with ().
328 ///
329 /// Default: true
330 pub use_auto_surround: Option<bool>,
331 /// Controls how the editor handles the autoclosed characters.
332 /// When set to `false`(default), skipping over and auto-removing of the closing characters
333 /// happen only for auto-inserted characters.
334 /// Otherwise(when `true`), the closing characters are always skipped over and auto-removed
335 /// no matter how they were inserted.
336 ///
337 /// Default: false
338 pub always_treat_brackets_as_autoclosed: Option<bool>,
339 /// Whether to use additional LSP queries to format (and amend) the code after
340 /// every "trigger" symbol input, defined by LSP server capabilities.
341 ///
342 /// Default: true
343 pub use_on_type_format: Option<bool>,
344 /// Which code actions to run on save after the formatter.
345 /// These are not run if formatting is off.
346 ///
347 /// Default: {} (or {"source.organizeImports": true} for Go).
348 pub code_actions_on_format: Option<HashMap<String, bool>>,
349 /// Whether to perform linked edits of associated ranges, if the language server supports it.
350 /// For example, when editing opening <html> tag, the contents of the closing </html> tag will be edited as well.
351 ///
352 /// Default: true
353 pub linked_edits: Option<bool>,
354 /// Task configuration for this language.
355 ///
356 /// Default: {}
357 pub tasks: Option<LanguageTaskConfig>,
358}
359
360/// The contents of the inline completion settings.
361#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
362pub struct InlineCompletionSettingsContent {
363 /// A list of globs representing files that inline completions should be disabled for.
364 #[serde(default)]
365 pub disabled_globs: Option<Vec<String>>,
366}
367
368/// The settings for enabling/disabling features.
369#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema)]
370#[serde(rename_all = "snake_case")]
371pub struct FeaturesContent {
372 /// Whether the GitHub Copilot feature is enabled.
373 pub copilot: Option<bool>,
374 /// Determines which inline completion provider to use.
375 pub inline_completion_provider: Option<InlineCompletionProvider>,
376}
377
378/// Controls the soft-wrapping behavior in the editor.
379#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
380#[serde(rename_all = "snake_case")]
381pub enum SoftWrap {
382 /// Do not soft wrap.
383 None,
384 /// Prefer a single line generally, unless an overly long line is encountered.
385 PreferLine,
386 /// Soft wrap lines that exceed the editor width
387 EditorWidth,
388 /// Soft wrap lines at the preferred line length
389 PreferredLineLength,
390 /// Soft wrap line at the preferred line length or the editor width (whichever is smaller)
391 Bounded,
392}
393
394/// Controls the behavior of formatting files when they are saved.
395#[derive(Debug, Clone, PartialEq, Eq)]
396pub enum FormatOnSave {
397 /// Files should be formatted on save.
398 On,
399 /// Files should not be formatted on save.
400 Off,
401 List(FormatterList),
402}
403
404impl JsonSchema for FormatOnSave {
405 fn schema_name() -> String {
406 "OnSaveFormatter".into()
407 }
408
409 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
410 let mut schema = SchemaObject::default();
411 let formatter_schema = Formatter::json_schema(generator);
412 schema.instance_type = Some(
413 vec![
414 InstanceType::Object,
415 InstanceType::String,
416 InstanceType::Array,
417 ]
418 .into(),
419 );
420
421 let valid_raw_values = SchemaObject {
422 enum_values: Some(vec![
423 Value::String("on".into()),
424 Value::String("off".into()),
425 Value::String("prettier".into()),
426 Value::String("language_server".into()),
427 ]),
428 ..Default::default()
429 };
430 let mut nested_values = SchemaObject::default();
431
432 nested_values.array().items = Some(formatter_schema.clone().into());
433
434 schema.subschemas().any_of = Some(vec![
435 nested_values.into(),
436 valid_raw_values.into(),
437 formatter_schema,
438 ]);
439 schema.into()
440 }
441}
442
443impl Serialize for FormatOnSave {
444 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
445 where
446 S: serde::Serializer,
447 {
448 match self {
449 Self::On => serializer.serialize_str("on"),
450 Self::Off => serializer.serialize_str("off"),
451 Self::List(list) => list.serialize(serializer),
452 }
453 }
454}
455
456impl<'de> Deserialize<'de> for FormatOnSave {
457 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
458 where
459 D: Deserializer<'de>,
460 {
461 struct FormatDeserializer;
462
463 impl<'d> Visitor<'d> for FormatDeserializer {
464 type Value = FormatOnSave;
465
466 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
467 formatter.write_str("a valid on-save formatter kind")
468 }
469 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
470 where
471 E: serde::de::Error,
472 {
473 if v == "on" {
474 Ok(Self::Value::On)
475 } else if v == "off" {
476 Ok(Self::Value::Off)
477 } else if v == "language_server" {
478 Ok(Self::Value::List(FormatterList(
479 Formatter::LanguageServer { name: None }.into(),
480 )))
481 } else {
482 let ret: Result<FormatterList, _> =
483 Deserialize::deserialize(v.into_deserializer());
484 ret.map(Self::Value::List)
485 }
486 }
487 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
488 where
489 A: MapAccess<'d>,
490 {
491 let ret: Result<FormatterList, _> =
492 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
493 ret.map(Self::Value::List)
494 }
495 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
496 where
497 A: SeqAccess<'d>,
498 {
499 let ret: Result<FormatterList, _> =
500 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
501 ret.map(Self::Value::List)
502 }
503 }
504 deserializer.deserialize_any(FormatDeserializer)
505 }
506}
507
508/// Controls how whitespace should be displayedin the editor.
509#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
510#[serde(rename_all = "snake_case")]
511pub enum ShowWhitespaceSetting {
512 /// Draw whitespace only for the selected text.
513 Selection,
514 /// Do not draw any tabs or spaces.
515 None,
516 /// Draw all invisible symbols.
517 All,
518 /// Draw whitespaces at boundaries only.
519 ///
520 /// For a whitespace to be on a boundary, any of the following conditions need to be met:
521 /// - It is a tab
522 /// - It is adjacent to an edge (start or end)
523 /// - It is adjacent to a whitespace (left or right)
524 Boundary,
525}
526
527/// Controls which formatter should be used when formatting code.
528#[derive(Clone, Debug, Default, PartialEq, Eq)]
529pub enum SelectedFormatter {
530 /// Format files using Zed's Prettier integration (if applicable),
531 /// or falling back to formatting via language server.
532 #[default]
533 Auto,
534 List(FormatterList),
535}
536
537impl JsonSchema for SelectedFormatter {
538 fn schema_name() -> String {
539 "Formatter".into()
540 }
541
542 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
543 let mut schema = SchemaObject::default();
544 let formatter_schema = Formatter::json_schema(generator);
545 schema.instance_type = Some(
546 vec![
547 InstanceType::Object,
548 InstanceType::String,
549 InstanceType::Array,
550 ]
551 .into(),
552 );
553
554 let valid_raw_values = SchemaObject {
555 enum_values: Some(vec![
556 Value::String("auto".into()),
557 Value::String("prettier".into()),
558 Value::String("language_server".into()),
559 ]),
560 ..Default::default()
561 };
562
563 let mut nested_values = SchemaObject::default();
564
565 nested_values.array().items = Some(formatter_schema.clone().into());
566
567 schema.subschemas().any_of = Some(vec![
568 nested_values.into(),
569 valid_raw_values.into(),
570 formatter_schema,
571 ]);
572 schema.into()
573 }
574}
575
576impl Serialize for SelectedFormatter {
577 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
578 where
579 S: serde::Serializer,
580 {
581 match self {
582 SelectedFormatter::Auto => serializer.serialize_str("auto"),
583 SelectedFormatter::List(list) => list.serialize(serializer),
584 }
585 }
586}
587impl<'de> Deserialize<'de> for SelectedFormatter {
588 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
589 where
590 D: Deserializer<'de>,
591 {
592 struct FormatDeserializer;
593
594 impl<'d> Visitor<'d> for FormatDeserializer {
595 type Value = SelectedFormatter;
596
597 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
598 formatter.write_str("a valid formatter kind")
599 }
600 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
601 where
602 E: serde::de::Error,
603 {
604 if v == "auto" {
605 Ok(Self::Value::Auto)
606 } else if v == "language_server" {
607 Ok(Self::Value::List(FormatterList(
608 Formatter::LanguageServer { name: None }.into(),
609 )))
610 } else {
611 let ret: Result<FormatterList, _> =
612 Deserialize::deserialize(v.into_deserializer());
613 ret.map(SelectedFormatter::List)
614 }
615 }
616 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
617 where
618 A: MapAccess<'d>,
619 {
620 let ret: Result<FormatterList, _> =
621 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
622 ret.map(SelectedFormatter::List)
623 }
624 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
625 where
626 A: SeqAccess<'d>,
627 {
628 let ret: Result<FormatterList, _> =
629 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
630 ret.map(SelectedFormatter::List)
631 }
632 }
633 deserializer.deserialize_any(FormatDeserializer)
634 }
635}
636/// Controls which formatter should be used when formatting code.
637#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
638#[serde(rename_all = "snake_case", transparent)]
639pub struct FormatterList(pub SingleOrVec<Formatter>);
640
641impl AsRef<[Formatter]> for FormatterList {
642 fn as_ref(&self) -> &[Formatter] {
643 match &self.0 {
644 SingleOrVec::Single(single) => slice::from_ref(single),
645 SingleOrVec::Vec(v) => v,
646 }
647 }
648}
649
650/// Controls which formatter should be used when formatting code. If there are multiple formatters, they are executed in the order of declaration.
651#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
652#[serde(rename_all = "snake_case")]
653pub enum Formatter {
654 /// Format code using the current language server.
655 LanguageServer { name: Option<String> },
656 /// Format code using Zed's Prettier integration.
657 Prettier,
658 /// Format code using an external command.
659 External {
660 /// The external program to run.
661 command: Arc<str>,
662 /// The arguments to pass to the program.
663 arguments: Arc<[String]>,
664 },
665 /// Files should be formatted using code actions executed by language servers.
666 CodeActions(HashMap<String, bool>),
667}
668
669/// The settings for indent guides.
670#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
671pub struct IndentGuideSettings {
672 /// Whether to display indent guides in the editor.
673 ///
674 /// Default: true
675 #[serde(default = "default_true")]
676 pub enabled: bool,
677 /// The width of the indent guides in pixels, between 1 and 10.
678 ///
679 /// Default: 1
680 #[serde(default = "line_width")]
681 pub line_width: u32,
682 /// The width of the active indent guide in pixels, between 1 and 10.
683 ///
684 /// Default: 1
685 #[serde(default = "active_line_width")]
686 pub active_line_width: u32,
687 /// Determines how indent guides are colored.
688 ///
689 /// Default: Fixed
690 #[serde(default)]
691 pub coloring: IndentGuideColoring,
692 /// Determines how indent guide backgrounds are colored.
693 ///
694 /// Default: Disabled
695 #[serde(default)]
696 pub background_coloring: IndentGuideBackgroundColoring,
697}
698
699fn line_width() -> u32 {
700 1
701}
702
703fn active_line_width() -> u32 {
704 line_width()
705}
706
707/// Determines how indent guides are colored.
708#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
709#[serde(rename_all = "snake_case")]
710pub enum IndentGuideColoring {
711 /// Do not render any lines for indent guides.
712 Disabled,
713 /// Use the same color for all indentation levels.
714 #[default]
715 Fixed,
716 /// Use a different color for each indentation level.
717 IndentAware,
718}
719
720/// Determines how indent guide backgrounds are colored.
721#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
722#[serde(rename_all = "snake_case")]
723pub enum IndentGuideBackgroundColoring {
724 /// Do not render any background for indent guides.
725 #[default]
726 Disabled,
727 /// Use a different color for each indentation level.
728 IndentAware,
729}
730
731/// The settings for inlay hints.
732#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
733pub struct InlayHintSettings {
734 /// Global switch to toggle hints on and off.
735 ///
736 /// Default: false
737 #[serde(default)]
738 pub enabled: bool,
739 /// Whether type hints should be shown.
740 ///
741 /// Default: true
742 #[serde(default = "default_true")]
743 pub show_type_hints: bool,
744 /// Whether parameter hints should be shown.
745 ///
746 /// Default: true
747 #[serde(default = "default_true")]
748 pub show_parameter_hints: bool,
749 /// Whether other hints should be shown.
750 ///
751 /// Default: true
752 #[serde(default = "default_true")]
753 pub show_other_hints: bool,
754 /// Whether to show a background for inlay hints.
755 ///
756 /// If set to `true`, the background will use the `hint.background` color
757 /// from the current theme.
758 ///
759 /// Default: false
760 #[serde(default)]
761 pub show_background: bool,
762 /// Whether or not to debounce inlay hints updates after buffer edits.
763 ///
764 /// Set to 0 to disable debouncing.
765 ///
766 /// Default: 700
767 #[serde(default = "edit_debounce_ms")]
768 pub edit_debounce_ms: u64,
769 /// Whether or not to debounce inlay hints updates after buffer scrolls.
770 ///
771 /// Set to 0 to disable debouncing.
772 ///
773 /// Default: 50
774 #[serde(default = "scroll_debounce_ms")]
775 pub scroll_debounce_ms: u64,
776}
777
778fn edit_debounce_ms() -> u64 {
779 700
780}
781
782fn scroll_debounce_ms() -> u64 {
783 50
784}
785
786/// The task settings for a particular language.
787#[derive(Debug, Clone, Deserialize, PartialEq, Serialize, JsonSchema)]
788pub struct LanguageTaskConfig {
789 /// Extra task variables to set for a particular language.
790 pub variables: HashMap<String, String>,
791}
792
793impl InlayHintSettings {
794 /// Returns the kinds of inlay hints that are enabled based on the settings.
795 pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
796 let mut kinds = HashSet::default();
797 if self.show_type_hints {
798 kinds.insert(Some(InlayHintKind::Type));
799 }
800 if self.show_parameter_hints {
801 kinds.insert(Some(InlayHintKind::Parameter));
802 }
803 if self.show_other_hints {
804 kinds.insert(None);
805 }
806 kinds
807 }
808}
809
810impl AllLanguageSettings {
811 /// Returns the [`LanguageSettings`] for the language with the specified name.
812 pub fn language<'a>(&'a self, language_name: Option<&LanguageName>) -> &'a LanguageSettings {
813 if let Some(name) = language_name {
814 if let Some(overrides) = self.languages.get(name) {
815 return overrides;
816 }
817 }
818 &self.defaults
819 }
820
821 /// Returns whether inline completions are enabled for the given path.
822 pub fn inline_completions_enabled_for_path(&self, path: &Path) -> bool {
823 !self
824 .inline_completions
825 .disabled_globs
826 .iter()
827 .any(|glob| glob.is_match(path))
828 }
829
830 /// Returns whether inline completions are enabled for the given language and path.
831 pub fn inline_completions_enabled(
832 &self,
833 language: Option<&Arc<Language>>,
834 path: Option<&Path>,
835 ) -> bool {
836 if let Some(path) = path {
837 if !self.inline_completions_enabled_for_path(path) {
838 return false;
839 }
840 }
841
842 self.language(language.map(|l| l.name()).as_ref())
843 .show_inline_completions
844 }
845}
846
847/// The kind of an inlay hint.
848#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
849pub enum InlayHintKind {
850 /// An inlay hint for a type.
851 Type,
852 /// An inlay hint for a parameter.
853 Parameter,
854}
855
856impl InlayHintKind {
857 /// Returns the [`InlayHintKind`] from the given name.
858 ///
859 /// Returns `None` if `name` does not match any of the expected
860 /// string representations.
861 pub fn from_name(name: &str) -> Option<Self> {
862 match name {
863 "type" => Some(InlayHintKind::Type),
864 "parameter" => Some(InlayHintKind::Parameter),
865 _ => None,
866 }
867 }
868
869 /// Returns the name of this [`InlayHintKind`].
870 pub fn name(&self) -> &'static str {
871 match self {
872 InlayHintKind::Type => "type",
873 InlayHintKind::Parameter => "parameter",
874 }
875 }
876}
877
878impl settings::Settings for AllLanguageSettings {
879 const KEY: Option<&'static str> = None;
880
881 type FileContent = AllLanguageSettingsContent;
882
883 fn load(sources: SettingsSources<Self::FileContent>, _: &mut AppContext) -> Result<Self> {
884 let default_value = sources.default;
885
886 // A default is provided for all settings.
887 let mut defaults: LanguageSettings =
888 serde_json::from_value(serde_json::to_value(&default_value.defaults)?)?;
889
890 let mut languages = HashMap::default();
891 for (language_name, settings) in &default_value.languages {
892 let mut language_settings = defaults.clone();
893 merge_settings(&mut language_settings, settings);
894 languages.insert(language_name.clone(), language_settings);
895 }
896
897 let mut copilot_enabled = default_value.features.as_ref().and_then(|f| f.copilot);
898 let mut inline_completion_provider = default_value
899 .features
900 .as_ref()
901 .and_then(|f| f.inline_completion_provider);
902 let mut completion_globs = default_value
903 .inline_completions
904 .as_ref()
905 .and_then(|c| c.disabled_globs.as_ref())
906 .ok_or_else(Self::missing_default)?;
907
908 let mut file_types: HashMap<Arc<str>, GlobSet> = HashMap::default();
909
910 for (language, suffixes) in &default_value.file_types {
911 let mut builder = GlobSetBuilder::new();
912
913 for suffix in suffixes {
914 builder.add(Glob::new(suffix)?);
915 }
916
917 file_types.insert(language.clone(), builder.build()?);
918 }
919
920 for user_settings in sources.customizations() {
921 if let Some(copilot) = user_settings.features.as_ref().and_then(|f| f.copilot) {
922 copilot_enabled = Some(copilot);
923 }
924 if let Some(provider) = user_settings
925 .features
926 .as_ref()
927 .and_then(|f| f.inline_completion_provider)
928 {
929 inline_completion_provider = Some(provider);
930 }
931 if let Some(globs) = user_settings
932 .inline_completions
933 .as_ref()
934 .and_then(|f| f.disabled_globs.as_ref())
935 {
936 completion_globs = globs;
937 }
938
939 // A user's global settings override the default global settings and
940 // all default language-specific settings.
941 merge_settings(&mut defaults, &user_settings.defaults);
942 for language_settings in languages.values_mut() {
943 merge_settings(language_settings, &user_settings.defaults);
944 }
945
946 // A user's language-specific settings override default language-specific settings.
947 for (language_name, user_language_settings) in &user_settings.languages {
948 merge_settings(
949 languages
950 .entry(language_name.clone())
951 .or_insert_with(|| defaults.clone()),
952 user_language_settings,
953 );
954 }
955
956 for (language, suffixes) in &user_settings.file_types {
957 let mut builder = GlobSetBuilder::new();
958
959 let default_value = default_value.file_types.get(&language.clone());
960
961 // Merge the default value with the user's value.
962 if let Some(suffixes) = default_value {
963 for suffix in suffixes {
964 builder.add(Glob::new(suffix)?);
965 }
966 }
967
968 for suffix in suffixes {
969 builder.add(Glob::new(suffix)?);
970 }
971
972 file_types.insert(language.clone(), builder.build()?);
973 }
974 }
975
976 Ok(Self {
977 inline_completions: InlineCompletionSettings {
978 provider: if let Some(provider) = inline_completion_provider {
979 provider
980 } else if copilot_enabled.unwrap_or(true) {
981 InlineCompletionProvider::Copilot
982 } else {
983 InlineCompletionProvider::None
984 },
985 disabled_globs: completion_globs
986 .iter()
987 .filter_map(|g| Some(globset::Glob::new(g).ok()?.compile_matcher()))
988 .collect(),
989 },
990 defaults,
991 languages,
992 file_types,
993 })
994 }
995
996 fn json_schema(
997 generator: &mut schemars::gen::SchemaGenerator,
998 params: &settings::SettingsJsonSchemaParams,
999 _: &AppContext,
1000 ) -> schemars::schema::RootSchema {
1001 let mut root_schema = generator.root_schema_for::<Self::FileContent>();
1002
1003 // Create a schema for a 'languages overrides' object, associating editor
1004 // settings with specific languages.
1005 assert!(root_schema
1006 .definitions
1007 .contains_key("LanguageSettingsContent"));
1008
1009 let languages_object_schema = SchemaObject {
1010 instance_type: Some(InstanceType::Object.into()),
1011 object: Some(Box::new(ObjectValidation {
1012 properties: params
1013 .language_names
1014 .iter()
1015 .map(|name| {
1016 (
1017 name.clone(),
1018 Schema::new_ref("#/definitions/LanguageSettingsContent".into()),
1019 )
1020 })
1021 .collect(),
1022 ..Default::default()
1023 })),
1024 ..Default::default()
1025 };
1026
1027 root_schema
1028 .definitions
1029 .extend([("Languages".into(), languages_object_schema.into())]);
1030
1031 add_references_to_properties(
1032 &mut root_schema,
1033 &[("languages", "#/definitions/Languages")],
1034 );
1035
1036 root_schema
1037 }
1038}
1039
1040fn merge_settings(settings: &mut LanguageSettings, src: &LanguageSettingsContent) {
1041 fn merge<T>(target: &mut T, value: Option<T>) {
1042 if let Some(value) = value {
1043 *target = value;
1044 }
1045 }
1046
1047 merge(&mut settings.tab_size, src.tab_size);
1048 settings.tab_size = settings
1049 .tab_size
1050 .clamp(NonZeroU32::new(1).unwrap(), NonZeroU32::new(16).unwrap());
1051
1052 merge(&mut settings.hard_tabs, src.hard_tabs);
1053 merge(&mut settings.soft_wrap, src.soft_wrap);
1054 merge(&mut settings.use_autoclose, src.use_autoclose);
1055 merge(&mut settings.use_auto_surround, src.use_auto_surround);
1056 merge(&mut settings.use_on_type_format, src.use_on_type_format);
1057 merge(
1058 &mut settings.always_treat_brackets_as_autoclosed,
1059 src.always_treat_brackets_as_autoclosed,
1060 );
1061 merge(&mut settings.show_wrap_guides, src.show_wrap_guides);
1062 merge(&mut settings.wrap_guides, src.wrap_guides.clone());
1063 merge(&mut settings.indent_guides, src.indent_guides);
1064 merge(
1065 &mut settings.code_actions_on_format,
1066 src.code_actions_on_format.clone(),
1067 );
1068 merge(&mut settings.linked_edits, src.linked_edits);
1069 merge(&mut settings.tasks, src.tasks.clone());
1070
1071 merge(
1072 &mut settings.preferred_line_length,
1073 src.preferred_line_length,
1074 );
1075 merge(&mut settings.formatter, src.formatter.clone());
1076 merge(&mut settings.prettier, src.prettier.clone());
1077 merge(&mut settings.format_on_save, src.format_on_save.clone());
1078 merge(
1079 &mut settings.remove_trailing_whitespace_on_save,
1080 src.remove_trailing_whitespace_on_save,
1081 );
1082 merge(
1083 &mut settings.ensure_final_newline_on_save,
1084 src.ensure_final_newline_on_save,
1085 );
1086 merge(
1087 &mut settings.enable_language_server,
1088 src.enable_language_server,
1089 );
1090 merge(&mut settings.language_servers, src.language_servers.clone());
1091 merge(
1092 &mut settings.show_inline_completions,
1093 src.show_inline_completions,
1094 );
1095 merge(&mut settings.show_whitespaces, src.show_whitespaces);
1096 merge(
1097 &mut settings.extend_comment_on_newline,
1098 src.extend_comment_on_newline,
1099 );
1100 merge(&mut settings.inlay_hints, src.inlay_hints);
1101}
1102
1103/// Allows to enable/disable formatting with Prettier
1104/// and configure default Prettier, used when no project-level Prettier installation is found.
1105/// Prettier formatting is disabled by default.
1106#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1107pub struct PrettierSettings {
1108 /// Enables or disables formatting with Prettier for a given language.
1109 #[serde(default)]
1110 pub allowed: bool,
1111
1112 /// Forces Prettier integration to use a specific parser name when formatting files with the language.
1113 #[serde(default)]
1114 pub parser: Option<String>,
1115
1116 /// Forces Prettier integration to use specific plugins when formatting files with the language.
1117 /// The default Prettier will be installed with these plugins.
1118 #[serde(default)]
1119 pub plugins: HashSet<String>,
1120
1121 /// Default Prettier options, in the format as in package.json section for Prettier.
1122 /// If project installs Prettier via its package.json, these options will be ignored.
1123 #[serde(flatten)]
1124 pub options: HashMap<String, serde_json::Value>,
1125}
1126
1127#[cfg(test)]
1128mod tests {
1129 use super::*;
1130
1131 #[test]
1132 fn test_formatter_deserialization() {
1133 let raw_auto = "{\"formatter\": \"auto\"}";
1134 let settings: LanguageSettingsContent = serde_json::from_str(raw_auto).unwrap();
1135 assert_eq!(settings.formatter, Some(SelectedFormatter::Auto));
1136 let raw = "{\"formatter\": \"language_server\"}";
1137 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1138 assert_eq!(
1139 settings.formatter,
1140 Some(SelectedFormatter::List(FormatterList(
1141 Formatter::LanguageServer { name: None }.into()
1142 )))
1143 );
1144 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}]}";
1145 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1146 assert_eq!(
1147 settings.formatter,
1148 Some(SelectedFormatter::List(FormatterList(
1149 vec![Formatter::LanguageServer { name: None }].into()
1150 )))
1151 );
1152 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}, \"prettier\"]}";
1153 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1154 assert_eq!(
1155 settings.formatter,
1156 Some(SelectedFormatter::List(FormatterList(
1157 vec![
1158 Formatter::LanguageServer { name: None },
1159 Formatter::Prettier
1160 ]
1161 .into()
1162 )))
1163 );
1164 }
1165
1166 #[test]
1167 fn test_formatter_deserialization_invalid() {
1168 let raw_auto = "{\"formatter\": {}}";
1169 let result: Result<LanguageSettingsContent, _> = serde_json::from_str(raw_auto);
1170 assert!(result.is_err());
1171 }
1172
1173 #[test]
1174 pub fn test_resolve_language_servers() {
1175 fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
1176 names
1177 .iter()
1178 .copied()
1179 .map(|name| LanguageServerName(name.to_string().into()))
1180 .collect::<Vec<_>>()
1181 }
1182
1183 let available_language_servers = language_server_names(&[
1184 "typescript-language-server",
1185 "biome",
1186 "deno",
1187 "eslint",
1188 "tailwind",
1189 ]);
1190
1191 // A value of just `["..."]` is the same as taking all of the available language servers.
1192 assert_eq!(
1193 LanguageSettings::resolve_language_servers(
1194 &[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
1195 &available_language_servers,
1196 ),
1197 available_language_servers
1198 );
1199
1200 // Referencing one of the available language servers will change its order.
1201 assert_eq!(
1202 LanguageSettings::resolve_language_servers(
1203 &[
1204 "biome".into(),
1205 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
1206 "deno".into()
1207 ],
1208 &available_language_servers
1209 ),
1210 language_server_names(&[
1211 "biome",
1212 "typescript-language-server",
1213 "eslint",
1214 "tailwind",
1215 "deno",
1216 ])
1217 );
1218
1219 // Negating an available language server removes it from the list.
1220 assert_eq!(
1221 LanguageSettings::resolve_language_servers(
1222 &[
1223 "deno".into(),
1224 "!typescript-language-server".into(),
1225 "!biome".into(),
1226 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1227 ],
1228 &available_language_servers
1229 ),
1230 language_server_names(&["deno", "eslint", "tailwind"])
1231 );
1232
1233 // Adding a language server not in the list of available language servers adds it to the list.
1234 assert_eq!(
1235 LanguageSettings::resolve_language_servers(
1236 &[
1237 "my-cool-language-server".into(),
1238 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1239 ],
1240 &available_language_servers
1241 ),
1242 language_server_names(&[
1243 "my-cool-language-server",
1244 "typescript-language-server",
1245 "biome",
1246 "deno",
1247 "eslint",
1248 "tailwind",
1249 ])
1250 );
1251 }
1252}