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