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