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