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 /// Prefer a single line generally, unless an overly long line is encountered.
383 None,
384 /// Deprecated: use None instead. Left to avoid breaking existing users' configs.
385 /// Prefer a single line generally, unless an overly long line is encountered.
386 PreferLine,
387 /// Soft wrap lines that exceed the editor width.
388 EditorWidth,
389 /// Soft wrap lines at the preferred line length.
390 PreferredLineLength,
391 /// Soft wrap line at the preferred line length or the editor width (whichever is smaller).
392 Bounded,
393}
394
395/// Controls the behavior of formatting files when they are saved.
396#[derive(Debug, Clone, PartialEq, Eq)]
397pub enum FormatOnSave {
398 /// Files should be formatted on save.
399 On,
400 /// Files should not be formatted on save.
401 Off,
402 List(FormatterList),
403}
404
405impl JsonSchema for FormatOnSave {
406 fn schema_name() -> String {
407 "OnSaveFormatter".into()
408 }
409
410 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
411 let mut schema = SchemaObject::default();
412 let formatter_schema = Formatter::json_schema(generator);
413 schema.instance_type = Some(
414 vec![
415 InstanceType::Object,
416 InstanceType::String,
417 InstanceType::Array,
418 ]
419 .into(),
420 );
421
422 let valid_raw_values = SchemaObject {
423 enum_values: Some(vec![
424 Value::String("on".into()),
425 Value::String("off".into()),
426 Value::String("prettier".into()),
427 Value::String("language_server".into()),
428 ]),
429 ..Default::default()
430 };
431 let mut nested_values = SchemaObject::default();
432
433 nested_values.array().items = Some(formatter_schema.clone().into());
434
435 schema.subschemas().any_of = Some(vec![
436 nested_values.into(),
437 valid_raw_values.into(),
438 formatter_schema,
439 ]);
440 schema.into()
441 }
442}
443
444impl Serialize for FormatOnSave {
445 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
446 where
447 S: serde::Serializer,
448 {
449 match self {
450 Self::On => serializer.serialize_str("on"),
451 Self::Off => serializer.serialize_str("off"),
452 Self::List(list) => list.serialize(serializer),
453 }
454 }
455}
456
457impl<'de> Deserialize<'de> for FormatOnSave {
458 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
459 where
460 D: Deserializer<'de>,
461 {
462 struct FormatDeserializer;
463
464 impl<'d> Visitor<'d> for FormatDeserializer {
465 type Value = FormatOnSave;
466
467 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
468 formatter.write_str("a valid on-save formatter kind")
469 }
470 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
471 where
472 E: serde::de::Error,
473 {
474 if v == "on" {
475 Ok(Self::Value::On)
476 } else if v == "off" {
477 Ok(Self::Value::Off)
478 } else if v == "language_server" {
479 Ok(Self::Value::List(FormatterList(
480 Formatter::LanguageServer { name: None }.into(),
481 )))
482 } else {
483 let ret: Result<FormatterList, _> =
484 Deserialize::deserialize(v.into_deserializer());
485 ret.map(Self::Value::List)
486 }
487 }
488 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
489 where
490 A: MapAccess<'d>,
491 {
492 let ret: Result<FormatterList, _> =
493 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
494 ret.map(Self::Value::List)
495 }
496 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
497 where
498 A: SeqAccess<'d>,
499 {
500 let ret: Result<FormatterList, _> =
501 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
502 ret.map(Self::Value::List)
503 }
504 }
505 deserializer.deserialize_any(FormatDeserializer)
506 }
507}
508
509/// Controls how whitespace should be displayedin the editor.
510#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
511#[serde(rename_all = "snake_case")]
512pub enum ShowWhitespaceSetting {
513 /// Draw whitespace only for the selected text.
514 Selection,
515 /// Do not draw any tabs or spaces.
516 None,
517 /// Draw all invisible symbols.
518 All,
519 /// Draw whitespaces at boundaries only.
520 ///
521 /// For a whitespace to be on a boundary, any of the following conditions need to be met:
522 /// - It is a tab
523 /// - It is adjacent to an edge (start or end)
524 /// - It is adjacent to a whitespace (left or right)
525 Boundary,
526}
527
528/// Controls which formatter should be used when formatting code.
529#[derive(Clone, Debug, Default, PartialEq, Eq)]
530pub enum SelectedFormatter {
531 /// Format files using Zed's Prettier integration (if applicable),
532 /// or falling back to formatting via language server.
533 #[default]
534 Auto,
535 List(FormatterList),
536}
537
538impl JsonSchema for SelectedFormatter {
539 fn schema_name() -> String {
540 "Formatter".into()
541 }
542
543 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
544 let mut schema = SchemaObject::default();
545 let formatter_schema = Formatter::json_schema(generator);
546 schema.instance_type = Some(
547 vec![
548 InstanceType::Object,
549 InstanceType::String,
550 InstanceType::Array,
551 ]
552 .into(),
553 );
554
555 let valid_raw_values = SchemaObject {
556 enum_values: Some(vec![
557 Value::String("auto".into()),
558 Value::String("prettier".into()),
559 Value::String("language_server".into()),
560 ]),
561 ..Default::default()
562 };
563
564 let mut nested_values = SchemaObject::default();
565
566 nested_values.array().items = Some(formatter_schema.clone().into());
567
568 schema.subschemas().any_of = Some(vec![
569 nested_values.into(),
570 valid_raw_values.into(),
571 formatter_schema,
572 ]);
573 schema.into()
574 }
575}
576
577impl Serialize for SelectedFormatter {
578 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
579 where
580 S: serde::Serializer,
581 {
582 match self {
583 SelectedFormatter::Auto => serializer.serialize_str("auto"),
584 SelectedFormatter::List(list) => list.serialize(serializer),
585 }
586 }
587}
588impl<'de> Deserialize<'de> for SelectedFormatter {
589 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
590 where
591 D: Deserializer<'de>,
592 {
593 struct FormatDeserializer;
594
595 impl<'d> Visitor<'d> for FormatDeserializer {
596 type Value = SelectedFormatter;
597
598 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
599 formatter.write_str("a valid formatter kind")
600 }
601 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
602 where
603 E: serde::de::Error,
604 {
605 if v == "auto" {
606 Ok(Self::Value::Auto)
607 } else if v == "language_server" {
608 Ok(Self::Value::List(FormatterList(
609 Formatter::LanguageServer { name: None }.into(),
610 )))
611 } else {
612 let ret: Result<FormatterList, _> =
613 Deserialize::deserialize(v.into_deserializer());
614 ret.map(SelectedFormatter::List)
615 }
616 }
617 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
618 where
619 A: MapAccess<'d>,
620 {
621 let ret: Result<FormatterList, _> =
622 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
623 ret.map(SelectedFormatter::List)
624 }
625 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
626 where
627 A: SeqAccess<'d>,
628 {
629 let ret: Result<FormatterList, _> =
630 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
631 ret.map(SelectedFormatter::List)
632 }
633 }
634 deserializer.deserialize_any(FormatDeserializer)
635 }
636}
637/// Controls which formatter should be used when formatting code.
638#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
639#[serde(rename_all = "snake_case", transparent)]
640pub struct FormatterList(pub SingleOrVec<Formatter>);
641
642impl AsRef<[Formatter]> for FormatterList {
643 fn as_ref(&self) -> &[Formatter] {
644 match &self.0 {
645 SingleOrVec::Single(single) => slice::from_ref(single),
646 SingleOrVec::Vec(v) => v,
647 }
648 }
649}
650
651/// Controls which formatter should be used when formatting code. If there are multiple formatters, they are executed in the order of declaration.
652#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
653#[serde(rename_all = "snake_case")]
654pub enum Formatter {
655 /// Format code using the current language server.
656 LanguageServer { name: Option<String> },
657 /// Format code using Zed's Prettier integration.
658 Prettier,
659 /// Format code using an external command.
660 External {
661 /// The external program to run.
662 command: Arc<str>,
663 /// The arguments to pass to the program.
664 arguments: Option<Arc<[String]>>,
665 },
666 /// Files should be formatted using code actions executed by language servers.
667 CodeActions(HashMap<String, bool>),
668}
669
670/// The settings for indent guides.
671#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
672pub struct IndentGuideSettings {
673 /// Whether to display indent guides in the editor.
674 ///
675 /// Default: true
676 #[serde(default = "default_true")]
677 pub enabled: bool,
678 /// The width of the indent guides in pixels, between 1 and 10.
679 ///
680 /// Default: 1
681 #[serde(default = "line_width")]
682 pub line_width: u32,
683 /// The width of the active indent guide in pixels, between 1 and 10.
684 ///
685 /// Default: 1
686 #[serde(default = "active_line_width")]
687 pub active_line_width: u32,
688 /// Determines how indent guides are colored.
689 ///
690 /// Default: Fixed
691 #[serde(default)]
692 pub coloring: IndentGuideColoring,
693 /// Determines how indent guide backgrounds are colored.
694 ///
695 /// Default: Disabled
696 #[serde(default)]
697 pub background_coloring: IndentGuideBackgroundColoring,
698}
699
700fn line_width() -> u32 {
701 1
702}
703
704fn active_line_width() -> u32 {
705 line_width()
706}
707
708/// Determines how indent guides are colored.
709#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
710#[serde(rename_all = "snake_case")]
711pub enum IndentGuideColoring {
712 /// Do not render any lines for indent guides.
713 Disabled,
714 /// Use the same color for all indentation levels.
715 #[default]
716 Fixed,
717 /// Use a different color for each indentation level.
718 IndentAware,
719}
720
721/// Determines how indent guide backgrounds are colored.
722#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
723#[serde(rename_all = "snake_case")]
724pub enum IndentGuideBackgroundColoring {
725 /// Do not render any background for indent guides.
726 #[default]
727 Disabled,
728 /// Use a different color for each indentation level.
729 IndentAware,
730}
731
732/// The settings for inlay hints.
733#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
734pub struct InlayHintSettings {
735 /// Global switch to toggle hints on and off.
736 ///
737 /// Default: false
738 #[serde(default)]
739 pub enabled: bool,
740 /// Whether type hints should be shown.
741 ///
742 /// Default: true
743 #[serde(default = "default_true")]
744 pub show_type_hints: bool,
745 /// Whether parameter hints should be shown.
746 ///
747 /// Default: true
748 #[serde(default = "default_true")]
749 pub show_parameter_hints: bool,
750 /// Whether other hints should be shown.
751 ///
752 /// Default: true
753 #[serde(default = "default_true")]
754 pub show_other_hints: bool,
755 /// Whether to show a background for inlay hints.
756 ///
757 /// If set to `true`, the background will use the `hint.background` color
758 /// from the current theme.
759 ///
760 /// Default: false
761 #[serde(default)]
762 pub show_background: bool,
763 /// Whether or not to debounce inlay hints updates after buffer edits.
764 ///
765 /// Set to 0 to disable debouncing.
766 ///
767 /// Default: 700
768 #[serde(default = "edit_debounce_ms")]
769 pub edit_debounce_ms: u64,
770 /// Whether or not to debounce inlay hints updates after buffer scrolls.
771 ///
772 /// Set to 0 to disable debouncing.
773 ///
774 /// Default: 50
775 #[serde(default = "scroll_debounce_ms")]
776 pub scroll_debounce_ms: u64,
777}
778
779fn edit_debounce_ms() -> u64 {
780 700
781}
782
783fn scroll_debounce_ms() -> u64 {
784 50
785}
786
787/// The task settings for a particular language.
788#[derive(Debug, Clone, Deserialize, PartialEq, Serialize, JsonSchema)]
789pub struct LanguageTaskConfig {
790 /// Extra task variables to set for a particular language.
791 pub variables: HashMap<String, String>,
792}
793
794impl InlayHintSettings {
795 /// Returns the kinds of inlay hints that are enabled based on the settings.
796 pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
797 let mut kinds = HashSet::default();
798 if self.show_type_hints {
799 kinds.insert(Some(InlayHintKind::Type));
800 }
801 if self.show_parameter_hints {
802 kinds.insert(Some(InlayHintKind::Parameter));
803 }
804 if self.show_other_hints {
805 kinds.insert(None);
806 }
807 kinds
808 }
809}
810
811impl AllLanguageSettings {
812 /// Returns the [`LanguageSettings`] for the language with the specified name.
813 pub fn language<'a>(&'a self, language_name: Option<&LanguageName>) -> &'a LanguageSettings {
814 if let Some(name) = language_name {
815 if let Some(overrides) = self.languages.get(name) {
816 return overrides;
817 }
818 }
819 &self.defaults
820 }
821
822 /// Returns whether inline completions are enabled for the given path.
823 pub fn inline_completions_enabled_for_path(&self, path: &Path) -> bool {
824 !self
825 .inline_completions
826 .disabled_globs
827 .iter()
828 .any(|glob| glob.is_match(path))
829 }
830
831 /// Returns whether inline completions are enabled for the given language and path.
832 pub fn inline_completions_enabled(
833 &self,
834 language: Option<&Arc<Language>>,
835 path: Option<&Path>,
836 ) -> bool {
837 if let Some(path) = path {
838 if !self.inline_completions_enabled_for_path(path) {
839 return false;
840 }
841 }
842
843 self.language(language.map(|l| l.name()).as_ref())
844 .show_inline_completions
845 }
846}
847
848/// The kind of an inlay hint.
849#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
850pub enum InlayHintKind {
851 /// An inlay hint for a type.
852 Type,
853 /// An inlay hint for a parameter.
854 Parameter,
855}
856
857impl InlayHintKind {
858 /// Returns the [`InlayHintKind`] from the given name.
859 ///
860 /// Returns `None` if `name` does not match any of the expected
861 /// string representations.
862 pub fn from_name(name: &str) -> Option<Self> {
863 match name {
864 "type" => Some(InlayHintKind::Type),
865 "parameter" => Some(InlayHintKind::Parameter),
866 _ => None,
867 }
868 }
869
870 /// Returns the name of this [`InlayHintKind`].
871 pub fn name(&self) -> &'static str {
872 match self {
873 InlayHintKind::Type => "type",
874 InlayHintKind::Parameter => "parameter",
875 }
876 }
877}
878
879impl settings::Settings for AllLanguageSettings {
880 const KEY: Option<&'static str> = None;
881
882 type FileContent = AllLanguageSettingsContent;
883
884 fn load(sources: SettingsSources<Self::FileContent>, _: &mut AppContext) -> Result<Self> {
885 let default_value = sources.default;
886
887 // A default is provided for all settings.
888 let mut defaults: LanguageSettings =
889 serde_json::from_value(serde_json::to_value(&default_value.defaults)?)?;
890
891 let mut languages = HashMap::default();
892 for (language_name, settings) in &default_value.languages {
893 let mut language_settings = defaults.clone();
894 merge_settings(&mut language_settings, settings);
895 languages.insert(language_name.clone(), language_settings);
896 }
897
898 let mut copilot_enabled = default_value.features.as_ref().and_then(|f| f.copilot);
899 let mut inline_completion_provider = default_value
900 .features
901 .as_ref()
902 .and_then(|f| f.inline_completion_provider);
903 let mut completion_globs = default_value
904 .inline_completions
905 .as_ref()
906 .and_then(|c| c.disabled_globs.as_ref())
907 .ok_or_else(Self::missing_default)?;
908
909 let mut file_types: HashMap<Arc<str>, GlobSet> = HashMap::default();
910
911 for (language, suffixes) in &default_value.file_types {
912 let mut builder = GlobSetBuilder::new();
913
914 for suffix in suffixes {
915 builder.add(Glob::new(suffix)?);
916 }
917
918 file_types.insert(language.clone(), builder.build()?);
919 }
920
921 for user_settings in sources.customizations() {
922 if let Some(copilot) = user_settings.features.as_ref().and_then(|f| f.copilot) {
923 copilot_enabled = Some(copilot);
924 }
925 if let Some(provider) = user_settings
926 .features
927 .as_ref()
928 .and_then(|f| f.inline_completion_provider)
929 {
930 inline_completion_provider = Some(provider);
931 }
932 if let Some(globs) = user_settings
933 .inline_completions
934 .as_ref()
935 .and_then(|f| f.disabled_globs.as_ref())
936 {
937 completion_globs = globs;
938 }
939
940 // A user's global settings override the default global settings and
941 // all default language-specific settings.
942 merge_settings(&mut defaults, &user_settings.defaults);
943 for language_settings in languages.values_mut() {
944 merge_settings(language_settings, &user_settings.defaults);
945 }
946
947 // A user's language-specific settings override default language-specific settings.
948 for (language_name, user_language_settings) in &user_settings.languages {
949 merge_settings(
950 languages
951 .entry(language_name.clone())
952 .or_insert_with(|| defaults.clone()),
953 user_language_settings,
954 );
955 }
956
957 for (language, suffixes) in &user_settings.file_types {
958 let mut builder = GlobSetBuilder::new();
959
960 let default_value = default_value.file_types.get(&language.clone());
961
962 // Merge the default value with the user's value.
963 if let Some(suffixes) = default_value {
964 for suffix in suffixes {
965 builder.add(Glob::new(suffix)?);
966 }
967 }
968
969 for suffix in suffixes {
970 builder.add(Glob::new(suffix)?);
971 }
972
973 file_types.insert(language.clone(), builder.build()?);
974 }
975 }
976
977 Ok(Self {
978 inline_completions: InlineCompletionSettings {
979 provider: if let Some(provider) = inline_completion_provider {
980 provider
981 } else if copilot_enabled.unwrap_or(true) {
982 InlineCompletionProvider::Copilot
983 } else {
984 InlineCompletionProvider::None
985 },
986 disabled_globs: completion_globs
987 .iter()
988 .filter_map(|g| Some(globset::Glob::new(g).ok()?.compile_matcher()))
989 .collect(),
990 },
991 defaults,
992 languages,
993 file_types,
994 })
995 }
996
997 fn json_schema(
998 generator: &mut schemars::gen::SchemaGenerator,
999 params: &settings::SettingsJsonSchemaParams,
1000 _: &AppContext,
1001 ) -> schemars::schema::RootSchema {
1002 let mut root_schema = generator.root_schema_for::<Self::FileContent>();
1003
1004 // Create a schema for a 'languages overrides' object, associating editor
1005 // settings with specific languages.
1006 assert!(root_schema
1007 .definitions
1008 .contains_key("LanguageSettingsContent"));
1009
1010 let languages_object_schema = SchemaObject {
1011 instance_type: Some(InstanceType::Object.into()),
1012 object: Some(Box::new(ObjectValidation {
1013 properties: params
1014 .language_names
1015 .iter()
1016 .map(|name| {
1017 (
1018 name.clone(),
1019 Schema::new_ref("#/definitions/LanguageSettingsContent".into()),
1020 )
1021 })
1022 .collect(),
1023 ..Default::default()
1024 })),
1025 ..Default::default()
1026 };
1027
1028 root_schema
1029 .definitions
1030 .extend([("Languages".into(), languages_object_schema.into())]);
1031
1032 add_references_to_properties(
1033 &mut root_schema,
1034 &[("languages", "#/definitions/Languages")],
1035 );
1036
1037 root_schema
1038 }
1039}
1040
1041fn merge_settings(settings: &mut LanguageSettings, src: &LanguageSettingsContent) {
1042 fn merge<T>(target: &mut T, value: Option<T>) {
1043 if let Some(value) = value {
1044 *target = value;
1045 }
1046 }
1047
1048 merge(&mut settings.tab_size, src.tab_size);
1049 settings.tab_size = settings
1050 .tab_size
1051 .clamp(NonZeroU32::new(1).unwrap(), NonZeroU32::new(16).unwrap());
1052
1053 merge(&mut settings.hard_tabs, src.hard_tabs);
1054 merge(&mut settings.soft_wrap, src.soft_wrap);
1055 merge(&mut settings.use_autoclose, src.use_autoclose);
1056 merge(&mut settings.use_auto_surround, src.use_auto_surround);
1057 merge(&mut settings.use_on_type_format, src.use_on_type_format);
1058 merge(
1059 &mut settings.always_treat_brackets_as_autoclosed,
1060 src.always_treat_brackets_as_autoclosed,
1061 );
1062 merge(&mut settings.show_wrap_guides, src.show_wrap_guides);
1063 merge(&mut settings.wrap_guides, src.wrap_guides.clone());
1064 merge(&mut settings.indent_guides, src.indent_guides);
1065 merge(
1066 &mut settings.code_actions_on_format,
1067 src.code_actions_on_format.clone(),
1068 );
1069 merge(&mut settings.linked_edits, src.linked_edits);
1070 merge(&mut settings.tasks, src.tasks.clone());
1071
1072 merge(
1073 &mut settings.preferred_line_length,
1074 src.preferred_line_length,
1075 );
1076 merge(&mut settings.formatter, src.formatter.clone());
1077 merge(&mut settings.prettier, src.prettier.clone());
1078 merge(&mut settings.format_on_save, src.format_on_save.clone());
1079 merge(
1080 &mut settings.remove_trailing_whitespace_on_save,
1081 src.remove_trailing_whitespace_on_save,
1082 );
1083 merge(
1084 &mut settings.ensure_final_newline_on_save,
1085 src.ensure_final_newline_on_save,
1086 );
1087 merge(
1088 &mut settings.enable_language_server,
1089 src.enable_language_server,
1090 );
1091 merge(&mut settings.language_servers, src.language_servers.clone());
1092 merge(
1093 &mut settings.show_inline_completions,
1094 src.show_inline_completions,
1095 );
1096 merge(&mut settings.show_whitespaces, src.show_whitespaces);
1097 merge(
1098 &mut settings.extend_comment_on_newline,
1099 src.extend_comment_on_newline,
1100 );
1101 merge(&mut settings.inlay_hints, src.inlay_hints);
1102}
1103
1104/// Allows to enable/disable formatting with Prettier
1105/// and configure default Prettier, used when no project-level Prettier installation is found.
1106/// Prettier formatting is disabled by default.
1107#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1108pub struct PrettierSettings {
1109 /// Enables or disables formatting with Prettier for a given language.
1110 #[serde(default)]
1111 pub allowed: bool,
1112
1113 /// Forces Prettier integration to use a specific parser name when formatting files with the language.
1114 #[serde(default)]
1115 pub parser: Option<String>,
1116
1117 /// Forces Prettier integration to use specific plugins when formatting files with the language.
1118 /// The default Prettier will be installed with these plugins.
1119 #[serde(default)]
1120 pub plugins: HashSet<String>,
1121
1122 /// Default Prettier options, in the format as in package.json section for Prettier.
1123 /// If project installs Prettier via its package.json, these options will be ignored.
1124 #[serde(flatten)]
1125 pub options: HashMap<String, serde_json::Value>,
1126}
1127
1128#[cfg(test)]
1129mod tests {
1130 use super::*;
1131
1132 #[test]
1133 fn test_formatter_deserialization() {
1134 let raw_auto = "{\"formatter\": \"auto\"}";
1135 let settings: LanguageSettingsContent = serde_json::from_str(raw_auto).unwrap();
1136 assert_eq!(settings.formatter, Some(SelectedFormatter::Auto));
1137 let raw = "{\"formatter\": \"language_server\"}";
1138 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1139 assert_eq!(
1140 settings.formatter,
1141 Some(SelectedFormatter::List(FormatterList(
1142 Formatter::LanguageServer { name: None }.into()
1143 )))
1144 );
1145 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}]}";
1146 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1147 assert_eq!(
1148 settings.formatter,
1149 Some(SelectedFormatter::List(FormatterList(
1150 vec![Formatter::LanguageServer { name: None }].into()
1151 )))
1152 );
1153 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}, \"prettier\"]}";
1154 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1155 assert_eq!(
1156 settings.formatter,
1157 Some(SelectedFormatter::List(FormatterList(
1158 vec![
1159 Formatter::LanguageServer { name: None },
1160 Formatter::Prettier
1161 ]
1162 .into()
1163 )))
1164 );
1165 }
1166
1167 #[test]
1168 fn test_formatter_deserialization_invalid() {
1169 let raw_auto = "{\"formatter\": {}}";
1170 let result: Result<LanguageSettingsContent, _> = serde_json::from_str(raw_auto);
1171 assert!(result.is_err());
1172 }
1173
1174 #[test]
1175 pub fn test_resolve_language_servers() {
1176 fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
1177 names
1178 .iter()
1179 .copied()
1180 .map(|name| LanguageServerName(name.to_string().into()))
1181 .collect::<Vec<_>>()
1182 }
1183
1184 let available_language_servers = language_server_names(&[
1185 "typescript-language-server",
1186 "biome",
1187 "deno",
1188 "eslint",
1189 "tailwind",
1190 ]);
1191
1192 // A value of just `["..."]` is the same as taking all of the available language servers.
1193 assert_eq!(
1194 LanguageSettings::resolve_language_servers(
1195 &[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
1196 &available_language_servers,
1197 ),
1198 available_language_servers
1199 );
1200
1201 // Referencing one of the available language servers will change its order.
1202 assert_eq!(
1203 LanguageSettings::resolve_language_servers(
1204 &[
1205 "biome".into(),
1206 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
1207 "deno".into()
1208 ],
1209 &available_language_servers
1210 ),
1211 language_server_names(&[
1212 "biome",
1213 "typescript-language-server",
1214 "eslint",
1215 "tailwind",
1216 "deno",
1217 ])
1218 );
1219
1220 // Negating an available language server removes it from the list.
1221 assert_eq!(
1222 LanguageSettings::resolve_language_servers(
1223 &[
1224 "deno".into(),
1225 "!typescript-language-server".into(),
1226 "!biome".into(),
1227 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1228 ],
1229 &available_language_servers
1230 ),
1231 language_server_names(&["deno", "eslint", "tailwind"])
1232 );
1233
1234 // Adding a language server not in the list of available language servers adds it to the list.
1235 assert_eq!(
1236 LanguageSettings::resolve_language_servers(
1237 &[
1238 "my-cool-language-server".into(),
1239 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1240 ],
1241 &available_language_servers
1242 ),
1243 language_server_names(&[
1244 "my-cool-language-server",
1245 "typescript-language-server",
1246 "biome",
1247 "deno",
1248 "eslint",
1249 "tailwind",
1250 ])
1251 );
1252 }
1253}