crates/rust-analyzer/src/config.rs

   1 //! Config used by the language server.
   2 //!
   3 //! We currently get this config from `initialize` LSP request, which is not the
   4 //! best way to do it, but was the simplest thing we could implement.
   5 //!
   6 //! Of particular interest is the `feature_flags` hash map: while other fields
   7 //! configure the server itself, feature flags are passed into analysis, and
   8 //! tweak things like automatic insertion of `()` in completions.
   9
  10 use std::{ffi::OsString, iter, path::PathBuf};
  11
  12 use flycheck::FlycheckConfig;
  13 use ide::{
  14     AssistConfig, CompletionConfig, DiagnosticsConfig, HoverConfig, HoverDocFormat,
  15     InlayHintsConfig, JoinLinesConfig,
  16 };
  17 use ide_db::helpers::{
  18     insert_use::{ImportGranularity, InsertUseConfig, PrefixKind},
  19     SnippetCap,
  20 };
  21 use lsp_types::{ClientCapabilities, MarkupKind};
  22 use project_model::{CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest, RustcSource};
  23 use rustc_hash::{FxHashMap, FxHashSet};
  24 use serde::{de::DeserializeOwned, Deserialize};
  25 use vfs::AbsPathBuf;
  26
  27 use crate::{
  28     caps::completion_item_edit_resolve, diagnostics::DiagnosticsMapConfig,
  29     line_index::OffsetEncoding, lsp_ext::supports_utf8, lsp_ext::WorkspaceSymbolSearchKind,
  30     lsp_ext::WorkspaceSymbolSearchScope,
  31 };
  32
  33 // Defines the server-side configuration of the rust-analyzer. We generate
  34 // *parts* of VS Code's `package.json` config from this.
  35 //
  36 // However, editor specific config, which the server doesn't know about, should
  37 // be specified directly in `package.json`.
  38 //
  39 // To deprecate an option by replacing it with another name use `new_name | `old_name` so that we keep
  40 // parsing the old name.
  41 config_data! {
  42     struct ConfigData {
  43         /// How imports should be grouped into use statements.
  44         assist_importGranularity |
  45         assist_importMergeBehavior |
  46         assist_importMergeBehaviour: ImportGranularityDef  = "\"crate\"",
  47         /// Whether to enforce the import granularity setting for all files. If set to false rust-analyzer will try to keep import styles consistent per file.
  48         assist_importEnforceGranularity: bool              = "false",
  49         /// The path structure for newly inserted paths to use.
  50         assist_importPrefix: ImportPrefixDef               = "\"plain\"",
  51         /// Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
  52         assist_importGroup: bool                           = "true",
  53         /// Whether to allow import insertion to merge new imports into single path glob imports like `use std::fmt::*;`.
  54         assist_allowMergingIntoGlobImports: bool           = "true",
  55
  56         /// Show function name and docs in parameter hints.
  57         callInfo_full: bool                                = "true",
  58
  59         /// Automatically refresh project info via `cargo metadata` on
  60         /// `Cargo.toml` changes.
  61         cargo_autoreload: bool           = "true",
  62         /// Activate all available features (`--all-features`).
  63         cargo_allFeatures: bool          = "false",
  64         /// Unsets `#[cfg(test)]` for the specified crates.
  65         cargo_unsetTest: Vec<String>   = "[\"core\"]",
  66         /// List of features to activate.
  67         cargo_features: Vec<String>      = "[]",
  68         /// Run build scripts (`build.rs`) for more precise code analysis.
  69         cargo_runBuildScripts |
  70         cargo_loadOutDirsFromCheck: bool = "true",
  71         /// Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to
  72         /// avoid compiling unnecessary things.
  73         cargo_useRustcWrapperForBuildScripts: bool = "true",
  74         /// Do not activate the `default` feature.
  75         cargo_noDefaultFeatures: bool    = "false",
  76         /// Compilation target (target triple).
  77         cargo_target: Option<String>     = "null",
  78         /// Internal config for debugging, disables loading of sysroot crates.
  79         cargo_noSysroot: bool            = "false",
  80
  81         /// Run specified `cargo check` command for diagnostics on save.
  82         checkOnSave_enable: bool                         = "true",
  83         /// Check with all features (`--all-features`).
  84         /// Defaults to `#rust-analyzer.cargo.allFeatures#`.
  85         checkOnSave_allFeatures: Option<bool>            = "null",
  86         /// Check all targets and tests (`--all-targets`).
  87         checkOnSave_allTargets: bool                     = "true",
  88         /// Cargo command to use for `cargo check`.
  89         checkOnSave_command: String                      = "\"check\"",
  90         /// Do not activate the `default` feature.
  91         checkOnSave_noDefaultFeatures: Option<bool>      = "null",
  92         /// Check for a specific target. Defaults to
  93         /// `#rust-analyzer.cargo.target#`.
  94         checkOnSave_target: Option<String>               = "null",
  95         /// Extra arguments for `cargo check`.
  96         checkOnSave_extraArgs: Vec<String>               = "[]",
  97         /// List of features to activate. Defaults to
  98         /// `#rust-analyzer.cargo.features#`.
  99         checkOnSave_features: Option<Vec<String>>        = "null",
 100         /// Advanced option, fully override the command rust-analyzer uses for
 101         /// checking. The command should include `--message-format=json` or
 102         /// similar option.
 103         checkOnSave_overrideCommand: Option<Vec<String>> = "null",
 104
 105         /// Whether to add argument snippets when completing functions.
 106         /// Only applies when `#rust-analyzer.completion.addCallParenthesis#` is set.
 107         completion_addCallArgumentSnippets: bool = "true",
 108         /// Whether to add parenthesis when completing functions.
 109         completion_addCallParenthesis: bool      = "true",
 110         /// Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
 111         completion_postfix_enable: bool          = "true",
 112         /// Toggles the additional completions that automatically add imports when completed.
 113         /// Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
 114         completion_autoimport_enable: bool       = "true",
 115         /// Toggles the additional completions that automatically show method calls and field accesses
 116         /// with `self` prefixed to them when inside a method.
 117         completion_autoself_enable: bool       = "true",
 118
 119         /// Whether to show native rust-analyzer diagnostics.
 120         diagnostics_enable: bool                = "true",
 121         /// Whether to show experimental rust-analyzer diagnostics that might
 122         /// have more false positives than usual.
 123         diagnostics_enableExperimental: bool    = "true",
 124         /// List of rust-analyzer diagnostics to disable.
 125         diagnostics_disabled: FxHashSet<String> = "[]",
 126         /// Map of prefixes to be substituted when parsing diagnostic file paths.
 127         /// This should be the reverse mapping of what is passed to `rustc` as `--remap-path-prefix`.
 128         diagnostics_remapPrefix: FxHashMap<String, String> = "{}",
 129         /// List of warnings that should be displayed with hint severity.
 130         ///
 131         /// The warnings will be indicated by faded text or three dots in code
 132         /// and will not show up in the `Problems Panel`.
 133         diagnostics_warningsAsHint: Vec<String> = "[]",
 134         /// List of warnings that should be displayed with info severity.
 135         ///
 136         /// The warnings will be indicated by a blue squiggly underline in code
 137         /// and a blue icon in the `Problems Panel`.
 138         diagnostics_warningsAsInfo: Vec<String> = "[]",
 139
 140         /// Expand attribute macros.
 141         experimental_procAttrMacros: bool = "false",
 142
 143         /// Controls file watching implementation.
 144         files_watcher: String = "\"client\"",
 145         /// These directories will be ignored by rust-analyzer. They are
 146         /// relative to the workspace root, and globs are not supported. You may
 147         /// also need to add the folders to Code's `files.watcherExclude`.
 148         files_excludeDirs: Vec<PathBuf> = "[]",
 149
 150         /// Use semantic tokens for strings.
 151         ///
 152         /// In some editors (e.g. vscode) semantic tokens override other highlighting grammars.
 153         /// By disabling semantic tokens for strings, other grammars can be used to highlight
 154         /// their contents.
 155         highlighting_strings: bool = "true",
 156
 157         /// Whether to show documentation on hover.
 158         hover_documentation: bool       = "true",
 159         /// Use markdown syntax for links in hover.
 160         hover_linksInHover |
 161         hoverActions_linksInHover: bool = "true",
 162
 163         /// Whether to show `Debug` action. Only applies when
 164         /// `#rust-analyzer.hoverActions.enable#` is set.
 165         hoverActions_debug: bool           = "true",
 166         /// Whether to show HoverActions in Rust files.
 167         hoverActions_enable: bool          = "true",
 168         /// Whether to show `Go to Type Definition` action. Only applies when
 169         /// `#rust-analyzer.hoverActions.enable#` is set.
 170         hoverActions_gotoTypeDef: bool     = "true",
 171         /// Whether to show `Implementations` action. Only applies when
 172         /// `#rust-analyzer.hoverActions.enable#` is set.
 173         hoverActions_implementations: bool = "true",
 174         /// Whether to show `References` action. Only applies when
 175         /// `#rust-analyzer.hoverActions.enable#` is set.
 176         hoverActions_references: bool      = "false",
 177         /// Whether to show `Run` action. Only applies when
 178         /// `#rust-analyzer.hoverActions.enable#` is set.
 179         hoverActions_run: bool             = "true",
 180
 181         /// Whether to show inlay type hints for method chains.
 182         inlayHints_chainingHints: bool      = "true",
 183         /// Maximum length for inlay hints. Set to null to have an unlimited length.
 184         inlayHints_maxLength: Option<usize> = "25",
 185         /// Whether to show function parameter name inlay hints at the call
 186         /// site.
 187         inlayHints_parameterHints: bool     = "true",
 188         /// Whether to show inlay type hints for variables.
 189         inlayHints_typeHints: bool          = "true",
 190
 191         /// Join lines inserts else between consecutive ifs.
 192         joinLines_joinElseIf: bool = "true",
 193         /// Join lines removes trailing commas.
 194         joinLines_removeTrailingComma: bool = "true",
 195         /// Join lines unwraps trivial blocks.
 196         joinLines_unwrapTrivialBlock: bool = "true",
 197
 198         /// Whether to show `Debug` lens. Only applies when
 199         /// `#rust-analyzer.lens.enable#` is set.
 200         lens_debug: bool            = "true",
 201         /// Whether to show CodeLens in Rust files.
 202         lens_enable: bool           = "true",
 203         /// Whether to show `Implementations` lens. Only applies when
 204         /// `#rust-analyzer.lens.enable#` is set.
 205         lens_implementations: bool  = "true",
 206         /// Whether to show `Run` lens. Only applies when
 207         /// `#rust-analyzer.lens.enable#` is set.
 208         lens_run: bool              = "true",
 209         /// Whether to show `Method References` lens. Only applies when
 210         /// `#rust-analyzer.lens.enable#` is set.
 211         lens_methodReferences: bool = "false",
 212         /// Whether to show `References` lens. Only applies when
 213         /// `#rust-analyzer.lens.enable#` is set.
 214         lens_references: bool = "false",
 215
 216         /// Disable project auto-discovery in favor of explicitly specified set
 217         /// of projects.
 218         ///
 219         /// Elements must be paths pointing to `Cargo.toml`,
 220         /// `rust-project.json`, or JSON objects in `rust-project.json` format.
 221         linkedProjects: Vec<ManifestOrProjectJson> = "[]",
 222
 223         /// Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
 224         lruCapacity: Option<usize>                 = "null",
 225
 226         /// Whether to show `can't find Cargo.toml` error message.
 227         notifications_cargoTomlNotFound: bool      = "true",
 228
 229         /// Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
 230         procMacro_enable: bool                     = "true",
 231         /// Internal config, path to proc-macro server executable (typically,
 232         /// this is rust-analyzer itself, but we override this in tests).
 233         procMacro_server: Option<PathBuf>          = "null",
 234
 235         /// Command to be executed instead of 'cargo' for runnables.
 236         runnables_overrideCargo: Option<String> = "null",
 237         /// Additional arguments to be passed to cargo for runnables such as
 238         /// tests or binaries. For example, it may be `--release`.
 239         runnables_cargoExtraArgs: Vec<String>   = "[]",
 240
 241         /// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
 242         /// projects, or "discover" to try to automatically find it.
 243         ///
 244         /// Any project which uses rust-analyzer with the rustcPrivate
 245         /// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
 246         ///
 247         /// This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
 248         rustcSource: Option<String> = "null",
 249
 250         /// Additional arguments to `rustfmt`.
 251         rustfmt_extraArgs: Vec<String>               = "[]",
 252         /// Advanced option, fully override the command rust-analyzer uses for
 253         /// formatting.
 254         rustfmt_overrideCommand: Option<Vec<String>> = "null",
 255         /// Enables the use of rustfmt's unstable range formatting command for the
 256         /// `textDocument/rangeFormatting` request. The rustfmt option is unstable and only
 257         /// available on a nightly build.
 258         rustfmt_enableRangeFormatting: bool = "false",
 259
 260         /// Workspace symbol search scope.
 261         workspace_symbol_search_scope: WorskpaceSymbolSearchScopeDef = "\"workspace\"",
 262         /// Workspace symbol search kind.
 263         workspace_symbol_search_kind: WorskpaceSymbolSearchKindDef = "\"only_types\"",
 264     }
 265 }
 266
 267 impl Default for ConfigData {
 268     fn default() -> Self {
 269         ConfigData::from_json(serde_json::Value::Null)
 270     }
 271 }
 272
 273 #[derive(Debug, Clone)]
 274 pub struct Config {
 275     pub caps: lsp_types::ClientCapabilities,
 276     data: ConfigData,
 277     detached_files: Vec<AbsPathBuf>,
 278     pub discovered_projects: Option<Vec<ProjectManifest>>,
 279     pub root_path: AbsPathBuf,
 280 }
 281
 282 #[derive(Debug, Clone, Eq, PartialEq)]
 283 pub enum LinkedProject {
 284     ProjectManifest(ProjectManifest),
 285     InlineJsonProject(ProjectJson),
 286 }
 287
 288 impl From<ProjectManifest> for LinkedProject {
 289     fn from(v: ProjectManifest) -> Self {
 290         LinkedProject::ProjectManifest(v)
 291     }
 292 }
 293
 294 impl From<ProjectJson> for LinkedProject {
 295     fn from(v: ProjectJson) -> Self {
 296         LinkedProject::InlineJsonProject(v)
 297     }
 298 }
 299
 300 #[derive(Clone, Debug, PartialEq, Eq)]
 301 pub struct LensConfig {
 302     pub run: bool,
 303     pub debug: bool,
 304     pub implementations: bool,
 305     pub method_refs: bool,
 306     pub refs: bool, // for Struct, Enum, Union and Trait
 307 }
 308
 309 impl LensConfig {
 310     pub fn any(&self) -> bool {
 311         self.implementations || self.runnable() || self.references()
 312     }
 313
 314     pub fn none(&self) -> bool {
 315         !self.any()
 316     }
 317
 318     pub fn runnable(&self) -> bool {
 319         self.run || self.debug
 320     }
 321
 322     pub fn references(&self) -> bool {
 323         self.method_refs || self.refs
 324     }
 325 }
 326
 327 #[derive(Clone, Debug, PartialEq, Eq)]
 328 pub struct HoverActionsConfig {
 329     pub implementations: bool,
 330     pub references: bool,
 331     pub run: bool,
 332     pub debug: bool,
 333     pub goto_type_def: bool,
 334 }
 335
 336 impl HoverActionsConfig {
 337     pub const NO_ACTIONS: Self = Self {
 338         implementations: false,
 339         references: false,
 340         run: false,
 341         debug: false,
 342         goto_type_def: false,
 343     };
 344
 345     pub fn any(&self) -> bool {
 346         self.implementations || self.references || self.runnable() || self.goto_type_def
 347     }
 348
 349     pub fn none(&self) -> bool {
 350         !self.any()
 351     }
 352
 353     pub fn runnable(&self) -> bool {
 354         self.run || self.debug
 355     }
 356 }
 357
 358 #[derive(Debug, Clone)]
 359 pub struct FilesConfig {
 360     pub watcher: FilesWatcher,
 361     pub exclude: Vec<AbsPathBuf>,
 362 }
 363
 364 #[derive(Debug, Clone)]
 365 pub enum FilesWatcher {
 366     Client,
 367     Notify,
 368 }
 369
 370 #[derive(Debug, Clone)]
 371 pub struct NotificationsConfig {
 372     pub cargo_toml_not_found: bool,
 373 }
 374
 375 #[derive(Debug, Clone)]
 376 pub enum RustfmtConfig {
 377     Rustfmt { extra_args: Vec<String>, enable_range_formatting: bool },
 378     CustomCommand { command: String, args: Vec<String> },
 379 }
 380
 381 /// Configuration for runnable items, such as `main` function or tests.
 382 #[derive(Debug, Clone)]
 383 pub struct RunnablesConfig {
 384     /// Custom command to be executed instead of `cargo` for runnables.
 385     pub override_cargo: Option<String>,
 386     /// Additional arguments for the `cargo`, e.g. `--release`.
 387     pub cargo_extra_args: Vec<String>,
 388 }
 389
 390 /// Configuration for workspace symbol search requests.
 391 #[derive(Debug, Clone)]
 392 pub struct WorkspaceSymbolConfig {
 393     /// In what scope should the symbol be searched in.
 394     pub search_scope: WorkspaceSymbolSearchScope,
 395     /// What kind of symbol is being search for.
 396     pub search_kind: WorkspaceSymbolSearchKind,
 397 }
 398
 399 impl Config {
 400     pub fn new(root_path: AbsPathBuf, caps: ClientCapabilities) -> Self {
 401         Config {
 402             caps,
 403             data: ConfigData::default(),
 404             detached_files: Vec::new(),
 405             discovered_projects: None,
 406             root_path,
 407         }
 408     }
 409     pub fn update(&mut self, mut json: serde_json::Value) {
 410         log::info!("updating config from JSON: {:#}", json);
 411         if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
 412             return;
 413         }
 414         self.detached_files = get_field::<Vec<PathBuf>>(&mut json, "detachedFiles", None, "[]")
 415             .into_iter()
 416             .map(AbsPathBuf::assert)
 417             .collect();
 418         self.data = ConfigData::from_json(json);
 419     }
 420
 421     pub fn json_schema() -> serde_json::Value {
 422         ConfigData::json_schema()
 423     }
 424 }
 425
 426 macro_rules! try_ {
 427     ($expr:expr) => {
 428         || -> _ { Some($expr) }()
 429     };
 430 }
 431 macro_rules! try_or {
 432     ($expr:expr, $or:expr) => {
 433         try_!($expr).unwrap_or($or)
 434     };
 435 }
 436
 437 impl Config {
 438     pub fn linked_projects(&self) -> Vec<LinkedProject> {
 439         if self.data.linkedProjects.is_empty() {
 440             self.discovered_projects
 441                 .as_ref()
 442                 .into_iter()
 443                 .flatten()
 444                 .cloned()
 445                 .map(LinkedProject::from)
 446                 .collect()
 447         } else {
 448             self.data
 449                 .linkedProjects
 450                 .iter()
 451                 .filter_map(|linked_project| {
 452                     let res = match linked_project {
 453                         ManifestOrProjectJson::Manifest(it) => {
 454                             let path = self.root_path.join(it);
 455                             ProjectManifest::from_manifest_file(path)
 456                                 .map_err(|e| log::error!("failed to load linked project: {}", e))
 457                                 .ok()?
 458                                 .into()
 459                         }
 460                         ManifestOrProjectJson::ProjectJson(it) => {
 461                             ProjectJson::new(&self.root_path, it.clone()).into()
 462                         }
 463                     };
 464                     Some(res)
 465                 })
 466                 .collect()
 467         }
 468     }
 469
 470     pub fn detached_files(&self) -> &[AbsPathBuf] {
 471         &self.detached_files
 472     }
 473
 474     pub fn did_save_text_document_dynamic_registration(&self) -> bool {
 475         let caps =
 476             try_or!(self.caps.text_document.as_ref()?.synchronization.clone()?, Default::default());
 477         caps.did_save == Some(true) && caps.dynamic_registration == Some(true)
 478     }
 479     pub fn did_change_watched_files_dynamic_registration(&self) -> bool {
 480         try_or!(
 481             self.caps.workspace.as_ref()?.did_change_watched_files.as_ref()?.dynamic_registration?,
 482             false
 483         )
 484     }
 485
 486     pub fn location_link(&self) -> bool {
 487         try_or!(self.caps.text_document.as_ref()?.definition?.link_support?, false)
 488     }
 489     pub fn line_folding_only(&self) -> bool {
 490         try_or!(self.caps.text_document.as_ref()?.folding_range.as_ref()?.line_folding_only?, false)
 491     }
 492     pub fn hierarchical_symbols(&self) -> bool {
 493         try_or!(
 494             self.caps
 495                 .text_document
 496                 .as_ref()?
 497                 .document_symbol
 498                 .as_ref()?
 499                 .hierarchical_document_symbol_support?,
 500             false
 501         )
 502     }
 503     pub fn code_action_literals(&self) -> bool {
 504         try_!(self
 505             .caps
 506             .text_document
 507             .as_ref()?
 508             .code_action
 509             .as_ref()?
 510             .code_action_literal_support
 511             .as_ref()?)
 512         .is_some()
 513     }
 514     pub fn work_done_progress(&self) -> bool {
 515         try_or!(self.caps.window.as_ref()?.work_done_progress?, false)
 516     }
 517     pub fn will_rename(&self) -> bool {
 518         try_or!(self.caps.workspace.as_ref()?.file_operations.as_ref()?.will_rename?, false)
 519     }
 520     pub fn change_annotation_support(&self) -> bool {
 521         try_!(self
 522             .caps
 523             .workspace
 524             .as_ref()?
 525             .workspace_edit
 526             .as_ref()?
 527             .change_annotation_support
 528             .as_ref()?)
 529         .is_some()
 530     }
 531     pub fn code_action_resolve(&self) -> bool {
 532         try_or!(
 533             self.caps
 534                 .text_document
 535                 .as_ref()?
 536                 .code_action
 537                 .as_ref()?
 538                 .resolve_support
 539                 .as_ref()?
 540                 .properties
 541                 .as_slice(),
 542             &[]
 543         )
 544         .iter()
 545         .any(|it| it == "edit")
 546     }
 547     pub fn signature_help_label_offsets(&self) -> bool {
 548         try_or!(
 549             self.caps
 550                 .text_document
 551                 .as_ref()?
 552                 .signature_help
 553                 .as_ref()?
 554                 .signature_information
 555                 .as_ref()?
 556                 .parameter_information
 557                 .as_ref()?
 558                 .label_offset_support?,
 559             false
 560         )
 561     }
 562     pub fn offset_encoding(&self) -> OffsetEncoding {
 563         if supports_utf8(&self.caps) {
 564             OffsetEncoding::Utf8
 565         } else {
 566             OffsetEncoding::Utf16
 567         }
 568     }
 569
 570     fn experimental(&self, index: &'static str) -> bool {
 571         try_or!(self.caps.experimental.as_ref()?.get(index)?.as_bool()?, false)
 572     }
 573     pub fn code_action_group(&self) -> bool {
 574         self.experimental("codeActionGroup")
 575     }
 576     pub fn experimental_hover_actions(&self) -> bool {
 577         self.experimental("hoverActions")
 578     }
 579     pub fn server_status_notification(&self) -> bool {
 580         self.experimental("serverStatusNotification")
 581     }
 582
 583     pub fn publish_diagnostics(&self) -> bool {
 584         self.data.diagnostics_enable
 585     }
 586     pub fn diagnostics(&self) -> DiagnosticsConfig {
 587         DiagnosticsConfig {
 588             disable_experimental: !self.data.diagnostics_enableExperimental,
 589             disabled: self.data.diagnostics_disabled.clone(),
 590         }
 591     }
 592     pub fn diagnostics_map(&self) -> DiagnosticsMapConfig {
 593         DiagnosticsMapConfig {
 594             remap_prefix: self.data.diagnostics_remapPrefix.clone(),
 595             warnings_as_info: self.data.diagnostics_warningsAsInfo.clone(),
 596             warnings_as_hint: self.data.diagnostics_warningsAsHint.clone(),
 597         }
 598     }
 599     pub fn lru_capacity(&self) -> Option<usize> {
 600         self.data.lruCapacity
 601     }
 602     pub fn proc_macro_srv(&self) -> Option<(AbsPathBuf, Vec<OsString>)> {
 603         if !self.data.procMacro_enable {
 604             return None;
 605         }
 606         let path = match &self.data.procMacro_server {
 607             Some(it) => self.root_path.join(it),
 608             None => AbsPathBuf::assert(std::env::current_exe().ok()?),
 609         };
 610         Some((path, vec!["proc-macro".into()]))
 611     }
 612     pub fn expand_proc_attr_macros(&self) -> bool {
 613         self.data.experimental_procAttrMacros
 614     }
 615     pub fn files(&self) -> FilesConfig {
 616         FilesConfig {
 617             watcher: match self.data.files_watcher.as_str() {
 618                 "notify" => FilesWatcher::Notify,
 619                 "client" | _ => FilesWatcher::Client,
 620             },
 621             exclude: self.data.files_excludeDirs.iter().map(|it| self.root_path.join(it)).collect(),
 622         }
 623     }
 624     pub fn notifications(&self) -> NotificationsConfig {
 625         NotificationsConfig { cargo_toml_not_found: self.data.notifications_cargoTomlNotFound }
 626     }
 627     pub fn cargo_autoreload(&self) -> bool {
 628         self.data.cargo_autoreload
 629     }
 630     pub fn run_build_scripts(&self) -> bool {
 631         self.data.cargo_runBuildScripts || self.data.procMacro_enable
 632     }
 633     pub fn cargo(&self) -> CargoConfig {
 634         let rustc_source = self.data.rustcSource.as_ref().map(|rustc_src| {
 635             if rustc_src == "discover" {
 636                 RustcSource::Discover
 637             } else {
 638                 RustcSource::Path(self.root_path.join(rustc_src))
 639             }
 640         });
 641
 642         CargoConfig {
 643             no_default_features: self.data.cargo_noDefaultFeatures,
 644             all_features: self.data.cargo_allFeatures,
 645             features: self.data.cargo_features.clone(),
 646             target: self.data.cargo_target.clone(),
 647             rustc_source,
 648             no_sysroot: self.data.cargo_noSysroot,
 649             unset_test_crates: self.data.cargo_unsetTest.clone(),
 650             wrap_rustc_in_build_scripts: self.data.cargo_useRustcWrapperForBuildScripts,
 651         }
 652     }
 653
 654     pub fn rustfmt(&self) -> RustfmtConfig {
 655         match &self.data.rustfmt_overrideCommand {
 656             Some(args) if !args.is_empty() => {
 657                 let mut args = args.clone();
 658                 let command = args.remove(0);
 659                 RustfmtConfig::CustomCommand { command, args }
 660             }
 661             Some(_) | None => RustfmtConfig::Rustfmt {
 662                 extra_args: self.data.rustfmt_extraArgs.clone(),
 663                 enable_range_formatting: self.data.rustfmt_enableRangeFormatting,
 664             },
 665         }
 666     }
 667     pub fn flycheck(&self) -> Option<FlycheckConfig> {
 668         if !self.data.checkOnSave_enable {
 669             return None;
 670         }
 671         let flycheck_config = match &self.data.checkOnSave_overrideCommand {
 672             Some(args) if !args.is_empty() => {
 673                 let mut args = args.clone();
 674                 let command = args.remove(0);
 675                 FlycheckConfig::CustomCommand { command, args }
 676             }
 677             Some(_) | None => FlycheckConfig::CargoCommand {
 678                 command: self.data.checkOnSave_command.clone(),
 679                 target_triple: self
 680                     .data
 681                     .checkOnSave_target
 682                     .clone()
 683                     .or_else(|| self.data.cargo_target.clone()),
 684                 all_targets: self.data.checkOnSave_allTargets,
 685                 no_default_features: self
 686                     .data
 687                     .checkOnSave_noDefaultFeatures
 688                     .unwrap_or(self.data.cargo_noDefaultFeatures),
 689                 all_features: self
 690                     .data
 691                     .checkOnSave_allFeatures
 692                     .unwrap_or(self.data.cargo_allFeatures),
 693                 features: self
 694                     .data
 695                     .checkOnSave_features
 696                     .clone()
 697                     .unwrap_or_else(|| self.data.cargo_features.clone()),
 698                 extra_args: self.data.checkOnSave_extraArgs.clone(),
 699             },
 700         };
 701         Some(flycheck_config)
 702     }
 703     pub fn runnables(&self) -> RunnablesConfig {
 704         RunnablesConfig {
 705             override_cargo: self.data.runnables_overrideCargo.clone(),
 706             cargo_extra_args: self.data.runnables_cargoExtraArgs.clone(),
 707         }
 708     }
 709     pub fn inlay_hints(&self) -> InlayHintsConfig {
 710         InlayHintsConfig {
 711             type_hints: self.data.inlayHints_typeHints,
 712             parameter_hints: self.data.inlayHints_parameterHints,
 713             chaining_hints: self.data.inlayHints_chainingHints,
 714             max_length: self.data.inlayHints_maxLength,
 715         }
 716     }
 717     fn insert_use_config(&self) -> InsertUseConfig {
 718         InsertUseConfig {
 719             granularity: match self.data.assist_importGranularity {
 720                 ImportGranularityDef::Preserve => ImportGranularity::Preserve,
 721                 ImportGranularityDef::Item => ImportGranularity::Item,
 722                 ImportGranularityDef::Crate => ImportGranularity::Crate,
 723                 ImportGranularityDef::Module => ImportGranularity::Module,
 724             },
 725             enforce_granularity: self.data.assist_importEnforceGranularity,
 726             prefix_kind: match self.data.assist_importPrefix {
 727                 ImportPrefixDef::Plain => PrefixKind::Plain,
 728                 ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
 729                 ImportPrefixDef::BySelf => PrefixKind::BySelf,
 730             },
 731             group: self.data.assist_importGroup,
 732             skip_glob_imports: !self.data.assist_allowMergingIntoGlobImports,
 733         }
 734     }
 735     pub fn completion(&self) -> CompletionConfig {
 736         CompletionConfig {
 737             enable_postfix_completions: self.data.completion_postfix_enable,
 738             enable_imports_on_the_fly: self.data.completion_autoimport_enable
 739                 && completion_item_edit_resolve(&self.caps),
 740             enable_self_on_the_fly: self.data.completion_autoself_enable,
 741             add_call_parenthesis: self.data.completion_addCallParenthesis,
 742             add_call_argument_snippets: self.data.completion_addCallArgumentSnippets,
 743             insert_use: self.insert_use_config(),
 744             snippet_cap: SnippetCap::new(try_or!(
 745                 self.caps
 746                     .text_document
 747                     .as_ref()?
 748                     .completion
 749                     .as_ref()?
 750                     .completion_item
 751                     .as_ref()?
 752                     .snippet_support?,
 753                 false
 754             )),
 755         }
 756     }
 757     pub fn assist(&self) -> AssistConfig {
 758         AssistConfig {
 759             snippet_cap: SnippetCap::new(self.experimental("snippetTextEdit")),
 760             allowed: None,
 761             insert_use: self.insert_use_config(),
 762         }
 763     }
 764     pub fn join_lines(&self) -> JoinLinesConfig {
 765         JoinLinesConfig {
 766             join_else_if: self.data.joinLines_joinElseIf,
 767             remove_trailing_comma: self.data.joinLines_removeTrailingComma,
 768             unwrap_trivial_blocks: self.data.joinLines_unwrapTrivialBlock,
 769         }
 770     }
 771     pub fn call_info_full(&self) -> bool {
 772         self.data.callInfo_full
 773     }
 774     pub fn lens(&self) -> LensConfig {
 775         LensConfig {
 776             run: self.data.lens_enable && self.data.lens_run,
 777             debug: self.data.lens_enable && self.data.lens_debug,
 778             implementations: self.data.lens_enable && self.data.lens_implementations,
 779             method_refs: self.data.lens_enable && self.data.lens_methodReferences,
 780             refs: self.data.lens_enable && self.data.lens_references,
 781         }
 782     }
 783     pub fn hover_actions(&self) -> HoverActionsConfig {
 784         HoverActionsConfig {
 785             implementations: self.data.hoverActions_enable
 786                 && self.data.hoverActions_implementations,
 787             references: self.data.hoverActions_enable && self.data.hoverActions_references,
 788             run: self.data.hoverActions_enable && self.data.hoverActions_run,
 789             debug: self.data.hoverActions_enable && self.data.hoverActions_debug,
 790             goto_type_def: self.data.hoverActions_enable && self.data.hoverActions_gotoTypeDef,
 791         }
 792     }
 793     pub fn highlighting_strings(&self) -> bool {
 794         self.data.highlighting_strings
 795     }
 796     pub fn hover(&self) -> HoverConfig {
 797         HoverConfig {
 798             links_in_hover: self.data.hover_linksInHover,
 799             documentation: self.data.hover_documentation.then(|| {
 800                 let is_markdown = try_or!(
 801                     self.caps
 802                         .text_document
 803                         .as_ref()?
 804                         .hover
 805                         .as_ref()?
 806                         .content_format
 807                         .as_ref()?
 808                         .as_slice(),
 809                     &[]
 810                 )
 811                 .contains(&MarkupKind::Markdown);
 812                 if is_markdown {
 813                     HoverDocFormat::Markdown
 814                 } else {
 815                     HoverDocFormat::PlainText
 816                 }
 817             }),
 818         }
 819     }
 820
 821     pub fn workspace_symbol(&self) -> WorkspaceSymbolConfig {
 822         WorkspaceSymbolConfig {
 823             search_scope: match self.data.workspace_symbol_search_scope {
 824                 WorskpaceSymbolSearchScopeDef::Workspace => WorkspaceSymbolSearchScope::Workspace,
 825                 WorskpaceSymbolSearchScopeDef::WorkspaceAndDependencies => {
 826                     WorkspaceSymbolSearchScope::WorkspaceAndDependencies
 827                 }
 828             },
 829             search_kind: match self.data.workspace_symbol_search_kind {
 830                 WorskpaceSymbolSearchKindDef::OnlyTypes => WorkspaceSymbolSearchKind::OnlyTypes,
 831                 WorskpaceSymbolSearchKindDef::AllSymbols => WorkspaceSymbolSearchKind::AllSymbols,
 832             },
 833         }
 834     }
 835
 836     pub fn semantic_tokens_refresh(&self) -> bool {
 837         try_or!(self.caps.workspace.as_ref()?.semantic_tokens.as_ref()?.refresh_support?, false)
 838     }
 839     pub fn code_lens_refresh(&self) -> bool {
 840         try_or!(self.caps.workspace.as_ref()?.code_lens.as_ref()?.refresh_support?, false)
 841     }
 842     pub fn insert_replace_support(&self) -> bool {
 843         try_or!(
 844             self.caps
 845                 .text_document
 846                 .as_ref()?
 847                 .completion
 848                 .as_ref()?
 849                 .completion_item
 850                 .as_ref()?
 851                 .insert_replace_support?,
 852             false
 853         )
 854     }
 855 }
 856
 857 #[derive(Deserialize, Debug, Clone)]
 858 #[serde(untagged)]
 859 enum ManifestOrProjectJson {
 860     Manifest(PathBuf),
 861     ProjectJson(ProjectJsonData),
 862 }
 863
 864 #[derive(Deserialize, Debug, Clone)]
 865 #[serde(rename_all = "snake_case")]
 866 enum ImportGranularityDef {
 867     Preserve,
 868     #[serde(alias = "none")]
 869     Item,
 870     #[serde(alias = "full")]
 871     Crate,
 872     #[serde(alias = "last")]
 873     Module,
 874 }
 875
 876 #[derive(Deserialize, Debug, Clone)]
 877 #[serde(rename_all = "snake_case")]
 878 enum ImportPrefixDef {
 879     Plain,
 880     #[serde(alias = "self")]
 881     BySelf,
 882     #[serde(alias = "crate")]
 883     ByCrate,
 884 }
 885
 886 #[derive(Deserialize, Debug, Clone)]
 887 #[serde(rename_all = "snake_case")]
 888 enum WorskpaceSymbolSearchScopeDef {
 889     Workspace,
 890     WorkspaceAndDependencies,
 891 }
 892
 893 #[derive(Deserialize, Debug, Clone)]
 894 #[serde(rename_all = "snake_case")]
 895 enum WorskpaceSymbolSearchKindDef {
 896     OnlyTypes,
 897     AllSymbols,
 898 }
 899
 900 macro_rules! _config_data {
 901     (struct $name:ident {
 902         $(
 903             $(#[doc=$doc:literal])*
 904             $field:ident $(| $alias:ident)*: $ty:ty = $default:expr,
 905         )*
 906     }) => {
 907         #[allow(non_snake_case)]
 908         #[derive(Debug, Clone)]
 909         struct $name { $($field: $ty,)* }
 910         impl $name {
 911             fn from_json(mut json: serde_json::Value) -> $name {
 912                 $name {$(
 913                     $field: get_field(
 914                         &mut json,
 915                         stringify!($field),
 916                         None$(.or(Some(stringify!($alias))))*,
 917                         $default,
 918                     ),
 919                 )*}
 920             }
 921
 922             fn json_schema() -> serde_json::Value {
 923                 schema(&[
 924                     $({
 925                         let field = stringify!($field);
 926                         let ty = stringify!($ty);
 927
 928                         (field, ty, &[$($doc),*], $default)
 929                     },)*
 930                 ])
 931             }
 932
 933             #[cfg(test)]
 934             fn manual() -> String {
 935                 manual(&[
 936                     $({
 937                         let field = stringify!($field);
 938                         let ty = stringify!($ty);
 939
 940                         (field, ty, &[$($doc),*], $default)
 941                     },)*
 942                 ])
 943             }
 944         }
 945     };
 946 }
 947 use _config_data as config_data;
 948
 949 fn get_field<T: DeserializeOwned>(
 950     json: &mut serde_json::Value,
 951     field: &'static str,
 952     alias: Option<&'static str>,
 953     default: &str,
 954 ) -> T {
 955     let default = serde_json::from_str(default).unwrap();
 956
 957     // XXX: check alias first, to work-around the VS Code where it pre-fills the
 958     // defaults instead of sending an empty object.
 959     alias
 960         .into_iter()
 961         .chain(iter::once(field))
 962         .find_map(move |field| {
 963             let mut pointer = field.replace('_', "/");
 964             pointer.insert(0, '/');
 965             json.pointer_mut(&pointer).and_then(|it| serde_json::from_value(it.take()).ok())
 966         })
 967         .unwrap_or(default)
 968 }
 969
 970 fn schema(fields: &[(&'static str, &'static str, &[&str], &str)]) -> serde_json::Value {
 971     for ((f1, ..), (f2, ..)) in fields.iter().zip(&fields[1..]) {
 972         fn key(f: &str) -> &str {
 973             f.splitn(2, '_').next().unwrap()
 974         }
 975         assert!(key(f1) <= key(f2), "wrong field order: {:?} {:?}", f1, f2);
 976     }
 977
 978     let map = fields
 979         .iter()
 980         .map(|(field, ty, doc, default)| {
 981             let name = field.replace("_", ".");
 982             let name = format!("rust-analyzer.{}", name);
 983             let props = field_props(field, ty, doc, default);
 984             (name, props)
 985         })
 986         .collect::<serde_json::Map<_, _>>();
 987     map.into()
 988 }
 989
 990 fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json::Value {
 991     let doc = doc_comment_to_string(doc);
 992     let doc = doc.trim_end_matches('\n');
 993     assert!(
 994         doc.ends_with('.') && doc.starts_with(char::is_uppercase),
 995         "bad docs for {}: {:?}",
 996         field,
 997         doc
 998     );
 999     let default = default.parse::<serde_json::Value>().unwrap();
1000
1001     let mut map = serde_json::Map::default();
1002     macro_rules! set {
1003         ($($key:literal: $value:tt),*$(,)?) => {{$(
1004             map.insert($key.into(), serde_json::json!($value));
1005         )*}};
1006     }
1007     set!("markdownDescription": doc);
1008     set!("default": default);
1009
1010     match ty {
1011         "bool" => set!("type": "boolean"),
1012         "String" => set!("type": "string"),
1013         "Vec<String>" => set! {
1014             "type": "array",
1015             "items": { "type": "string" },
1016         },
1017         "Vec<PathBuf>" => set! {
1018             "type": "array",
1019             "items": { "type": "string" },
1020         },
1021         "FxHashSet<String>" => set! {
1022             "type": "array",
1023             "items": { "type": "string" },
1024             "uniqueItems": true,
1025         },
1026         "FxHashMap<String, String>" => set! {
1027             "type": "object",
1028         },
1029         "Option<usize>" => set! {
1030             "type": ["null", "integer"],
1031             "minimum": 0,
1032         },
1033         "Option<String>" => set! {
1034             "type": ["null", "string"],
1035         },
1036         "Option<PathBuf>" => set! {
1037             "type": ["null", "string"],
1038         },
1039         "Option<bool>" => set! {
1040             "type": ["null", "boolean"],
1041         },
1042         "Option<Vec<String>>" => set! {
1043             "type": ["null", "array"],
1044             "items": { "type": "string" },
1045         },
1046         "MergeBehaviorDef" => set! {
1047             "type": "string",
1048             "enum": ["none", "crate", "module"],
1049             "enumDescriptions": [
1050                 "Do not merge imports at all.",
1051                 "Merge imports from the same crate into a single `use` statement.",
1052                 "Merge imports from the same module into a single `use` statement."
1053             ],
1054         },
1055         "ImportGranularityDef" => set! {
1056             "type": "string",
1057             "enum": ["preserve", "crate", "module", "item"],
1058             "enumDescriptions": [
1059                 "Do not change the granularity of any imports and preserve the original structure written by the developer.",
1060                 "Merge imports from the same crate into a single use statement. Conversely, imports from different crates are split into separate statements.",
1061                 "Merge imports from the same module into a single use statement. Conversely, imports from different modules are split into separate statements.",
1062                 "Flatten imports so that each has its own use statement."
1063             ],
1064         },
1065         "ImportPrefixDef" => set! {
1066             "type": "string",
1067             "enum": [
1068                 "plain",
1069                 "self",
1070                 "crate"
1071             ],
1072             "enumDescriptions": [
1073                 "Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item.",
1074                 "Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item. Prefixes `self` in front of the path if it starts with a module.",
1075                 "Force import paths to be absolute by always starting them with `crate` or the extern crate name they come from."
1076             ],
1077         },
1078         "Vec<ManifestOrProjectJson>" => set! {
1079             "type": "array",
1080             "items": { "type": ["string", "object"] },
1081         },
1082         "WorskpaceSymbolSearchScopeDef" => set! {
1083             "type": "string",
1084             "enum": ["workspace", "workspace_and_dependencies"],
1085             "enumDescriptions": [
1086                 "Search in current workspace only",
1087                 "Search in current workspace and dependencies"
1088             ],
1089         },
1090         "WorskpaceSymbolSearchKindDef" => set! {
1091             "type": "string",
1092             "enum": ["only_types", "all_symbols"],
1093             "enumDescriptions": [
1094                 "Search for types only",
1095                 "Search for all symbols kinds"
1096             ],
1097         },
1098         _ => panic!("{}: {}", ty, default),
1099     }
1100
1101     map.into()
1102 }
1103
1104 #[cfg(test)]
1105 fn manual(fields: &[(&'static str, &'static str, &[&str], &str)]) -> String {
1106     fields
1107         .iter()
1108         .map(|(field, _ty, doc, default)| {
1109             let name = format!("rust-analyzer.{}", field.replace("_", "."));
1110             let doc = doc_comment_to_string(*doc);
1111             format!("[[{}]]{} (default: `{}`)::\n+\n--\n{}--\n", name, name, default, doc)
1112         })
1113         .collect::<String>()
1114 }
1115
1116 fn doc_comment_to_string(doc: &[&str]) -> String {
1117     doc.iter().map(|it| it.strip_prefix(' ').unwrap_or(it)).map(|it| format!("{}\n", it)).collect()
1118 }
1119
1120 #[cfg(test)]
1121 mod tests {
1122     use std::fs;
1123
1124     use test_utils::{ensure_file_contents, project_root};
1125
1126     use super::*;
1127
1128     #[test]
1129     fn generate_package_json_config() {
1130         let s = Config::json_schema();
1131         let schema = format!("{:#}", s);
1132         let mut schema = schema
1133             .trim_start_matches('{')
1134             .trim_end_matches('}')
1135             .replace("  ", "    ")
1136             .replace("\n", "\n            ")
1137             .trim_start_matches('\n')
1138             .trim_end()
1139             .to_string();
1140         schema.push_str(",\n");
1141
1142         let package_json_path = project_root().join("editors/code/package.json");
1143         let mut package_json = fs::read_to_string(&package_json_path).unwrap();
1144
1145         let start_marker = "                \"$generated-start\": {},\n";
1146         let end_marker = "                \"$generated-end\": {}\n";
1147
1148         let start = package_json.find(start_marker).unwrap() + start_marker.len();
1149         let end = package_json.find(end_marker).unwrap();
1150
1151         let p = remove_ws(&package_json[start..end]);
1152         let s = remove_ws(&schema);
1153         if !p.contains(&s) {
1154             package_json.replace_range(start..end, &schema);
1155             ensure_file_contents(&package_json_path, &package_json)
1156         }
1157     }
1158
1159     #[test]
1160     fn generate_config_documentation() {
1161         let docs_path = project_root().join("docs/user/generated_config.adoc");
1162         let expected = ConfigData::manual();
1163         ensure_file_contents(&docs_path, &expected);
1164     }
1165
1166     fn remove_ws(text: &str) -> String {
1167         text.replace(char::is_whitespace, "")
1168     }
1169 }