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