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