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 /// Determines which edit prediction provider to use.
584 pub edit_prediction_provider: Option<EditPredictionProvider>,
585}
586
587/// Controls the soft-wrapping behavior in the editor.
588#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
589#[serde(rename_all = "snake_case")]
590pub enum SoftWrap {
591 /// Prefer a single line generally, unless an overly long line is encountered.
592 None,
593 /// Deprecated: use None instead. Left to avoid breaking existing users' configs.
594 /// Prefer a single line generally, unless an overly long line is encountered.
595 PreferLine,
596 /// Soft wrap lines that exceed the editor width.
597 EditorWidth,
598 /// Soft wrap lines at the preferred line length.
599 PreferredLineLength,
600 /// Soft wrap line at the preferred line length or the editor width (whichever is smaller).
601 Bounded,
602}
603
604/// Controls the behavior of formatting files when they are saved.
605#[derive(Debug, Clone, PartialEq, Eq)]
606pub enum FormatOnSave {
607 /// Files should be formatted on save.
608 On,
609 /// Files should not be formatted on save.
610 Off,
611 List(FormatterList),
612}
613
614impl JsonSchema for FormatOnSave {
615 fn schema_name() -> String {
616 "OnSaveFormatter".into()
617 }
618
619 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
620 let mut schema = SchemaObject::default();
621 let formatter_schema = Formatter::json_schema(generator);
622 schema.instance_type = Some(
623 vec![
624 InstanceType::Object,
625 InstanceType::String,
626 InstanceType::Array,
627 ]
628 .into(),
629 );
630
631 let valid_raw_values = SchemaObject {
632 enum_values: Some(vec![
633 Value::String("on".into()),
634 Value::String("off".into()),
635 Value::String("prettier".into()),
636 Value::String("language_server".into()),
637 ]),
638 ..Default::default()
639 };
640 let mut nested_values = SchemaObject::default();
641
642 nested_values.array().items = Some(formatter_schema.clone().into());
643
644 schema.subschemas().any_of = Some(vec![
645 nested_values.into(),
646 valid_raw_values.into(),
647 formatter_schema,
648 ]);
649 schema.into()
650 }
651}
652
653impl Serialize for FormatOnSave {
654 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
655 where
656 S: serde::Serializer,
657 {
658 match self {
659 Self::On => serializer.serialize_str("on"),
660 Self::Off => serializer.serialize_str("off"),
661 Self::List(list) => list.serialize(serializer),
662 }
663 }
664}
665
666impl<'de> Deserialize<'de> for FormatOnSave {
667 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
668 where
669 D: Deserializer<'de>,
670 {
671 struct FormatDeserializer;
672
673 impl<'d> Visitor<'d> for FormatDeserializer {
674 type Value = FormatOnSave;
675
676 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
677 formatter.write_str("a valid on-save formatter kind")
678 }
679 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
680 where
681 E: serde::de::Error,
682 {
683 if v == "on" {
684 Ok(Self::Value::On)
685 } else if v == "off" {
686 Ok(Self::Value::Off)
687 } else if v == "language_server" {
688 Ok(Self::Value::List(FormatterList(
689 Formatter::LanguageServer { name: None }.into(),
690 )))
691 } else {
692 let ret: Result<FormatterList, _> =
693 Deserialize::deserialize(v.into_deserializer());
694 ret.map(Self::Value::List)
695 }
696 }
697 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
698 where
699 A: MapAccess<'d>,
700 {
701 let ret: Result<FormatterList, _> =
702 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
703 ret.map(Self::Value::List)
704 }
705 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
706 where
707 A: SeqAccess<'d>,
708 {
709 let ret: Result<FormatterList, _> =
710 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
711 ret.map(Self::Value::List)
712 }
713 }
714 deserializer.deserialize_any(FormatDeserializer)
715 }
716}
717
718/// Controls how whitespace should be displayedin the editor.
719#[derive(Copy, Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
720#[serde(rename_all = "snake_case")]
721pub enum ShowWhitespaceSetting {
722 /// Draw whitespace only for the selected text.
723 Selection,
724 /// Do not draw any tabs or spaces.
725 None,
726 /// Draw all invisible symbols.
727 All,
728 /// Draw whitespaces at boundaries only.
729 ///
730 /// For a whitespace to be on a boundary, any of the following conditions need to be met:
731 /// - It is a tab
732 /// - It is adjacent to an edge (start or end)
733 /// - It is adjacent to a whitespace (left or right)
734 Boundary,
735}
736
737/// Controls which formatter should be used when formatting code.
738#[derive(Clone, Debug, Default, PartialEq, Eq)]
739pub enum SelectedFormatter {
740 /// Format files using Zed's Prettier integration (if applicable),
741 /// or falling back to formatting via language server.
742 #[default]
743 Auto,
744 List(FormatterList),
745}
746
747impl JsonSchema for SelectedFormatter {
748 fn schema_name() -> String {
749 "Formatter".into()
750 }
751
752 fn json_schema(generator: &mut schemars::r#gen::SchemaGenerator) -> Schema {
753 let mut schema = SchemaObject::default();
754 let formatter_schema = Formatter::json_schema(generator);
755 schema.instance_type = Some(
756 vec![
757 InstanceType::Object,
758 InstanceType::String,
759 InstanceType::Array,
760 ]
761 .into(),
762 );
763
764 let valid_raw_values = SchemaObject {
765 enum_values: Some(vec![
766 Value::String("auto".into()),
767 Value::String("prettier".into()),
768 Value::String("language_server".into()),
769 ]),
770 ..Default::default()
771 };
772
773 let mut nested_values = SchemaObject::default();
774
775 nested_values.array().items = Some(formatter_schema.clone().into());
776
777 schema.subschemas().any_of = Some(vec![
778 nested_values.into(),
779 valid_raw_values.into(),
780 formatter_schema,
781 ]);
782 schema.into()
783 }
784}
785
786impl Serialize for SelectedFormatter {
787 fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
788 where
789 S: serde::Serializer,
790 {
791 match self {
792 SelectedFormatter::Auto => serializer.serialize_str("auto"),
793 SelectedFormatter::List(list) => list.serialize(serializer),
794 }
795 }
796}
797impl<'de> Deserialize<'de> for SelectedFormatter {
798 fn deserialize<D>(deserializer: D) -> std::result::Result<Self, D::Error>
799 where
800 D: Deserializer<'de>,
801 {
802 struct FormatDeserializer;
803
804 impl<'d> Visitor<'d> for FormatDeserializer {
805 type Value = SelectedFormatter;
806
807 fn expecting(&self, formatter: &mut std::fmt::Formatter) -> std::fmt::Result {
808 formatter.write_str("a valid formatter kind")
809 }
810 fn visit_str<E>(self, v: &str) -> std::result::Result<Self::Value, E>
811 where
812 E: serde::de::Error,
813 {
814 if v == "auto" {
815 Ok(Self::Value::Auto)
816 } else if v == "language_server" {
817 Ok(Self::Value::List(FormatterList(
818 Formatter::LanguageServer { name: None }.into(),
819 )))
820 } else {
821 let ret: Result<FormatterList, _> =
822 Deserialize::deserialize(v.into_deserializer());
823 ret.map(SelectedFormatter::List)
824 }
825 }
826 fn visit_map<A>(self, map: A) -> Result<Self::Value, A::Error>
827 where
828 A: MapAccess<'d>,
829 {
830 let ret: Result<FormatterList, _> =
831 Deserialize::deserialize(de::value::MapAccessDeserializer::new(map));
832 ret.map(SelectedFormatter::List)
833 }
834 fn visit_seq<A>(self, map: A) -> Result<Self::Value, A::Error>
835 where
836 A: SeqAccess<'d>,
837 {
838 let ret: Result<FormatterList, _> =
839 Deserialize::deserialize(de::value::SeqAccessDeserializer::new(map));
840 ret.map(SelectedFormatter::List)
841 }
842 }
843 deserializer.deserialize_any(FormatDeserializer)
844 }
845}
846/// Controls which formatter should be used when formatting code.
847#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
848#[serde(rename_all = "snake_case", transparent)]
849pub struct FormatterList(pub SingleOrVec<Formatter>);
850
851impl AsRef<[Formatter]> for FormatterList {
852 fn as_ref(&self) -> &[Formatter] {
853 match &self.0 {
854 SingleOrVec::Single(single) => slice::from_ref(single),
855 SingleOrVec::Vec(v) => v,
856 }
857 }
858}
859
860/// Controls which formatter should be used when formatting code. If there are multiple formatters, they are executed in the order of declaration.
861#[derive(Clone, Debug, Serialize, Deserialize, PartialEq, Eq, JsonSchema)]
862#[serde(rename_all = "snake_case")]
863pub enum Formatter {
864 /// Format code using the current language server.
865 LanguageServer { name: Option<String> },
866 /// Format code using Zed's Prettier integration.
867 Prettier,
868 /// Format code using an external command.
869 External {
870 /// The external program to run.
871 command: Arc<str>,
872 /// The arguments to pass to the program.
873 arguments: Option<Arc<[String]>>,
874 },
875 /// Files should be formatted using code actions executed by language servers.
876 CodeActions(HashMap<String, bool>),
877}
878
879/// The settings for indent guides.
880#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
881pub struct IndentGuideSettings {
882 /// Whether to display indent guides in the editor.
883 ///
884 /// Default: true
885 #[serde(default = "default_true")]
886 pub enabled: bool,
887 /// The width of the indent guides in pixels, between 1 and 10.
888 ///
889 /// Default: 1
890 #[serde(default = "line_width")]
891 pub line_width: u32,
892 /// The width of the active indent guide in pixels, between 1 and 10.
893 ///
894 /// Default: 1
895 #[serde(default = "active_line_width")]
896 pub active_line_width: u32,
897 /// Determines how indent guides are colored.
898 ///
899 /// Default: Fixed
900 #[serde(default)]
901 pub coloring: IndentGuideColoring,
902 /// Determines how indent guide backgrounds are colored.
903 ///
904 /// Default: Disabled
905 #[serde(default)]
906 pub background_coloring: IndentGuideBackgroundColoring,
907}
908
909fn line_width() -> u32 {
910 1
911}
912
913fn active_line_width() -> u32 {
914 line_width()
915}
916
917/// Determines how indent guides are colored.
918#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
919#[serde(rename_all = "snake_case")]
920pub enum IndentGuideColoring {
921 /// Do not render any lines for indent guides.
922 Disabled,
923 /// Use the same color for all indentation levels.
924 #[default]
925 Fixed,
926 /// Use a different color for each indentation level.
927 IndentAware,
928}
929
930/// Determines how indent guide backgrounds are colored.
931#[derive(Default, Debug, Copy, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
932#[serde(rename_all = "snake_case")]
933pub enum IndentGuideBackgroundColoring {
934 /// Do not render any background for indent guides.
935 #[default]
936 Disabled,
937 /// Use a different color for each indentation level.
938 IndentAware,
939}
940
941/// The settings for inlay hints.
942#[derive(Copy, Clone, Debug, Serialize, Deserialize, JsonSchema, PartialEq, Eq)]
943pub struct InlayHintSettings {
944 /// Global switch to toggle hints on and off.
945 ///
946 /// Default: false
947 #[serde(default)]
948 pub enabled: bool,
949 /// Whether type hints should be shown.
950 ///
951 /// Default: true
952 #[serde(default = "default_true")]
953 pub show_type_hints: bool,
954 /// Whether parameter hints should be shown.
955 ///
956 /// Default: true
957 #[serde(default = "default_true")]
958 pub show_parameter_hints: bool,
959 /// Whether other hints should be shown.
960 ///
961 /// Default: true
962 #[serde(default = "default_true")]
963 pub show_other_hints: bool,
964 /// Whether to show a background for inlay hints.
965 ///
966 /// If set to `true`, the background will use the `hint.background` color
967 /// from the current theme.
968 ///
969 /// Default: false
970 #[serde(default)]
971 pub show_background: bool,
972 /// Whether or not to debounce inlay hints updates after buffer edits.
973 ///
974 /// Set to 0 to disable debouncing.
975 ///
976 /// Default: 700
977 #[serde(default = "edit_debounce_ms")]
978 pub edit_debounce_ms: u64,
979 /// Whether or not to debounce inlay hints updates after buffer scrolls.
980 ///
981 /// Set to 0 to disable debouncing.
982 ///
983 /// Default: 50
984 #[serde(default = "scroll_debounce_ms")]
985 pub scroll_debounce_ms: u64,
986 /// Toggles inlay hints (hides or shows) when the user presses the modifiers specified.
987 /// If only a subset of the modifiers specified is pressed, hints are not toggled.
988 /// If no modifiers are specified, this is equivalent to `None`.
989 ///
990 /// Default: None
991 #[serde(default)]
992 pub toggle_on_modifiers_press: Option<Modifiers>,
993}
994
995fn edit_debounce_ms() -> u64 {
996 700
997}
998
999fn scroll_debounce_ms() -> u64 {
1000 50
1001}
1002
1003/// The task settings for a particular language.
1004#[derive(Debug, Clone, Deserialize, PartialEq, Serialize, JsonSchema)]
1005pub struct LanguageTaskConfig {
1006 /// Extra task variables to set for a particular language.
1007 pub variables: HashMap<String, String>,
1008}
1009
1010impl InlayHintSettings {
1011 /// Returns the kinds of inlay hints that are enabled based on the settings.
1012 pub fn enabled_inlay_hint_kinds(&self) -> HashSet<Option<InlayHintKind>> {
1013 let mut kinds = HashSet::default();
1014 if self.show_type_hints {
1015 kinds.insert(Some(InlayHintKind::Type));
1016 }
1017 if self.show_parameter_hints {
1018 kinds.insert(Some(InlayHintKind::Parameter));
1019 }
1020 if self.show_other_hints {
1021 kinds.insert(None);
1022 }
1023 kinds
1024 }
1025}
1026
1027impl AllLanguageSettings {
1028 /// Returns the [`LanguageSettings`] for the language with the specified name.
1029 pub fn language<'a>(
1030 &'a self,
1031 location: Option<SettingsLocation<'a>>,
1032 language_name: Option<&LanguageName>,
1033 cx: &'a App,
1034 ) -> Cow<'a, LanguageSettings> {
1035 let settings = language_name
1036 .and_then(|name| self.languages.get(name))
1037 .unwrap_or(&self.defaults);
1038
1039 let editorconfig_properties = location.and_then(|location| {
1040 cx.global::<SettingsStore>()
1041 .editorconfig_properties(location.worktree_id, location.path)
1042 });
1043 if let Some(editorconfig_properties) = editorconfig_properties {
1044 let mut settings = settings.clone();
1045 merge_with_editorconfig(&mut settings, &editorconfig_properties);
1046 Cow::Owned(settings)
1047 } else {
1048 Cow::Borrowed(settings)
1049 }
1050 }
1051
1052 /// Returns whether edit predictions are enabled for the given path.
1053 pub fn edit_predictions_enabled_for_file(&self, file: &Arc<dyn File>, cx: &App) -> bool {
1054 self.edit_predictions.enabled_for_file(file, cx)
1055 }
1056
1057 /// Returns whether edit predictions are enabled for the given language and path.
1058 pub fn show_edit_predictions(&self, language: Option<&Arc<Language>>, cx: &App) -> bool {
1059 self.language(None, language.map(|l| l.name()).as_ref(), cx)
1060 .show_edit_predictions
1061 }
1062
1063 /// Returns the edit predictions preview mode for the given language and path.
1064 pub fn edit_predictions_mode(&self) -> EditPredictionsMode {
1065 self.edit_predictions.mode
1066 }
1067}
1068
1069fn merge_with_editorconfig(settings: &mut LanguageSettings, cfg: &EditorconfigProperties) {
1070 let tab_size = cfg.get::<IndentSize>().ok().and_then(|v| match v {
1071 IndentSize::Value(u) => NonZeroU32::new(u as u32),
1072 IndentSize::UseTabWidth => cfg.get::<TabWidth>().ok().and_then(|w| match w {
1073 TabWidth::Value(u) => NonZeroU32::new(u as u32),
1074 }),
1075 });
1076 let hard_tabs = cfg
1077 .get::<IndentStyle>()
1078 .map(|v| v.eq(&IndentStyle::Tabs))
1079 .ok();
1080 let ensure_final_newline_on_save = cfg
1081 .get::<FinalNewline>()
1082 .map(|v| match v {
1083 FinalNewline::Value(b) => b,
1084 })
1085 .ok();
1086 let remove_trailing_whitespace_on_save = cfg
1087 .get::<TrimTrailingWs>()
1088 .map(|v| match v {
1089 TrimTrailingWs::Value(b) => b,
1090 })
1091 .ok();
1092 fn merge<T>(target: &mut T, value: Option<T>) {
1093 if let Some(value) = value {
1094 *target = value;
1095 }
1096 }
1097 merge(&mut settings.tab_size, tab_size);
1098 merge(&mut settings.hard_tabs, hard_tabs);
1099 merge(
1100 &mut settings.remove_trailing_whitespace_on_save,
1101 remove_trailing_whitespace_on_save,
1102 );
1103 merge(
1104 &mut settings.ensure_final_newline_on_save,
1105 ensure_final_newline_on_save,
1106 );
1107}
1108
1109/// The kind of an inlay hint.
1110#[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
1111pub enum InlayHintKind {
1112 /// An inlay hint for a type.
1113 Type,
1114 /// An inlay hint for a parameter.
1115 Parameter,
1116}
1117
1118impl InlayHintKind {
1119 /// Returns the [`InlayHintKind`] from the given name.
1120 ///
1121 /// Returns `None` if `name` does not match any of the expected
1122 /// string representations.
1123 pub fn from_name(name: &str) -> Option<Self> {
1124 match name {
1125 "type" => Some(InlayHintKind::Type),
1126 "parameter" => Some(InlayHintKind::Parameter),
1127 _ => None,
1128 }
1129 }
1130
1131 /// Returns the name of this [`InlayHintKind`].
1132 pub fn name(&self) -> &'static str {
1133 match self {
1134 InlayHintKind::Type => "type",
1135 InlayHintKind::Parameter => "parameter",
1136 }
1137 }
1138}
1139
1140impl settings::Settings for AllLanguageSettings {
1141 const KEY: Option<&'static str> = None;
1142
1143 type FileContent = AllLanguageSettingsContent;
1144
1145 fn load(sources: SettingsSources<Self::FileContent>, _: &mut App) -> Result<Self> {
1146 let default_value = sources.default;
1147
1148 // A default is provided for all settings.
1149 let mut defaults: LanguageSettings =
1150 serde_json::from_value(serde_json::to_value(&default_value.defaults)?)?;
1151
1152 let mut languages = HashMap::default();
1153 for (language_name, settings) in &default_value.languages {
1154 let mut language_settings = defaults.clone();
1155 merge_settings(&mut language_settings, settings);
1156 languages.insert(language_name.clone(), language_settings);
1157 }
1158
1159 let mut edit_prediction_provider = default_value
1160 .features
1161 .as_ref()
1162 .and_then(|f| f.edit_prediction_provider);
1163 let mut edit_predictions_mode = default_value
1164 .edit_predictions
1165 .as_ref()
1166 .map(|edit_predictions| edit_predictions.mode)
1167 .ok_or_else(Self::missing_default)?;
1168
1169 let mut completion_globs: HashSet<&String> = default_value
1170 .edit_predictions
1171 .as_ref()
1172 .and_then(|c| c.disabled_globs.as_ref())
1173 .map(|globs| globs.iter().collect())
1174 .ok_or_else(Self::missing_default)?;
1175
1176 let mut copilot_settings = default_value
1177 .edit_predictions
1178 .as_ref()
1179 .map(|settings| settings.copilot.clone())
1180 .map(|copilot| CopilotSettings {
1181 proxy: copilot.proxy,
1182 proxy_no_verify: copilot.proxy_no_verify,
1183 })
1184 .unwrap_or_default();
1185
1186 let mut edit_predictions_enabled_in_assistant = default_value
1187 .edit_predictions
1188 .as_ref()
1189 .map(|settings| settings.enabled_in_assistant)
1190 .unwrap_or(true);
1191
1192 let mut file_types: HashMap<Arc<str>, GlobSet> = HashMap::default();
1193
1194 for (language, suffixes) in &default_value.file_types {
1195 let mut builder = GlobSetBuilder::new();
1196
1197 for suffix in suffixes {
1198 builder.add(Glob::new(suffix)?);
1199 }
1200
1201 file_types.insert(language.clone(), builder.build()?);
1202 }
1203
1204 for user_settings in sources.customizations() {
1205 if let Some(provider) = user_settings
1206 .features
1207 .as_ref()
1208 .and_then(|f| f.edit_prediction_provider)
1209 {
1210 edit_prediction_provider = Some(provider);
1211 }
1212
1213 if let Some(edit_predictions) = user_settings.edit_predictions.as_ref() {
1214 edit_predictions_mode = edit_predictions.mode;
1215 edit_predictions_enabled_in_assistant = edit_predictions.enabled_in_assistant;
1216
1217 if let Some(disabled_globs) = edit_predictions.disabled_globs.as_ref() {
1218 completion_globs.extend(disabled_globs.iter());
1219 }
1220 }
1221
1222 if let Some(proxy) = user_settings
1223 .edit_predictions
1224 .as_ref()
1225 .and_then(|settings| settings.copilot.proxy.clone())
1226 {
1227 copilot_settings.proxy = Some(proxy);
1228 }
1229
1230 if let Some(proxy_no_verify) = user_settings
1231 .edit_predictions
1232 .as_ref()
1233 .and_then(|settings| settings.copilot.proxy_no_verify)
1234 {
1235 copilot_settings.proxy_no_verify = Some(proxy_no_verify);
1236 }
1237
1238 // A user's global settings override the default global settings and
1239 // all default language-specific settings.
1240 merge_settings(&mut defaults, &user_settings.defaults);
1241 for language_settings in languages.values_mut() {
1242 merge_settings(language_settings, &user_settings.defaults);
1243 }
1244
1245 // A user's language-specific settings override default language-specific settings.
1246 for (language_name, user_language_settings) in &user_settings.languages {
1247 merge_settings(
1248 languages
1249 .entry(language_name.clone())
1250 .or_insert_with(|| defaults.clone()),
1251 user_language_settings,
1252 );
1253 }
1254
1255 for (language, suffixes) in &user_settings.file_types {
1256 let mut builder = GlobSetBuilder::new();
1257
1258 let default_value = default_value.file_types.get(&language.clone());
1259
1260 // Merge the default value with the user's value.
1261 if let Some(suffixes) = default_value {
1262 for suffix in suffixes {
1263 builder.add(Glob::new(suffix)?);
1264 }
1265 }
1266
1267 for suffix in suffixes {
1268 builder.add(Glob::new(suffix)?);
1269 }
1270
1271 file_types.insert(language.clone(), builder.build()?);
1272 }
1273 }
1274
1275 Ok(Self {
1276 edit_predictions: EditPredictionSettings {
1277 provider: if let Some(provider) = edit_prediction_provider {
1278 provider
1279 } else {
1280 EditPredictionProvider::None
1281 },
1282 disabled_globs: completion_globs
1283 .iter()
1284 .filter_map(|g| {
1285 Some(DisabledGlob {
1286 matcher: globset::Glob::new(g).ok()?.compile_matcher(),
1287 is_absolute: Path::new(g).is_absolute(),
1288 })
1289 })
1290 .collect(),
1291 mode: edit_predictions_mode,
1292 copilot: copilot_settings,
1293 enabled_in_assistant: edit_predictions_enabled_in_assistant,
1294 },
1295 defaults,
1296 languages,
1297 file_types,
1298 })
1299 }
1300
1301 fn json_schema(
1302 generator: &mut schemars::gen::SchemaGenerator,
1303 params: &settings::SettingsJsonSchemaParams,
1304 _: &App,
1305 ) -> schemars::schema::RootSchema {
1306 let mut root_schema = generator.root_schema_for::<Self::FileContent>();
1307
1308 // Create a schema for a 'languages overrides' object, associating editor
1309 // settings with specific languages.
1310 assert!(root_schema
1311 .definitions
1312 .contains_key("LanguageSettingsContent"));
1313
1314 let languages_object_schema = SchemaObject {
1315 instance_type: Some(InstanceType::Object.into()),
1316 object: Some(Box::new(ObjectValidation {
1317 properties: params
1318 .language_names
1319 .iter()
1320 .map(|name| {
1321 (
1322 name.clone(),
1323 Schema::new_ref("#/definitions/LanguageSettingsContent".into()),
1324 )
1325 })
1326 .collect(),
1327 ..Default::default()
1328 })),
1329 ..Default::default()
1330 };
1331
1332 root_schema
1333 .definitions
1334 .extend([("Languages".into(), languages_object_schema.into())]);
1335
1336 add_references_to_properties(
1337 &mut root_schema,
1338 &[("languages", "#/definitions/Languages")],
1339 );
1340
1341 root_schema
1342 }
1343}
1344
1345fn merge_settings(settings: &mut LanguageSettings, src: &LanguageSettingsContent) {
1346 fn merge<T>(target: &mut T, value: Option<T>) {
1347 if let Some(value) = value {
1348 *target = value;
1349 }
1350 }
1351
1352 merge(&mut settings.tab_size, src.tab_size);
1353 settings.tab_size = settings
1354 .tab_size
1355 .clamp(NonZeroU32::new(1).unwrap(), NonZeroU32::new(16).unwrap());
1356
1357 merge(&mut settings.hard_tabs, src.hard_tabs);
1358 merge(&mut settings.soft_wrap, src.soft_wrap);
1359 merge(&mut settings.use_autoclose, src.use_autoclose);
1360 merge(&mut settings.use_auto_surround, src.use_auto_surround);
1361 merge(&mut settings.use_on_type_format, src.use_on_type_format);
1362 merge(&mut settings.auto_indent_on_paste, src.auto_indent_on_paste);
1363 merge(
1364 &mut settings.always_treat_brackets_as_autoclosed,
1365 src.always_treat_brackets_as_autoclosed,
1366 );
1367 merge(&mut settings.show_wrap_guides, src.show_wrap_guides);
1368 merge(&mut settings.wrap_guides, src.wrap_guides.clone());
1369 merge(&mut settings.indent_guides, src.indent_guides);
1370 merge(
1371 &mut settings.code_actions_on_format,
1372 src.code_actions_on_format.clone(),
1373 );
1374 merge(&mut settings.linked_edits, src.linked_edits);
1375 merge(&mut settings.tasks, src.tasks.clone());
1376
1377 merge(
1378 &mut settings.preferred_line_length,
1379 src.preferred_line_length,
1380 );
1381 merge(&mut settings.formatter, src.formatter.clone());
1382 merge(&mut settings.prettier, src.prettier.clone());
1383 merge(
1384 &mut settings.jsx_tag_auto_close,
1385 src.jsx_tag_auto_close.clone(),
1386 );
1387 merge(&mut settings.format_on_save, src.format_on_save.clone());
1388 merge(
1389 &mut settings.remove_trailing_whitespace_on_save,
1390 src.remove_trailing_whitespace_on_save,
1391 );
1392 merge(
1393 &mut settings.ensure_final_newline_on_save,
1394 src.ensure_final_newline_on_save,
1395 );
1396 merge(
1397 &mut settings.enable_language_server,
1398 src.enable_language_server,
1399 );
1400 merge(&mut settings.language_servers, src.language_servers.clone());
1401 merge(&mut settings.allow_rewrap, src.allow_rewrap);
1402 merge(
1403 &mut settings.show_edit_predictions,
1404 src.show_edit_predictions,
1405 );
1406 merge(
1407 &mut settings.edit_predictions_disabled_in,
1408 src.edit_predictions_disabled_in.clone(),
1409 );
1410 merge(&mut settings.show_whitespaces, src.show_whitespaces);
1411 merge(
1412 &mut settings.extend_comment_on_newline,
1413 src.extend_comment_on_newline,
1414 );
1415 merge(&mut settings.inlay_hints, src.inlay_hints);
1416 merge(
1417 &mut settings.show_completions_on_input,
1418 src.show_completions_on_input,
1419 );
1420 merge(
1421 &mut settings.show_completion_documentation,
1422 src.show_completion_documentation,
1423 );
1424 merge(&mut settings.completions, src.completions);
1425}
1426
1427/// Allows to enable/disable formatting with Prettier
1428/// and configure default Prettier, used when no project-level Prettier installation is found.
1429/// Prettier formatting is disabled by default.
1430#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1431pub struct PrettierSettings {
1432 /// Enables or disables formatting with Prettier for a given language.
1433 #[serde(default)]
1434 pub allowed: bool,
1435
1436 /// Forces Prettier integration to use a specific parser name when formatting files with the language.
1437 #[serde(default)]
1438 pub parser: Option<String>,
1439
1440 /// Forces Prettier integration to use specific plugins when formatting files with the language.
1441 /// The default Prettier will be installed with these plugins.
1442 #[serde(default)]
1443 pub plugins: HashSet<String>,
1444
1445 /// Default Prettier options, in the format as in package.json section for Prettier.
1446 /// If project installs Prettier via its package.json, these options will be ignored.
1447 #[serde(flatten)]
1448 pub options: HashMap<String, serde_json::Value>,
1449}
1450
1451#[derive(Default, Debug, Clone, PartialEq, Eq, Serialize, Deserialize, JsonSchema)]
1452pub struct JsxTagAutoCloseSettings {
1453 /// Enables or disables auto-closing of JSX tags.
1454 #[serde(default)]
1455 pub enabled: bool,
1456}
1457
1458#[cfg(test)]
1459mod tests {
1460 use gpui::TestAppContext;
1461
1462 use super::*;
1463
1464 #[test]
1465 fn test_formatter_deserialization() {
1466 let raw_auto = "{\"formatter\": \"auto\"}";
1467 let settings: LanguageSettingsContent = serde_json::from_str(raw_auto).unwrap();
1468 assert_eq!(settings.formatter, Some(SelectedFormatter::Auto));
1469 let raw = "{\"formatter\": \"language_server\"}";
1470 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1471 assert_eq!(
1472 settings.formatter,
1473 Some(SelectedFormatter::List(FormatterList(
1474 Formatter::LanguageServer { name: None }.into()
1475 )))
1476 );
1477 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}]}";
1478 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1479 assert_eq!(
1480 settings.formatter,
1481 Some(SelectedFormatter::List(FormatterList(
1482 vec![Formatter::LanguageServer { name: None }].into()
1483 )))
1484 );
1485 let raw = "{\"formatter\": [{\"language_server\": {\"name\": null}}, \"prettier\"]}";
1486 let settings: LanguageSettingsContent = serde_json::from_str(raw).unwrap();
1487 assert_eq!(
1488 settings.formatter,
1489 Some(SelectedFormatter::List(FormatterList(
1490 vec![
1491 Formatter::LanguageServer { name: None },
1492 Formatter::Prettier
1493 ]
1494 .into()
1495 )))
1496 );
1497 }
1498
1499 #[test]
1500 fn test_formatter_deserialization_invalid() {
1501 let raw_auto = "{\"formatter\": {}}";
1502 let result: Result<LanguageSettingsContent, _> = serde_json::from_str(raw_auto);
1503 assert!(result.is_err());
1504 }
1505
1506 #[gpui::test]
1507 fn test_edit_predictions_enabled_for_file(cx: &mut TestAppContext) {
1508 use crate::TestFile;
1509 use std::path::PathBuf;
1510
1511 let cx = cx.app.borrow_mut();
1512
1513 let build_settings = |globs: &[&str]| -> EditPredictionSettings {
1514 EditPredictionSettings {
1515 disabled_globs: globs
1516 .iter()
1517 .map(|glob_str| {
1518 #[cfg(windows)]
1519 let glob_str = {
1520 let mut g = String::new();
1521
1522 if glob_str.starts_with('/') {
1523 g.push_str("C:");
1524 }
1525
1526 g.push_str(&glob_str.replace('/', "\\"));
1527 g
1528 };
1529 #[cfg(windows)]
1530 let glob_str = glob_str.as_str();
1531
1532 DisabledGlob {
1533 matcher: globset::Glob::new(glob_str).unwrap().compile_matcher(),
1534 is_absolute: Path::new(glob_str).is_absolute(),
1535 }
1536 })
1537 .collect(),
1538 ..Default::default()
1539 }
1540 };
1541
1542 const WORKTREE_NAME: &str = "project";
1543 let make_test_file = |segments: &[&str]| -> Arc<dyn File> {
1544 let mut path_buf = PathBuf::new();
1545 path_buf.extend(segments);
1546
1547 Arc::new(TestFile {
1548 path: path_buf.as_path().into(),
1549 root_name: WORKTREE_NAME.to_string(),
1550 local_root: Some(PathBuf::from(if cfg!(windows) {
1551 "C:\\absolute\\"
1552 } else {
1553 "/absolute/"
1554 })),
1555 })
1556 };
1557
1558 let test_file = make_test_file(&["src", "test", "file.rs"]);
1559
1560 // Test relative globs
1561 let settings = build_settings(&["*.rs"]);
1562 assert!(!settings.enabled_for_file(&test_file, &cx));
1563 let settings = build_settings(&["*.txt"]);
1564 assert!(settings.enabled_for_file(&test_file, &cx));
1565
1566 // Test absolute globs
1567 let settings = build_settings(&["/absolute/**/*.rs"]);
1568 assert!(!settings.enabled_for_file(&test_file, &cx));
1569 let settings = build_settings(&["/other/**/*.rs"]);
1570 assert!(settings.enabled_for_file(&test_file, &cx));
1571
1572 // Test exact path match relative
1573 let settings = build_settings(&["src/test/file.rs"]);
1574 assert!(!settings.enabled_for_file(&test_file, &cx));
1575 let settings = build_settings(&["src/test/otherfile.rs"]);
1576 assert!(settings.enabled_for_file(&test_file, &cx));
1577
1578 // Test exact path match absolute
1579 let settings = build_settings(&[&format!("/absolute/{}/src/test/file.rs", WORKTREE_NAME)]);
1580 assert!(!settings.enabled_for_file(&test_file, &cx));
1581 let settings = build_settings(&["/other/test/otherfile.rs"]);
1582 assert!(settings.enabled_for_file(&test_file, &cx));
1583
1584 // Test * glob
1585 let settings = build_settings(&["*"]);
1586 assert!(!settings.enabled_for_file(&test_file, &cx));
1587 let settings = build_settings(&["*.txt"]);
1588 assert!(settings.enabled_for_file(&test_file, &cx));
1589
1590 // Test **/* glob
1591 let settings = build_settings(&["**/*"]);
1592 assert!(!settings.enabled_for_file(&test_file, &cx));
1593 let settings = build_settings(&["other/**/*"]);
1594 assert!(settings.enabled_for_file(&test_file, &cx));
1595
1596 // Test directory/** glob
1597 let settings = build_settings(&["src/**"]);
1598 assert!(!settings.enabled_for_file(&test_file, &cx));
1599
1600 let test_file_root: Arc<dyn File> = Arc::new(TestFile {
1601 path: PathBuf::from("file.rs").as_path().into(),
1602 root_name: WORKTREE_NAME.to_string(),
1603 local_root: Some(PathBuf::from("/absolute/")),
1604 });
1605 assert!(settings.enabled_for_file(&test_file_root, &cx));
1606
1607 let settings = build_settings(&["other/**"]);
1608 assert!(settings.enabled_for_file(&test_file, &cx));
1609
1610 // Test **/directory/* glob
1611 let settings = build_settings(&["**/test/*"]);
1612 assert!(!settings.enabled_for_file(&test_file, &cx));
1613 let settings = build_settings(&["**/other/*"]);
1614 assert!(settings.enabled_for_file(&test_file, &cx));
1615
1616 // Test multiple globs
1617 let settings = build_settings(&["*.rs", "*.txt", "src/**"]);
1618 assert!(!settings.enabled_for_file(&test_file, &cx));
1619 let settings = build_settings(&["*.txt", "*.md", "other/**"]);
1620 assert!(settings.enabled_for_file(&test_file, &cx));
1621
1622 // Test dot files
1623 let dot_file = make_test_file(&[".config", "settings.json"]);
1624 let settings = build_settings(&[".*/**"]);
1625 assert!(!settings.enabled_for_file(&dot_file, &cx));
1626
1627 let dot_env_file = make_test_file(&[".env"]);
1628 let settings = build_settings(&[".env"]);
1629 assert!(!settings.enabled_for_file(&dot_env_file, &cx));
1630 }
1631
1632 #[test]
1633 pub fn test_resolve_language_servers() {
1634 fn language_server_names(names: &[&str]) -> Vec<LanguageServerName> {
1635 names
1636 .iter()
1637 .copied()
1638 .map(|name| LanguageServerName(name.to_string().into()))
1639 .collect::<Vec<_>>()
1640 }
1641
1642 let available_language_servers = language_server_names(&[
1643 "typescript-language-server",
1644 "biome",
1645 "deno",
1646 "eslint",
1647 "tailwind",
1648 ]);
1649
1650 // A value of just `["..."]` is the same as taking all of the available language servers.
1651 assert_eq!(
1652 LanguageSettings::resolve_language_servers(
1653 &[LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()],
1654 &available_language_servers,
1655 ),
1656 available_language_servers
1657 );
1658
1659 // Referencing one of the available language servers will change its order.
1660 assert_eq!(
1661 LanguageSettings::resolve_language_servers(
1662 &[
1663 "biome".into(),
1664 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into(),
1665 "deno".into()
1666 ],
1667 &available_language_servers
1668 ),
1669 language_server_names(&[
1670 "biome",
1671 "typescript-language-server",
1672 "eslint",
1673 "tailwind",
1674 "deno",
1675 ])
1676 );
1677
1678 // Negating an available language server removes it from the list.
1679 assert_eq!(
1680 LanguageSettings::resolve_language_servers(
1681 &[
1682 "deno".into(),
1683 "!typescript-language-server".into(),
1684 "!biome".into(),
1685 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1686 ],
1687 &available_language_servers
1688 ),
1689 language_server_names(&["deno", "eslint", "tailwind"])
1690 );
1691
1692 // Adding a language server not in the list of available language servers adds it to the list.
1693 assert_eq!(
1694 LanguageSettings::resolve_language_servers(
1695 &[
1696 "my-cool-language-server".into(),
1697 LanguageSettings::REST_OF_LANGUAGE_SERVERS.into()
1698 ],
1699 &available_language_servers
1700 ),
1701 language_server_names(&[
1702 "my-cool-language-server",
1703 "typescript-language-server",
1704 "biome",
1705 "deno",
1706 "eslint",
1707 "tailwind",
1708 ])
1709 );
1710 }
1711}