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