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