language_settings.rs

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