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