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::{App, Modifiers};
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 App) {
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 App,
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 App,
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 edit prediction settings.
63 pub edit_predictions: EditPredictionSettings,
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 automatically close JSX tags.
104 pub jsx_tag_auto_close: JsxTagAutoCloseSettings,
105 /// Whether to use language servers to provide code intelligence.
106 pub enable_language_server: bool,
107 /// The list of language servers to use (or disable) for this language.
108 ///
109 /// This array should consist of language server IDs, as well as the following
110 /// special tokens:
111 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
112 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
113 pub language_servers: Vec<String>,
114 /// Controls where the `editor::Rewrap` action is allowed for this language.
115 ///
116 /// Note: This setting has no effect in Vim mode, as rewrap is already
117 /// allowed everywhere.
118 pub allow_rewrap: RewrapBehavior,
119 /// Controls whether edit predictions are shown immediately (true)
120 /// or manually by triggering `editor::ShowEditPrediction` (false).
121 pub show_edit_predictions: bool,
122 /// Controls whether edit predictions are shown in the given language
123 /// scopes.
124 pub edit_predictions_disabled_in: Vec<String>,
125 /// Whether to show tabs and spaces in the editor.
126 pub show_whitespaces: ShowWhitespaceSetting,
127 /// Whether to start a new line with a comment when a previous line is a comment as well.
128 pub extend_comment_on_newline: bool,
129 /// Inlay hint related settings.
130 pub inlay_hints: InlayHintSettings,
131 /// Whether to automatically close brackets.
132 pub use_autoclose: bool,
133 /// Whether to automatically surround text with brackets.
134 pub use_auto_surround: bool,
135 /// Whether to use additional LSP queries to format (and amend) the code after
136 /// every "trigger" symbol input, defined by LSP server capabilities.
137 pub use_on_type_format: bool,
138 /// Whether indentation of pasted content should be adjusted based on the context.
139 pub auto_indent_on_paste: bool,
140 /// Controls how the editor handles the autoclosed characters.
141 pub always_treat_brackets_as_autoclosed: bool,
142 /// Which code actions to run on save
143 pub code_actions_on_format: HashMap<String, bool>,
144 /// Whether to perform linked edits
145 pub linked_edits: bool,
146 /// Task configuration for this language.
147 pub tasks: LanguageTaskConfig,
148 /// Whether to pop the completions menu while typing in an editor without
149 /// explicitly requesting it.
150 pub show_completions_on_input: bool,
151 /// Whether to display inline and alongside documentation for items in the
152 /// completions menu.
153 pub show_completion_documentation: bool,
154 /// Completion settings for this language.
155 pub completions: CompletionSettings,
156}
157
158impl LanguageSettings {
159 /// A token representing the rest of the available language servers.
160 const REST_OF_LANGUAGE_SERVERS: &'static str = "...";
161
162 /// Returns the customized list of language servers from the list of
163 /// available language servers.
164 pub fn customized_language_servers(
165 &self,
166 available_language_servers: &[LanguageServerName],
167 ) -> Vec<LanguageServerName> {
168 Self::resolve_language_servers(&self.language_servers, available_language_servers)
169 }
170
171 pub(crate) fn resolve_language_servers(
172 configured_language_servers: &[String],
173 available_language_servers: &[LanguageServerName],
174 ) -> Vec<LanguageServerName> {
175 let (disabled_language_servers, enabled_language_servers): (
176 Vec<LanguageServerName>,
177 Vec<LanguageServerName>,
178 ) = configured_language_servers.iter().partition_map(
179 |language_server| match language_server.strip_prefix('!') {
180 Some(disabled) => Either::Left(LanguageServerName(disabled.to_string().into())),
181 None => Either::Right(LanguageServerName(language_server.clone().into())),
182 },
183 );
184
185 let rest = available_language_servers
186 .iter()
187 .filter(|&available_language_server| {
188 !disabled_language_servers.contains(&available_language_server)
189 && !enabled_language_servers.contains(&available_language_server)
190 })
191 .cloned()
192 .collect::<Vec<_>>();
193
194 enabled_language_servers
195 .into_iter()
196 .flat_map(|language_server| {
197 if language_server.0.as_ref() == Self::REST_OF_LANGUAGE_SERVERS {
198 rest.clone()
199 } else {
200 vec![language_server.clone()]
201 }
202 })
203 .collect::<Vec<_>>()
204 }
205}
206
207/// The provider that supplies edit predictions.
208#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
209#[serde(rename_all = "snake_case")]
210pub enum EditPredictionProvider {
211 None,
212 #[default]
213 Copilot,
214 Supermaven,
215 Zed,
216}
217
218impl EditPredictionProvider {
219 pub fn is_zed(&self) -> bool {
220 match self {
221 EditPredictionProvider::Zed => true,
222 EditPredictionProvider::None
223 | EditPredictionProvider::Copilot
224 | EditPredictionProvider::Supermaven => false,
225 }
226 }
227}
228
229/// The settings for edit predictions, such as [GitHub Copilot](https://github.com/features/copilot)
230/// or [Supermaven](https://supermaven.com).
231#[derive(Clone, Debug, Default)]
232pub struct EditPredictionSettings {
233 /// The provider that supplies edit predictions.
234 pub provider: EditPredictionProvider,
235 /// A list of globs representing files that edit predictions should be disabled for.
236 /// This list adds to a pre-existing, sensible default set of globs.
237 /// Any additional ones you add are combined with them.
238 pub disabled_globs: Vec<DisabledGlob>,
239 /// Configures how edit predictions are displayed in the buffer.
240 pub mode: EditPredictionsMode,
241 /// Settings specific to GitHub Copilot.
242 pub copilot: CopilotSettings,
243 /// Whether edit predictions are enabled in the assistant panel.
244 /// This setting has no effect if globally disabled.
245 pub enabled_in_assistant: bool,
246}
247
248impl EditPredictionSettings {
249 /// Returns whether edit predictions are enabled for the given path.
250 pub fn enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool {
251 !self.disabled_globs.iter().any(|glob| {
252 if glob.is_absolute {
253 file.as_local()
254 .map_or(false, |local| glob.matcher.is_match(local.abs_path(cx)))
255 } else {
256 glob.matcher.is_match(file.path())
257 }
258 })
259 }
260}
261
262#[derive(Clone, Debug)]
263pub struct DisabledGlob {
264 matcher: GlobMatcher,
265 is_absolute: bool,
266}
267
268/// The mode in which edit predictions should be displayed.
269#[derive(Copy, Clone, Debug, Default, Eq, PartialEq, Serialize, Deserialize, JsonSchema)]
270#[serde(rename_all = "snake_case")]
271pub enum EditPredictionsMode {
272 /// If provider supports it, display inline when holding modifier key (e.g., alt).
273 /// Otherwise, eager preview is used.
274 #[serde(alias = "auto")]
275 Subtle,
276 /// Display inline when there are no language server completions available.
277 #[default]
278 #[serde(alias = "eager_preview")]
279 Eager,
280}
281
282#[derive(Clone, Debug, Default)]
283pub struct CopilotSettings {
284 /// HTTP/HTTPS proxy to use for Copilot.
285 pub proxy: Option<String>,
286 /// Disable certificate verification for proxy (not recommended).
287 pub proxy_no_verify: Option<bool>,
288}
289
290/// The settings for all languages.
291#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
292pub struct AllLanguageSettingsContent {
293 /// The settings for enabling/disabling features.
294 #[serde(default)]
295 pub features: Option<FeaturesContent>,
296 /// The edit prediction settings.
297 #[serde(default)]
298 pub edit_predictions: Option<EditPredictionSettingsContent>,
299 /// The default language settings.
300 #[serde(flatten)]
301 pub defaults: LanguageSettingsContent,
302 /// The settings for individual languages.
303 #[serde(default)]
304 pub languages: HashMap<LanguageName, LanguageSettingsContent>,
305 /// Settings for associating file extensions and filenames
306 /// with languages.
307 #[serde(default)]
308 pub file_types: HashMap<Arc<str>, Vec<String>>,
309}
310
311/// Controls how completions are processed for this language.
312#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
313#[serde(rename_all = "snake_case")]
314pub struct CompletionSettings {
315 /// Controls how words are completed.
316 /// For large documents, not all words may be fetched for completion.
317 ///
318 /// Default: `fallback`
319 #[serde(default = "default_words_completion_mode")]
320 pub words: WordsCompletionMode,
321 /// Whether to fetch LSP completions or not.
322 ///
323 /// Default: true
324 #[serde(default = "default_true")]
325 pub lsp: bool,
326 /// When fetching LSP completions, determines how long to wait for a response of a particular server.
327 /// When set to 0, waits indefinitely.
328 ///
329 /// Default: 500
330 #[serde(default = "lsp_fetch_timeout_ms")]
331 pub lsp_fetch_timeout_ms: u64,
332}
333
334/// Controls how document's words are completed.
335#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
336#[serde(rename_all = "snake_case")]
337pub enum WordsCompletionMode {
338 /// Always fetch document's words for completions.
339 Enabled,
340 /// Only if LSP response errors/times out/is empty,
341 /// use document's words to show completions.
342 Fallback,
343 /// Never fetch or complete document's words for completions.
344 Disabled,
345}
346
347fn default_words_completion_mode() -> WordsCompletionMode {
348 WordsCompletionMode::Fallback
349}
350
351fn lsp_fetch_timeout_ms() -> u64 {
352 500
353}
354
355/// The settings for a particular language.
356#[derive(Debug, Clone, Default, PartialEq, Serialize, Deserialize, JsonSchema)]
357pub struct LanguageSettingsContent {
358 /// How many columns a tab should occupy.
359 ///
360 /// Default: 4
361 #[serde(default)]
362 pub tab_size: Option<NonZeroU32>,
363 /// Whether to indent lines using tab characters, as opposed to multiple
364 /// spaces.
365 ///
366 /// Default: false
367 #[serde(default)]
368 pub hard_tabs: Option<bool>,
369 /// How to soft-wrap long lines of text.
370 ///
371 /// Default: none
372 #[serde(default)]
373 pub soft_wrap: Option<SoftWrap>,
374 /// The column at which to soft-wrap lines, for buffers where soft-wrap
375 /// is enabled.
376 ///
377 /// Default: 80
378 #[serde(default)]
379 pub preferred_line_length: Option<u32>,
380 /// Whether to show wrap guides in the editor. Setting this to true will
381 /// show a guide at the 'preferred_line_length' value if softwrap is set to
382 /// 'preferred_line_length', and will show any additional guides as specified
383 /// by the 'wrap_guides' setting.
384 ///
385 /// Default: true
386 #[serde(default)]
387 pub show_wrap_guides: Option<bool>,
388 /// Character counts at which to show wrap guides in the editor.
389 ///
390 /// Default: []
391 #[serde(default)]
392 pub wrap_guides: Option<Vec<usize>>,
393 /// Indent guide related settings.
394 #[serde(default)]
395 pub indent_guides: Option<IndentGuideSettings>,
396 /// Whether or not to perform a buffer format before saving.
397 ///
398 /// Default: on
399 #[serde(default)]
400 pub format_on_save: Option<FormatOnSave>,
401 /// Whether or not to remove any trailing whitespace from lines of a buffer
402 /// before saving it.
403 ///
404 /// Default: true
405 #[serde(default)]
406 pub remove_trailing_whitespace_on_save: Option<bool>,
407 /// Whether or not to ensure there's a single newline at the end of a buffer
408 /// when saving it.
409 ///
410 /// Default: true
411 #[serde(default)]
412 pub ensure_final_newline_on_save: Option<bool>,
413 /// How to perform a buffer format.
414 ///
415 /// Default: auto
416 #[serde(default)]
417 pub formatter: Option<SelectedFormatter>,
418 /// Zed's Prettier integration settings.
419 /// Allows to enable/disable formatting with Prettier
420 /// and configure default Prettier, used when no project-level Prettier installation is found.
421 ///
422 /// Default: off
423 #[serde(default)]
424 pub prettier: Option<PrettierSettings>,
425 /// Whether to automatically close JSX tags.
426 #[serde(default)]
427 pub jsx_tag_auto_close: Option<JsxTagAutoCloseSettings>,
428 /// Whether to use language servers to provide code intelligence.
429 ///
430 /// Default: true
431 #[serde(default)]
432 pub enable_language_server: Option<bool>,
433 /// The list of language servers to use (or disable) for this language.
434 ///
435 /// This array should consist of language server IDs, as well as the following
436 /// special tokens:
437 /// - `"!<language_server_id>"` - A language server ID prefixed with a `!` will be disabled.
438 /// - `"..."` - A placeholder to refer to the **rest** of the registered language servers for this language.
439 ///
440 /// Default: ["..."]
441 #[serde(default)]
442 pub language_servers: Option<Vec<String>>,
443 /// Controls where the `editor::Rewrap` action is allowed for this language.
444 ///
445 /// Note: This setting has no effect in Vim mode, as rewrap is already
446 /// allowed everywhere.
447 ///
448 /// Default: "in_comments"
449 #[serde(default)]
450 pub allow_rewrap: Option<RewrapBehavior>,
451 /// Controls whether edit predictions are shown immediately (true)
452 /// or manually by triggering `editor::ShowEditPrediction` (false).
453 ///
454 /// Default: true
455 #[serde(default)]
456 pub show_edit_predictions: Option<bool>,
457 /// Controls whether edit predictions are shown in the given language
458 /// scopes.
459 ///
460 /// Example: ["string", "comment"]
461 ///
462 /// Default: []
463 #[serde(default)]
464 pub edit_predictions_disabled_in: Option<Vec<String>>,
465 /// Whether to show tabs and spaces in the editor.
466 #[serde(default)]
467 pub show_whitespaces: Option<ShowWhitespaceSetting>,
468 /// Whether to start a new line with a comment when a previous line is a comment as well.
469 ///
470 /// Default: true
471 #[serde(default)]
472 pub extend_comment_on_newline: Option<bool>,
473 /// Inlay hint related settings.
474 #[serde(default)]
475 pub inlay_hints: Option<InlayHintSettings>,
476 /// Whether to automatically type closing characters for you. For example,
477 /// when you type (, Zed will automatically add a closing ) at the correct position.
478 ///
479 /// Default: true
480 pub use_autoclose: Option<bool>,
481 /// Whether to automatically surround text with characters for you. For example,
482 /// when you select text and type (, Zed will automatically surround text with ().
483 ///
484 /// Default: true
485 pub use_auto_surround: Option<bool>,
486 /// Controls how the editor handles the autoclosed characters.
487 /// When set to `false`(default), skipping over and auto-removing of the closing characters
488 /// happen only for auto-inserted characters.
489 /// Otherwise(when `true`), the closing characters are always skipped over and auto-removed
490 /// no matter how they were inserted.
491 ///
492 /// Default: false
493 pub always_treat_brackets_as_autoclosed: Option<bool>,
494 /// Whether to use additional LSP queries to format (and amend) the code after
495 /// every "trigger" symbol input, defined by LSP server capabilities.
496 ///
497 /// Default: true
498 pub use_on_type_format: Option<bool>,
499 /// Which code actions to run on save after the formatter.
500 /// These are not run if formatting is off.
501 ///
502 /// Default: {} (or {"source.organizeImports": true} for Go).
503 pub code_actions_on_format: Option<HashMap<String, bool>>,
504 /// Whether to perform linked edits of associated ranges, if the language server supports it.
505 /// For example, when editing opening <html> tag, the contents of the closing </html> tag will be edited as well.
506 ///
507 /// Default: true
508 pub linked_edits: Option<bool>,
509 /// Whether indentation of pasted content should be adjusted based on the context.
510 ///
511 /// Default: true
512 pub auto_indent_on_paste: Option<bool>,
513 /// Task configuration for this language.
514 ///
515 /// Default: {}
516 pub tasks: Option<LanguageTaskConfig>,
517 /// Whether to pop the completions menu while typing in an editor without
518 /// explicitly requesting it.
519 ///
520 /// Default: true
521 pub show_completions_on_input: Option<bool>,
522 /// Whether to display inline and alongside documentation for items in the
523 /// completions menu.
524 ///
525 /// Default: true
526 pub show_completion_documentation: Option<bool>,
527 /// Controls how completions are processed for this language.
528 pub completions: Option<CompletionSettings>,
529}
530
531/// The behavior of `editor::Rewrap`.
532#[derive(Debug, PartialEq, Clone, Copy, Default, Serialize, Deserialize, JsonSchema)]
533#[serde(rename_all = "snake_case")]
534pub enum RewrapBehavior {
535 /// Only rewrap within comments.
536 #[default]
537 InComments,
538 /// Only rewrap within the current selection(s).
539 InSelections,
540 /// Allow rewrapping anywhere.
541 Anywhere,
542}
543
544/// The contents of the edit prediction settings.
545#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
546pub struct EditPredictionSettingsContent {
547 /// A list of globs representing files that edit predictions should be disabled for.
548 /// This list adds to a pre-existing, sensible default set of globs.
549 /// Any additional ones you add are combined with them.
550 #[serde(default)]
551 pub disabled_globs: Option<Vec<String>>,
552 /// The mode used to display edit predictions in the buffer.
553 /// Provider support required.
554 #[serde(default)]
555 pub mode: EditPredictionsMode,
556 /// Settings specific to GitHub Copilot.
557 #[serde(default)]
558 pub copilot: CopilotSettingsContent,
559 /// Whether edit predictions are enabled in the assistant prompt editor.
560 /// This has no effect if globally disabled.
561 #[serde(default = "default_true")]
562 pub enabled_in_assistant: bool,
563}
564
565#[derive(Clone, Debug, Default, Serialize, Deserialize, JsonSchema, PartialEq)]
566pub struct CopilotSettingsContent {
567 /// HTTP/HTTPS proxy to use for Copilot.
568 ///
569 /// Default: none
570 #[serde(default)]
571 pub proxy: Option<String>,
572 /// Disable certificate verification for the proxy (not recommended).
573 ///
574 /// Default: false
575 #[serde(default)]
576 pub proxy_no_verify: Option<bool>,
577}
578
579/// The settings for enabling/disabling features.
580#[derive(Debug, Clone, PartialEq, Default, Serialize, Deserialize, JsonSchema)]
581#[serde(rename_all = "snake_case")]
582pub struct FeaturesContent {
583 /// Whether the GitHub Copilot feature is enabled.
584 pub copilot: Option<bool>,
585 /// Determines which edit prediction provider to use.
586 pub edit_prediction_provider: Option<EditPredictionProvider>,
587}
588
589/// Controls the soft-wrapping behavior in the editor.
590#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
591#[serde(rename_all = "snake_case")]
592pub enum SoftWrap {
593 /// Prefer a single line generally, unless an overly long line is encountered.
594 None,
595 /// Deprecated: use None instead. Left to avoid breaking existing users' configs.
596 /// Prefer a single line generally, unless an overly long line is encountered.
597 PreferLine,
598 /// Soft wrap lines that exceed the editor width.
599 EditorWidth,
600 /// Soft wrap lines at the preferred line length.
601 PreferredLineLength,
602 /// Soft wrap line at the preferred line length or the editor width (whichever is smaller).
603 Bounded,
604}
605
606/// Controls the behavior of formatting files when they are saved.
607#[derive(Debug, Clone, PartialEq, Eq)]
608pub enum FormatOnSave {
609 /// Files should be formatted on save.
610 On,
611 /// Files should not be formatted on save.
612 Off,
613 List(FormatterList),
614}
615
616impl JsonSchema for FormatOnSave {
617 fn schema_name() -> String {
618 "OnSaveFormatter".into()
619 }
620
621 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
622 let mut schema = SchemaObject::default();
623 let formatter_schema = Formatter::json_schema(generator);
624 schema.instance_type = Some(
625 vec![
626 InstanceType::Object,
627 InstanceType::String,
628 InstanceType::Array,
629 ]
630 .into(),
631 );
632
633 let valid_raw_values = SchemaObject {
634 enum_values: Some(vec![
635 Value::String("on".into()),
636 Value::String("off".into()),
637 Value::String("prettier".into()),
638 Value::String("language_server".into()),
639 ]),
640 ..Default::default()
641 };
642 let mut nested_values = SchemaObject::default();
643
644 nested_values.array().items = Some(formatter_schema.clone().into());
645
646 schema.subschemas().any_of = Some(vec![
647 nested_values.into(),
648 valid_raw_values.into(),
649 formatter_schema,
650 ]);
651 schema.into()
652 }
653}
654
655impl Serialize for FormatOnSave {
656 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
657 where
658 S: serde::Serializer,
659 {
660 match self {
661 Self::On => serializer.serialize_str("on"),
662 Self::Off => serializer.serialize_str("off"),
663 Self::List(list) => list.serialize(serializer),
664 }
665 }
666}
667
668impl<'de> Deserialize<'de> for FormatOnSave {
669 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
670 where
671 D: Deserializer<'de>,
672 {
673 struct FormatDeserializer;
674
675 impl<'d> Visitor<'d> for FormatDeserializer {
676 type Value = FormatOnSave;
677
678 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
679 formatter.write_str("a valid on-save formatter kind")
680 }
681 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
682 where
683 E: serde::de::Error,
684 {
685 if v == "on" {
686 Ok(Self::Value::On)
687 } else if v == "off" {
688 Ok(Self::Value::Off)
689 } else if v == "language_server" {
690 Ok(Self::Value::List(FormatterList(
691 Formatter::LanguageServer { name: None }.into(),
692 )))
693 } else {
694 let ret: Result<FormatterList, _> =
695 Deserialize::deserialize(v.into_deserializer());
696 ret.map(Self::Value::List)
697 }
698 }
699 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
700 where
701 A: MapAccess<'d>,
702 {
703 let ret: Result<FormatterList, _> =
704 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
705 ret.map(Self::Value::List)
706 }
707 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
708 where
709 A: SeqAccess<'d>,
710 {
711 let ret: Result<FormatterList, _> =
712 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
713 ret.map(Self::Value::List)
714 }
715 }
716 deserializer.deserialize_any(FormatDeserializer)
717 }
718}
719
720/// Controls how whitespace should be displayedin the editor.
721#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
722#[serde(rename_all = "snake_case")]
723pub enum ShowWhitespaceSetting {
724 /// Draw whitespace only for the selected text.
725 Selection,
726 /// Do not draw any tabs or spaces.
727 None,
728 /// Draw all invisible symbols.
729 All,
730 /// Draw whitespaces at boundaries only.
731 ///
732 /// For a whitespace to be on a boundary, any of the following conditions need to be met:
733 /// - It is a tab
734 /// - It is adjacent to an edge (start or end)
735 /// - It is adjacent to a whitespace (left or right)
736 Boundary,
737}
738
739/// Controls which formatter should be used when formatting code.
740#[derive(Clone, Debug, Default, PartialEq, Eq)]
741pub enum SelectedFormatter {
742 /// Format files using Zed's Prettier integration (if applicable),
743 /// or falling back to formatting via language server.
744 #[default]
745 Auto,
746 List(FormatterList),
747}
748
749impl JsonSchema for SelectedFormatter {
750 fn schema_name() -> String {
751 "Formatter".into()
752 }
753
754 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
755 let mut schema = SchemaObject::default();
756 let formatter_schema = Formatter::json_schema(generator);
757 schema.instance_type = Some(
758 vec![
759 InstanceType::Object,
760 InstanceType::String,
761 InstanceType::Array,
762 ]
763 .into(),
764 );
765
766 let valid_raw_values = SchemaObject {
767 enum_values: Some(vec![
768 Value::String("auto".into()),
769 Value::String("prettier".into()),
770 Value::String("language_server".into()),
771 ]),
772 ..Default::default()
773 };
774
775 let mut nested_values = SchemaObject::default();
776
777 nested_values.array().items = Some(formatter_schema.clone().into());
778
779 schema.subschemas().any_of = Some(vec![
780 nested_values.into(),
781 valid_raw_values.into(),
782 formatter_schema,
783 ]);
784 schema.into()
785 }
786}
787
788impl Serialize for SelectedFormatter {
789 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
790 where
791 S: serde::Serializer,
792 {
793 match self {
794 SelectedFormatter::Auto => serializer.serialize_str("auto"),
795 SelectedFormatter::List(list) => list.serialize(serializer),
796 }
797 }
798}
799impl<'de> Deserialize<'de> for SelectedFormatter {
800 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
801 where
802 D: Deserializer<'de>,
803 {
804 struct FormatDeserializer;
805
806 impl<'d> Visitor<'d> for FormatDeserializer {
807 type Value = SelectedFormatter;
808
809 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
810 formatter.write_str("a valid formatter kind")
811 }
812 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
813 where
814 E: serde::de::Error,
815 {
816 if v == "auto" {
817 Ok(Self::Value::Auto)
818 } else if v == "language_server" {
819 Ok(Self::Value::List(FormatterList(
820 Formatter::LanguageServer { name: None }.into(),
821 )))
822 } else {
823 let ret: Result<FormatterList, _> =
824 Deserialize::deserialize(v.into_deserializer());
825 ret.map(SelectedFormatter::List)
826 }
827 }
828 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
829 where
830 A: MapAccess<'d>,
831 {
832 let ret: Result<FormatterList, _> =
833 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
834 ret.map(SelectedFormatter::List)
835 }
836 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
837 where
838 A: SeqAccess<'d>,
839 {
840 let ret: Result<FormatterList, _> =
841 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
842 ret.map(SelectedFormatter::List)
843 }
844 }
845 deserializer.deserialize_any(FormatDeserializer)
846 }
847}
848/// Controls which formatter should be used when formatting code.
849#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
850#[serde(rename_all = "snake_case", transparent)]
851pub struct FormatterList(pub SingleOrVec<Formatter>);
852
853impl AsRef<[Formatter]> for FormatterList {
854 fn as_ref(&self) -> &[Formatter] {
855 match &self.0 {
856 SingleOrVec::Single(single) => slice::from_ref(single),
857 SingleOrVec::Vec(v) => v,
858 }
859 }
860}
861
862/// Controls which formatter should be used when formatting code. If there are multiple formatters, they are executed in the order of declaration.
863#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
864#[serde(rename_all = "snake_case")]
865pub enum Formatter {
866 /// Format code using the current language server.
867 LanguageServer { name: Option<String> },
868 /// Format code using Zed's Prettier integration.
869 Prettier,
870 /// Format code using an external command.
871 External {
872 /// The external program to run.
873 command: Arc<str>,
874 /// The arguments to pass to the program.
875 arguments: Option<Arc<[String]>>,
876 },
877 /// Files should be formatted using code actions executed by language servers.
878 CodeActions(HashMap<String, bool>),
879}
880
881/// The settings for indent guides.
882#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
883pub struct IndentGuideSettings {
884 /// Whether to display indent guides in the editor.
885 ///
886 /// Default: true
887 #[serde(default = "default_true")]
888 pub enabled: bool,
889 /// The width of the indent guides in pixels, between 1 and 10.
890 ///
891 /// Default: 1
892 #[serde(default = "line_width")]
893 pub line_width: u32,
894 /// The width of the active indent guide in pixels, between 1 and 10.
895 ///
896 /// Default: 1
897 #[serde(default = "active_line_width")]
898 pub active_line_width: u32,
899 /// Determines how indent guides are colored.
900 ///
901 /// Default: Fixed
902 #[serde(default)]
903 pub coloring: IndentGuideColoring,
904 /// Determines how indent guide backgrounds are colored.
905 ///
906 /// Default: Disabled
907 #[serde(default)]
908 pub background_coloring: IndentGuideBackgroundColoring,
909}
910
911fn line_width() -> u32 {
912 1
913}
914
915fn active_line_width() -> u32 {
916 line_width()
917}
918
919/// Determines how indent guides are colored.
920#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
921#[serde(rename_all = "snake_case")]
922pub enum IndentGuideColoring {
923 /// Do not render any lines for indent guides.
924 Disabled,
925 /// Use the same color for all indentation levels.
926 #[default]
927 Fixed,
928 /// Use a different color for each indentation level.
929 IndentAware,
930}
931
932/// Determines how indent guide backgrounds are colored.
933#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
934#[serde(rename_all = "snake_case")]
935pub enum IndentGuideBackgroundColoring {
936 /// Do not render any background for indent guides.
937 #[default]
938 Disabled,
939 /// Use a different color for each indentation level.
940 IndentAware,
941}
942
943/// The settings for inlay hints.
944#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
945pub struct InlayHintSettings {
946 /// Global switch to toggle hints on and off.
947 ///
948 /// Default: false
949 #[serde(default)]
950 pub enabled: bool,
951 /// Whether type hints should be shown.
952 ///
953 /// Default: true
954 #[serde(default = "default_true")]
955 pub show_type_hints: bool,
956 /// Whether parameter hints should be shown.
957 ///
958 /// Default: true
959 #[serde(default = "default_true")]
960 pub show_parameter_hints: bool,
961 /// Whether other hints should be shown.
962 ///
963 /// Default: true
964 #[serde(default = "default_true")]
965 pub show_other_hints: bool,
966 /// Whether to show a background for inlay hints.
967 ///
968 /// If set to `true`, the background will use the `hint.background` color
969 /// from the current theme.
970 ///
971 /// Default: false
972 #[serde(default)]
973 pub show_background: bool,
974 /// Whether or not to debounce inlay hints updates after buffer edits.
975 ///
976 /// Set to 0 to disable debouncing.
977 ///
978 /// Default: 700
979 #[serde(default = "edit_debounce_ms")]
980 pub edit_debounce_ms: u64,
981 /// Whether or not to debounce inlay hints updates after buffer scrolls.
982 ///
983 /// Set to 0 to disable debouncing.
984 ///
985 /// Default: 50
986 #[serde(default = "scroll_debounce_ms")]
987 pub scroll_debounce_ms: u64,
988 /// Toggles inlay hints (hides or shows) when the user presses the modifiers specified.
989 /// If only a subset of the modifiers specified is pressed, hints are not toggled.
990 /// If no modifiers are specified, this is equivalent to `None`.
991 ///
992 /// Default: None
993 #[serde(default)]
994 pub toggle_on_modifiers_press: Option<Modifiers>,
995}
996
997fn edit_debounce_ms() -> u64 {
998 700
999}
1000
1001fn scroll_debounce_ms() -> u64 {
1002 50
1003}
1004
1005/// The task settings for a particular language.
1006#[derive(Debug, Clone, Deserialize, PartialEq, Serialize, JsonSchema)]
1007pub struct LanguageTaskConfig {
1008 /// Extra task variables to set for a particular language.
1009 pub variables: HashMap<String, String>,
1010}
1011
1012impl InlayHintSettings {
1013 /// Returns the kinds of inlay hints that are enabled based on the settings.
1014 pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
1015 let mut kinds = HashSet::default();
1016 if self.show_type_hints {
1017 kinds.insert(Some(InlayHintKind::Type));
1018 }
1019 if self.show_parameter_hints {
1020 kinds.insert(Some(InlayHintKind::Parameter));
1021 }
1022 if self.show_other_hints {
1023 kinds.insert(None);
1024 }
1025 kinds
1026 }
1027}
1028
1029impl AllLanguageSettings {
1030 /// Returns the [`LanguageSettings`] for the language with the specified name.
1031 pub fn language<'a>(
1032 &'a self,
1033 location: Option<SettingsLocation<'a>>,
1034 language_name: Option<&LanguageName>,
1035 cx: &'a App,
1036 ) -> Cow<'a, LanguageSettings> {
1037 let settings = language_name
1038 .and_then(|name| self.languages.get(name))
1039 .unwrap_or(&self.defaults);
1040
1041 let editorconfig_properties = location.and_then(|location| {
1042 cx.global::<SettingsStore>()
1043 .editorconfig_properties(location.worktree_id, location.path)
1044 });
1045 if let Some(editorconfig_properties) = editorconfig_properties {
1046 let mut settings = settings.clone();
1047 merge_with_editorconfig(&mut settings, &editorconfig_properties);
1048 Cow::Owned(settings)
1049 } else {
1050 Cow::Borrowed(settings)
1051 }
1052 }
1053
1054 /// Returns whether edit predictions are enabled for the given path.
1055 pub fn edit_predictions_enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool {
1056 self.edit_predictions.enabled_for_file(file, cx)
1057 }
1058
1059 /// Returns whether edit predictions are enabled for the given language and path.
1060 pub fn show_edit_predictions(&self, language: Option<&Arc<Language>>, cx: &App) -> bool {
1061 self.language(None, language.map(|l| l.name()).as_ref(), cx)
1062 .show_edit_predictions
1063 }
1064
1065 /// Returns the edit predictions preview mode for the given language and path.
1066 pub fn edit_predictions_mode(&self) -> EditPredictionsMode {
1067 self.edit_predictions.mode
1068 }
1069}
1070
1071fn merge_with_editorconfig(settings: &mut LanguageSettings, cfg: &EditorconfigProperties) {
1072 let tab_size = cfg.get::<IndentSize>().ok().and_then(|v| match v {
1073 IndentSize::Value(u) => NonZeroU32::new(u as u32),
1074 IndentSize::UseTabWidth => cfg.get::<TabWidth>().ok().and_then(|w| match w {
1075 TabWidth::Value(u) => NonZeroU32::new(u as u32),
1076 }),
1077 });
1078 let hard_tabs = cfg
1079 .get::<IndentStyle>()
1080 .map(|v| v.eq(&IndentStyle::Tabs))
1081 .ok();
1082 let ensure_final_newline_on_save = cfg
1083 .get::<FinalNewline>()
1084 .map(|v| match v {
1085 FinalNewline::Value(b) => b,
1086 })
1087 .ok();
1088 let remove_trailing_whitespace_on_save = cfg
1089 .get::<TrimTrailingWs>()
1090 .map(|v| match v {
1091 TrimTrailingWs::Value(b) => b,
1092 })
1093 .ok();
1094 fn merge<T>(target: &mut T, value: Option<T>) {
1095 if let Some(value) = value {
1096 *target = value;
1097 }
1098 }
1099 merge(&mut settings.tab_size, tab_size);
1100 merge(&mut settings.hard_tabs, hard_tabs);
1101 merge(
1102 &mut settings.remove_trailing_whitespace_on_save,
1103 remove_trailing_whitespace_on_save,
1104 );
1105 merge(
1106 &mut settings.ensure_final_newline_on_save,
1107 ensure_final_newline_on_save,
1108 );
1109}
1110
1111/// The kind of an inlay hint.
1112#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1113pub enum InlayHintKind {
1114 /// An inlay hint for a type.
1115 Type,
1116 /// An inlay hint for a parameter.
1117 Parameter,
1118}
1119
1120impl InlayHintKind {
1121 /// Returns the [`InlayHintKind`] from the given name.
1122 ///
1123 /// Returns `None` if `name` does not match any of the expected
1124 /// string representations.
1125 pub fn from_name(name: &str) -> Option<Self> {
1126 match name {
1127 "type" => Some(InlayHintKind::Type),
1128 "parameter" => Some(InlayHintKind::Parameter),
1129 _ => None,
1130 }
1131 }
1132
1133 /// Returns the name of this [`InlayHintKind`].
1134 pub fn name(&self) -> &'static str {
1135 match self {
1136 InlayHintKind::Type => "type",
1137 InlayHintKind::Parameter => "parameter",
1138 }
1139 }
1140}
1141
1142impl settings::Settings for AllLanguageSettings {
1143 const KEY: Option<&'static str> = None;
1144
1145 type FileContent = AllLanguageSettingsContent;
1146
1147 fn load(sources: SettingsSources<Self::FileContent>, _: &mut App) -> Result<Self> {
1148 let default_value = sources.default;
1149
1150 // A default is provided for all settings.
1151 let mut defaults: LanguageSettings =
1152 serde_json::from_value(serde_json::to_value(&default_value.defaults)?)?;
1153
1154 let mut languages = HashMap::default();
1155 for (language_name, settings) in &default_value.languages {
1156 let mut language_settings = defaults.clone();
1157 merge_settings(&mut language_settings, settings);
1158 languages.insert(language_name.clone(), language_settings);
1159 }
1160
1161 let mut copilot_enabled = default_value.features.as_ref().and_then(|f| f.copilot);
1162 let mut edit_prediction_provider = default_value
1163 .features
1164 .as_ref()
1165 .and_then(|f| f.edit_prediction_provider);
1166 let mut edit_predictions_mode = default_value
1167 .edit_predictions
1168 .as_ref()
1169 .map(|edit_predictions| edit_predictions.mode)
1170 .ok_or_else(Self::missing_default)?;
1171
1172 let mut completion_globs: HashSet<&String> = default_value
1173 .edit_predictions
1174 .as_ref()
1175 .and_then(|c| c.disabled_globs.as_ref())
1176 .map(|globs| globs.iter().collect())
1177 .ok_or_else(Self::missing_default)?;
1178
1179 let mut copilot_settings = default_value
1180 .edit_predictions
1181 .as_ref()
1182 .map(|settings| settings.copilot.clone())
1183 .map(|copilot| CopilotSettings {
1184 proxy: copilot.proxy,
1185 proxy_no_verify: copilot.proxy_no_verify,
1186 })
1187 .unwrap_or_default();
1188
1189 let mut edit_predictions_enabled_in_assistant = default_value
1190 .edit_predictions
1191 .as_ref()
1192 .map(|settings| settings.enabled_in_assistant)
1193 .unwrap_or(true);
1194
1195 let mut file_types: HashMap<Arc<str>, GlobSet> = HashMap::default();
1196
1197 for (language, suffixes) in &default_value.file_types {
1198 let mut builder = GlobSetBuilder::new();
1199
1200 for suffix in suffixes {
1201 builder.add(Glob::new(suffix)?);
1202 }
1203
1204 file_types.insert(language.clone(), builder.build()?);
1205 }
1206
1207 for user_settings in sources.customizations() {
1208 if let Some(copilot) = user_settings.features.as_ref().and_then(|f| f.copilot) {
1209 copilot_enabled = Some(copilot);
1210 }
1211 if let Some(provider) = user_settings
1212 .features
1213 .as_ref()
1214 .and_then(|f| f.edit_prediction_provider)
1215 {
1216 edit_prediction_provider = Some(provider);
1217 }
1218
1219 if let Some(edit_predictions) = user_settings.edit_predictions.as_ref() {
1220 edit_predictions_mode = edit_predictions.mode;
1221 edit_predictions_enabled_in_assistant = edit_predictions.enabled_in_assistant;
1222
1223 if let Some(disabled_globs) = edit_predictions.disabled_globs.as_ref() {
1224 completion_globs.extend(disabled_globs.iter());
1225 }
1226 }
1227
1228 if let Some(proxy) = user_settings
1229 .edit_predictions
1230 .as_ref()
1231 .and_then(|settings| settings.copilot.proxy.clone())
1232 {
1233 copilot_settings.proxy = Some(proxy);
1234 }
1235
1236 if let Some(proxy_no_verify) = user_settings
1237 .edit_predictions
1238 .as_ref()
1239 .and_then(|settings| settings.copilot.proxy_no_verify)
1240 {
1241 copilot_settings.proxy_no_verify = Some(proxy_no_verify);
1242 }
1243
1244 // A user's global settings override the default global settings and
1245 // all default language-specific settings.
1246 merge_settings(&mut defaults, &user_settings.defaults);
1247 for language_settings in languages.values_mut() {
1248 merge_settings(language_settings, &user_settings.defaults);
1249 }
1250
1251 // A user's language-specific settings override default language-specific settings.
1252 for (language_name, user_language_settings) in &user_settings.languages {
1253 merge_settings(
1254 languages
1255 .entry(language_name.clone())
1256 .or_insert_with(|| defaults.clone()),
1257 user_language_settings,
1258 );
1259 }
1260
1261 for (language, suffixes) in &user_settings.file_types {
1262 let mut builder = GlobSetBuilder::new();
1263
1264 let default_value = default_value.file_types.get(&language.clone());
1265
1266 // Merge the default value with the user's value.
1267 if let Some(suffixes) = default_value {
1268 for suffix in suffixes {
1269 builder.add(Glob::new(suffix)?);
1270 }
1271 }
1272
1273 for suffix in suffixes {
1274 builder.add(Glob::new(suffix)?);
1275 }
1276
1277 file_types.insert(language.clone(), builder.build()?);
1278 }
1279 }
1280
1281 Ok(Self {
1282 edit_predictions: EditPredictionSettings {
1283 provider: if let Some(provider) = edit_prediction_provider {
1284 provider
1285 } else if copilot_enabled.unwrap_or(true) {
1286 EditPredictionProvider::Copilot
1287 } else {
1288 EditPredictionProvider::None
1289 },
1290 disabled_globs: completion_globs
1291 .iter()
1292 .filter_map(|g| {
1293 Some(DisabledGlob {
1294 matcher: globset::Glob::new(g).ok()?.compile_matcher(),
1295 is_absolute: Path::new(g).is_absolute(),
1296 })
1297 })
1298 .collect(),
1299 mode: edit_predictions_mode,
1300 copilot: copilot_settings,
1301 enabled_in_assistant: edit_predictions_enabled_in_assistant,
1302 },
1303 defaults,
1304 languages,
1305 file_types,
1306 })
1307 }
1308
1309 fn json_schema(
1310 generator: &mut schemars::gen::SchemaGenerator,
1311 params: &settings::SettingsJsonSchemaParams,
1312 _: &App,
1313 ) -> schemars::schema::RootSchema {
1314 let mut root_schema = generator.root_schema_for::<Self::FileContent>();
1315
1316 // Create a schema for a 'languages overrides' object, associating editor
1317 // settings with specific languages.
1318 assert!(root_schema
1319 .definitions
1320 .contains_key("LanguageSettingsContent"));
1321
1322 let languages_object_schema = SchemaObject {
1323 instance_type: Some(InstanceType::Object.into()),
1324 object: Some(Box::new(ObjectValidation {
1325 properties: params
1326 .language_names
1327 .iter()
1328 .map(|name| {
1329 (
1330 name.clone(),
1331 Schema::new_ref("#/definitions/LanguageSettingsContent".into()),
1332 )
1333 })
1334 .collect(),
1335 ..Default::default()
1336 })),
1337 ..Default::default()
1338 };
1339
1340 root_schema
1341 .definitions
1342 .extend([("Languages".into(), languages_object_schema.into())]);
1343
1344 add_references_to_properties(
1345 &mut root_schema,
1346 &[("languages", "#/definitions/Languages")],
1347 );
1348
1349 root_schema
1350 }
1351}
1352
1353fn merge_settings(settings: &mut LanguageSettings, src: &LanguageSettingsContent) {
1354 fn merge<T>(target: &mut T, value: Option<T>) {
1355 if let Some(value) = value {
1356 *target = value;
1357 }
1358 }
1359
1360 merge(&mut settings.tab_size, src.tab_size);
1361 settings.tab_size = settings
1362 .tab_size
1363 .clamp(NonZeroU32::new(1).unwrap(), NonZeroU32::new(16).unwrap());
1364
1365 merge(&mut settings.hard_tabs, src.hard_tabs);
1366 merge(&mut settings.soft_wrap, src.soft_wrap);
1367 merge(&mut settings.use_autoclose, src.use_autoclose);
1368 merge(&mut settings.use_auto_surround, src.use_auto_surround);
1369 merge(&mut settings.use_on_type_format, src.use_on_type_format);
1370 merge(&mut settings.auto_indent_on_paste, src.auto_indent_on_paste);
1371 merge(
1372 &mut settings.always_treat_brackets_as_autoclosed,
1373 src.always_treat_brackets_as_autoclosed,
1374 );
1375 merge(&mut settings.show_wrap_guides, src.show_wrap_guides);
1376 merge(&mut settings.wrap_guides, src.wrap_guides.clone());
1377 merge(&mut settings.indent_guides, src.indent_guides);
1378 merge(
1379 &mut settings.code_actions_on_format,
1380 src.code_actions_on_format.clone(),
1381 );
1382 merge(&mut settings.linked_edits, src.linked_edits);
1383 merge(&mut settings.tasks, src.tasks.clone());
1384
1385 merge(
1386 &mut settings.preferred_line_length,
1387 src.preferred_line_length,
1388 );
1389 merge(&mut settings.formatter, src.formatter.clone());
1390 merge(&mut settings.prettier, src.prettier.clone());
1391 merge(
1392 &mut settings.jsx_tag_auto_close,
1393 src.jsx_tag_auto_close.clone(),
1394 );
1395 merge(&mut settings.format_on_save, src.format_on_save.clone());
1396 merge(
1397 &mut settings.remove_trailing_whitespace_on_save,
1398 src.remove_trailing_whitespace_on_save,
1399 );
1400 merge(
1401 &mut settings.ensure_final_newline_on_save,
1402 src.ensure_final_newline_on_save,
1403 );
1404 merge(
1405 &mut settings.enable_language_server,
1406 src.enable_language_server,
1407 );
1408 merge(&mut settings.language_servers, src.language_servers.clone());
1409 merge(&mut settings.allow_rewrap, src.allow_rewrap);
1410 merge(
1411 &mut settings.show_edit_predictions,
1412 src.show_edit_predictions,
1413 );
1414 merge(
1415 &mut settings.edit_predictions_disabled_in,
1416 src.edit_predictions_disabled_in.clone(),
1417 );
1418 merge(&mut settings.show_whitespaces, src.show_whitespaces);
1419 merge(
1420 &mut settings.extend_comment_on_newline,
1421 src.extend_comment_on_newline,
1422 );
1423 merge(&mut settings.inlay_hints, src.inlay_hints);
1424 merge(
1425 &mut settings.show_completions_on_input,
1426 src.show_completions_on_input,
1427 );
1428 merge(
1429 &mut settings.show_completion_documentation,
1430 src.show_completion_documentation,
1431 );
1432 merge(&mut settings.completions, src.completions);
1433}
1434
1435/// Allows to enable/disable formatting with Prettier
1436/// and configure default Prettier, used when no project-level Prettier installation is found.
1437/// Prettier formatting is disabled by default.
1438#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1439pub struct PrettierSettings {
1440 /// Enables or disables formatting with Prettier for a given language.
1441 #[serde(default)]
1442 pub allowed: bool,
1443
1444 /// Forces Prettier integration to use a specific parser name when formatting files with the language.
1445 #[serde(default)]
1446 pub parser: Option<String>,
1447
1448 /// Forces Prettier integration to use specific plugins when formatting files with the language.
1449 /// The default Prettier will be installed with these plugins.
1450 #[serde(default)]
1451 pub plugins: HashSet<String>,
1452
1453 /// Default Prettier options, in the format as in package.json section for Prettier.
1454 /// If project installs Prettier via its package.json, these options will be ignored.
1455 #[serde(flatten)]
1456 pub options: HashMap<String, serde_json::Value>,
1457}
1458
1459#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1460pub struct JsxTagAutoCloseSettings {
1461 /// Enables or disables auto-closing of JSX tags.
1462 #[serde(default)]
1463 pub enabled: bool,
1464}
1465
1466#[cfg(test)]
1467mod tests {
1468 use gpui::TestAppContext;
1469
1470 use super::*;
1471
1472 #[test]
1473 fn test_formatter_deserialization() {
1474 let raw_auto = "{\"formatter\": \"auto\"}";
1475 let settings: LanguageSettingsContent = serde_json::from_str(raw_auto).unwrap();
1476 assert_eq!(settings.formatter, Some(SelectedFormatter::Auto));
1477 let raw = "{\"formatter\": \"language_server\"}";
1478 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1479 assert_eq!(
1480 settings.formatter,
1481 Some(SelectedFormatter::List(FormatterList(
1482 Formatter::LanguageServer { name: None }.into()
1483 )))
1484 );
1485 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}]}";
1486 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1487 assert_eq!(
1488 settings.formatter,
1489 Some(SelectedFormatter::List(FormatterList(
1490 vec![Formatter::LanguageServer { name: None }].into()
1491 )))
1492 );
1493 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}, \"prettier\"]}";
1494 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1495 assert_eq!(
1496 settings.formatter,
1497 Some(SelectedFormatter::List(FormatterList(
1498 vec![
1499 Formatter::LanguageServer { name: None },
1500 Formatter::Prettier
1501 ]
1502 .into()
1503 )))
1504 );
1505 }
1506
1507 #[test]
1508 fn test_formatter_deserialization_invalid() {
1509 let raw_auto = "{\"formatter\": {}}";
1510 let result: Result<LanguageSettingsContent, _> = serde_json::from_str(raw_auto);
1511 assert!(result.is_err());
1512 }
1513
1514 #[gpui::test]
1515 fn test_edit_predictions_enabled_for_file(cx: &mut TestAppContext) {
1516 use crate::TestFile;
1517 use std::path::PathBuf;
1518
1519 let cx = cx.app.borrow_mut();
1520
1521 let build_settings = |globs: &[&str]| -> EditPredictionSettings {
1522 EditPredictionSettings {
1523 disabled_globs: globs
1524 .iter()
1525 .map(|glob_str| {
1526 #[cfg(windows)]
1527 let glob_str = {
1528 let mut g = String::new();
1529
1530 if glob_str.starts_with('/') {
1531 g.push_str("C:");
1532 }
1533
1534 g.push_str(&glob_str.replace('/', "\\"));
1535 g
1536 };
1537 #[cfg(windows)]
1538 let glob_str = glob_str.as_str();
1539
1540 DisabledGlob {
1541 matcher: globset::Glob::new(glob_str).unwrap().compile_matcher(),
1542 is_absolute: Path::new(glob_str).is_absolute(),
1543 }
1544 })
1545 .collect(),
1546 ..Default::default()
1547 }
1548 };
1549
1550 const WORKTREE_NAME: &str = "project";
1551 let make_test_file = |segments: &[&str]| -> Arc<dyn File> {
1552 let mut path_buf = PathBuf::new();
1553 path_buf.extend(segments);
1554
1555 Arc::new(TestFile {
1556 path: path_buf.as_path().into(),
1557 root_name: WORKTREE_NAME.to_string(),
1558 local_root: Some(PathBuf::from(if cfg!(windows) {
1559 "C:\\absolute\\"
1560 } else {
1561 "/absolute/"
1562 })),
1563 })
1564 };
1565
1566 let test_file = make_test_file(&["src", "test", "file.rs"]);
1567
1568 // Test relative globs
1569 let settings = build_settings(&["*.rs"]);
1570 assert!(!settings.enabled_for_file(&test_file, &cx));
1571 let settings = build_settings(&["*.txt"]);
1572 assert!(settings.enabled_for_file(&test_file, &cx));
1573
1574 // Test absolute globs
1575 let settings = build_settings(&["/absolute/**/*.rs"]);
1576 assert!(!settings.enabled_for_file(&test_file, &cx));
1577 let settings = build_settings(&["/other/**/*.rs"]);
1578 assert!(settings.enabled_for_file(&test_file, &cx));
1579
1580 // Test exact path match relative
1581 let settings = build_settings(&["src/test/file.rs"]);
1582 assert!(!settings.enabled_for_file(&test_file, &cx));
1583 let settings = build_settings(&["src/test/otherfile.rs"]);
1584 assert!(settings.enabled_for_file(&test_file, &cx));
1585
1586 // Test exact path match absolute
1587 let settings = build_settings(&[&format!("/absolute/{}/src/test/file.rs", WORKTREE_NAME)]);
1588 assert!(!settings.enabled_for_file(&test_file, &cx));
1589 let settings = build_settings(&["/other/test/otherfile.rs"]);
1590 assert!(settings.enabled_for_file(&test_file, &cx));
1591
1592 // Test * glob
1593 let settings = build_settings(&["*"]);
1594 assert!(!settings.enabled_for_file(&test_file, &cx));
1595 let settings = build_settings(&["*.txt"]);
1596 assert!(settings.enabled_for_file(&test_file, &cx));
1597
1598 // Test **/* glob
1599 let settings = build_settings(&["**/*"]);
1600 assert!(!settings.enabled_for_file(&test_file, &cx));
1601 let settings = build_settings(&["other/**/*"]);
1602 assert!(settings.enabled_for_file(&test_file, &cx));
1603
1604 // Test directory/** glob
1605 let settings = build_settings(&["src/**"]);
1606 assert!(!settings.enabled_for_file(&test_file, &cx));
1607
1608 let test_file_root: Arc<dyn File> = Arc::new(TestFile {
1609 path: PathBuf::from("file.rs").as_path().into(),
1610 root_name: WORKTREE_NAME.to_string(),
1611 local_root: Some(PathBuf::from("/absolute/")),
1612 });
1613 assert!(settings.enabled_for_file(&test_file_root, &cx));
1614
1615 let settings = build_settings(&["other/**"]);
1616 assert!(settings.enabled_for_file(&test_file, &cx));
1617
1618 // Test **/directory/* glob
1619 let settings = build_settings(&["**/test/*"]);
1620 assert!(!settings.enabled_for_file(&test_file, &cx));
1621 let settings = build_settings(&["**/other/*"]);
1622 assert!(settings.enabled_for_file(&test_file, &cx));
1623
1624 // Test multiple globs
1625 let settings = build_settings(&["*.rs", "*.txt", "src/**"]);
1626 assert!(!settings.enabled_for_file(&test_file, &cx));
1627 let settings = build_settings(&["*.txt", "*.md", "other/**"]);
1628 assert!(settings.enabled_for_file(&test_file, &cx));
1629
1630 // Test dot files
1631 let dot_file = make_test_file(&[".config", "settings.json"]);
1632 let settings = build_settings(&[".*/**"]);
1633 assert!(!settings.enabled_for_file(&dot_file, &cx));
1634
1635 let dot_env_file = make_test_file(&[".env"]);
1636 let settings = build_settings(&[".env"]);
1637 assert!(!settings.enabled_for_file(&dot_env_file, &cx));
1638 }
1639
1640 #[test]
1641 pub fn test_resolve_language_servers() {
1642 fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
1643 names
1644 .iter()
1645 .copied()
1646 .map(|name| LanguageServerName(name.to_string().into()))
1647 .collect::<Vec<_>>()
1648 }
1649
1650 let available_language_servers = language_server_names(&[
1651 "typescript-language-server",
1652 "biome",
1653 "deno",
1654 "eslint",
1655 "tailwind",
1656 ]);
1657
1658 // A value of just `["..."]` is the same as taking all of the available language servers.
1659 assert_eq!(
1660 LanguageSettings::resolve_language_servers(
1661 &[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
1662 &available_language_servers,
1663 ),
1664 available_language_servers
1665 );
1666
1667 // Referencing one of the available language servers will change its order.
1668 assert_eq!(
1669 LanguageSettings::resolve_language_servers(
1670 &[
1671 "biome".into(),
1672 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
1673 "deno".into()
1674 ],
1675 &available_language_servers
1676 ),
1677 language_server_names(&[
1678 "biome",
1679 "typescript-language-server",
1680 "eslint",
1681 "tailwind",
1682 "deno",
1683 ])
1684 );
1685
1686 // Negating an available language server removes it from the list.
1687 assert_eq!(
1688 LanguageSettings::resolve_language_servers(
1689 &[
1690 "deno".into(),
1691 "!typescript-language-server".into(),
1692 "!biome".into(),
1693 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1694 ],
1695 &available_language_servers
1696 ),
1697 language_server_names(&["deno", "eslint", "tailwind"])
1698 );
1699
1700 // Adding a language server not in the list of available language servers adds it to the list.
1701 assert_eq!(
1702 LanguageSettings::resolve_language_servers(
1703 &[
1704 "my-cool-language-server".into(),
1705 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1706 ],
1707 &available_language_servers
1708 ),
1709 language_server_names(&[
1710 "my-cool-language-server",
1711 "typescript-language-server",
1712 "biome",
1713 "deno",
1714 "eslint",
1715 "tailwind",
1716 ])
1717 );
1718 }
1719}