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