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::{convert::TryFrom, ffi::OsString, path::PathBuf};
  11
  12 use flycheck::FlycheckConfig;
  13 use hir::PrefixKind;
  14 use ide::{
  15     AssistConfig, CompletionConfig, DiagnosticsConfig, HoverConfig, InlayHintsConfig,
  16     MergeBehaviour,
  17 };
  18 use lsp_types::{ClientCapabilities, MarkupKind};
  19 use project_model::{CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest};
  20 use rustc_hash::FxHashSet;
  21 use serde::Deserialize;
  22 use vfs::AbsPathBuf;
  23
  24 use crate::diagnostics::DiagnosticsMapConfig;
  25
  26 #[derive(Debug, Clone)]
  27 pub struct Config {
  28     pub client_caps: ClientCapsConfig,
  29
  30     pub publish_diagnostics: bool,
  31     pub diagnostics: DiagnosticsConfig,
  32     pub diagnostics_map: DiagnosticsMapConfig,
  33     pub lru_capacity: Option<usize>,
  34     pub proc_macro_srv: Option<(PathBuf, Vec<OsString>)>,
  35     pub files: FilesConfig,
  36     pub notifications: NotificationsConfig,
  37
  38     pub cargo_autoreload: bool,
  39     pub cargo: CargoConfig,
  40     pub rustfmt: RustfmtConfig,
  41     pub flycheck: Option<FlycheckConfig>,
  42     pub runnables: RunnablesConfig,
  43
  44     pub inlay_hints: InlayHintsConfig,
  45     pub completion: CompletionConfig,
  46     pub assist: AssistConfig,
  47     pub call_info_full: bool,
  48     pub lens: LensConfig,
  49     pub hover: HoverConfig,
  50     pub semantic_tokens_refresh: bool,
  51
  52     pub with_sysroot: bool,
  53     pub linked_projects: Vec<LinkedProject>,
  54     pub root_path: AbsPathBuf,
  55 }
  56
  57 #[derive(Debug, Clone, Eq, PartialEq)]
  58 pub enum LinkedProject {
  59     ProjectManifest(ProjectManifest),
  60     InlineJsonProject(ProjectJson),
  61 }
  62
  63 impl From<ProjectManifest> for LinkedProject {
  64     fn from(v: ProjectManifest) -> Self {
  65         LinkedProject::ProjectManifest(v)
  66     }
  67 }
  68
  69 impl From<ProjectJson> for LinkedProject {
  70     fn from(v: ProjectJson) -> Self {
  71         LinkedProject::InlineJsonProject(v)
  72     }
  73 }
  74
  75 #[derive(Clone, Debug, PartialEq, Eq)]
  76 pub struct LensConfig {
  77     pub run: bool,
  78     pub debug: bool,
  79     pub implementations: bool,
  80     pub method_refs: bool,
  81 }
  82
  83 impl Default for LensConfig {
  84     fn default() -> Self {
  85         Self { run: true, debug: true, implementations: true, method_refs: false }
  86     }
  87 }
  88
  89 impl LensConfig {
  90     pub fn any(&self) -> bool {
  91         self.implementations || self.runnable() || self.references()
  92     }
  93
  94     pub fn none(&self) -> bool {
  95         !self.any()
  96     }
  97
  98     pub fn runnable(&self) -> bool {
  99         self.run || self.debug
 100     }
 101
 102     pub fn references(&self) -> bool {
 103         self.method_refs
 104     }
 105 }
 106
 107 #[derive(Debug, Clone)]
 108 pub struct FilesConfig {
 109     pub watcher: FilesWatcher,
 110     pub exclude: Vec<String>,
 111 }
 112
 113 #[derive(Debug, Clone)]
 114 pub enum FilesWatcher {
 115     Client,
 116     Notify,
 117 }
 118
 119 #[derive(Debug, Clone)]
 120 pub struct NotificationsConfig {
 121     pub cargo_toml_not_found: bool,
 122 }
 123
 124 #[derive(Debug, Clone)]
 125 pub enum RustfmtConfig {
 126     Rustfmt { extra_args: Vec<String> },
 127     CustomCommand { command: String, args: Vec<String> },
 128 }
 129
 130 /// Configuration for runnable items, such as `main` function or tests.
 131 #[derive(Debug, Clone, Default)]
 132 pub struct RunnablesConfig {
 133     /// Custom command to be executed instead of `cargo` for runnables.
 134     pub override_cargo: Option<String>,
 135     /// Additional arguments for the `cargo`, e.g. `--release`.
 136     pub cargo_extra_args: Vec<String>,
 137 }
 138
 139 #[derive(Debug, Clone, Default)]
 140 pub struct ClientCapsConfig {
 141     pub location_link: bool,
 142     pub line_folding_only: bool,
 143     pub hierarchical_symbols: bool,
 144     pub code_action_literals: bool,
 145     pub work_done_progress: bool,
 146     pub code_action_group: bool,
 147     pub code_action_resolve: bool,
 148     pub hover_actions: bool,
 149     pub status_notification: bool,
 150     pub signature_help_label_offsets: bool,
 151 }
 152
 153 impl Config {
 154     pub fn new(root_path: AbsPathBuf) -> Self {
 155         Config {
 156             client_caps: ClientCapsConfig::default(),
 157
 158             with_sysroot: true,
 159             publish_diagnostics: true,
 160             diagnostics: DiagnosticsConfig::default(),
 161             diagnostics_map: DiagnosticsMapConfig::default(),
 162             lru_capacity: None,
 163             proc_macro_srv: None,
 164             files: FilesConfig { watcher: FilesWatcher::Notify, exclude: Vec::new() },
 165             notifications: NotificationsConfig { cargo_toml_not_found: true },
 166
 167             cargo_autoreload: true,
 168             cargo: CargoConfig::default(),
 169             rustfmt: RustfmtConfig::Rustfmt { extra_args: Vec::new() },
 170             flycheck: Some(FlycheckConfig::CargoCommand {
 171                 command: "check".to_string(),
 172                 target_triple: None,
 173                 no_default_features: false,
 174                 all_targets: true,
 175                 all_features: false,
 176                 extra_args: Vec::new(),
 177                 features: Vec::new(),
 178             }),
 179             runnables: RunnablesConfig::default(),
 180
 181             inlay_hints: InlayHintsConfig {
 182                 type_hints: true,
 183                 parameter_hints: true,
 184                 chaining_hints: true,
 185                 max_length: None,
 186             },
 187             completion: CompletionConfig {
 188                 enable_postfix_completions: true,
 189                 add_call_parenthesis: true,
 190                 add_call_argument_snippets: true,
 191                 ..CompletionConfig::default()
 192             },
 193             assist: AssistConfig::default(),
 194             call_info_full: true,
 195             lens: LensConfig::default(),
 196             hover: HoverConfig::default(),
 197             semantic_tokens_refresh: false,
 198             linked_projects: Vec::new(),
 199             root_path,
 200         }
 201     }
 202
 203     pub fn update(&mut self, json: serde_json::Value) {
 204         log::info!("Config::update({:#})", json);
 205
 206         if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
 207             return;
 208         }
 209
 210         let data = ConfigData::from_json(json);
 211
 212         self.with_sysroot = data.withSysroot;
 213         self.publish_diagnostics = data.diagnostics_enable;
 214         self.diagnostics = DiagnosticsConfig {
 215             disable_experimental: !data.diagnostics_enableExperimental,
 216             disabled: data.diagnostics_disabled,
 217         };
 218         self.diagnostics_map = DiagnosticsMapConfig {
 219             warnings_as_info: data.diagnostics_warningsAsInfo,
 220             warnings_as_hint: data.diagnostics_warningsAsHint,
 221         };
 222         self.lru_capacity = data.lruCapacity;
 223         self.files.watcher = match data.files_watcher.as_str() {
 224             "notify" => FilesWatcher::Notify,
 225             "client" | _ => FilesWatcher::Client,
 226         };
 227         self.notifications =
 228             NotificationsConfig { cargo_toml_not_found: data.notifications_cargoTomlNotFound };
 229         self.cargo_autoreload = data.cargo_autoreload;
 230
 231         let rustc_source = if let Some(rustc_source) = data.rustcSource {
 232             let rustpath: PathBuf = rustc_source.into();
 233             AbsPathBuf::try_from(rustpath)
 234                 .map_err(|_| {
 235                     log::error!("rustc source directory must be an absolute path");
 236                 })
 237                 .ok()
 238         } else {
 239             None
 240         };
 241
 242         self.cargo = CargoConfig {
 243             no_default_features: data.cargo_noDefaultFeatures,
 244             all_features: data.cargo_allFeatures,
 245             features: data.cargo_features.clone(),
 246             load_out_dirs_from_check: data.cargo_loadOutDirsFromCheck,
 247             target: data.cargo_target.clone(),
 248             rustc_source: rustc_source,
 249         };
 250         self.runnables = RunnablesConfig {
 251             override_cargo: data.runnables_overrideCargo,
 252             cargo_extra_args: data.runnables_cargoExtraArgs,
 253         };
 254
 255         self.proc_macro_srv = if data.procMacro_enable {
 256             std::env::current_exe().ok().map(|path| (path, vec!["proc-macro".into()]))
 257         } else {
 258             None
 259         };
 260
 261         self.rustfmt = match data.rustfmt_overrideCommand {
 262             Some(mut args) if !args.is_empty() => {
 263                 let command = args.remove(0);
 264                 RustfmtConfig::CustomCommand { command, args }
 265             }
 266             Some(_) | None => RustfmtConfig::Rustfmt { extra_args: data.rustfmt_extraArgs },
 267         };
 268
 269         self.flycheck = if data.checkOnSave_enable {
 270             let flycheck_config = match data.checkOnSave_overrideCommand {
 271                 Some(mut args) if !args.is_empty() => {
 272                     let command = args.remove(0);
 273                     FlycheckConfig::CustomCommand { command, args }
 274                 }
 275                 Some(_) | None => FlycheckConfig::CargoCommand {
 276                     command: data.checkOnSave_command,
 277                     target_triple: data.checkOnSave_target.or(data.cargo_target),
 278                     all_targets: data.checkOnSave_allTargets,
 279                     no_default_features: data
 280                         .checkOnSave_noDefaultFeatures
 281                         .unwrap_or(data.cargo_noDefaultFeatures),
 282                     all_features: data.checkOnSave_allFeatures.unwrap_or(data.cargo_allFeatures),
 283                     features: data.checkOnSave_features.unwrap_or(data.cargo_features),
 284                     extra_args: data.checkOnSave_extraArgs,
 285                 },
 286             };
 287             Some(flycheck_config)
 288         } else {
 289             None
 290         };
 291
 292         self.inlay_hints = InlayHintsConfig {
 293             type_hints: data.inlayHints_typeHints,
 294             parameter_hints: data.inlayHints_parameterHints,
 295             chaining_hints: data.inlayHints_chainingHints,
 296             max_length: data.inlayHints_maxLength,
 297         };
 298
 299         self.completion.enable_postfix_completions = data.completion_postfix_enable;
 300         self.completion.add_call_parenthesis = data.completion_addCallParenthesis;
 301         self.completion.add_call_argument_snippets = data.completion_addCallArgumentSnippets;
 302
 303         self.assist.insert_use.merge = match data.assist_importMergeBehaviour {
 304             MergeBehaviourDef::None => None,
 305             MergeBehaviourDef::Full => Some(MergeBehaviour::Full),
 306             MergeBehaviourDef::Last => Some(MergeBehaviour::Last),
 307         };
 308         self.assist.insert_use.prefix_kind = match data.assist_importPrefix {
 309             ImportPrefixDef::Plain => PrefixKind::Plain,
 310             ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
 311             ImportPrefixDef::BySelf => PrefixKind::BySelf,
 312         };
 313
 314         self.call_info_full = data.callInfo_full;
 315
 316         self.lens = LensConfig {
 317             run: data.lens_enable && data.lens_run,
 318             debug: data.lens_enable && data.lens_debug,
 319             implementations: data.lens_enable && data.lens_implementations,
 320             method_refs: data.lens_enable && data.lens_methodReferences,
 321         };
 322
 323         if !data.linkedProjects.is_empty() {
 324             self.linked_projects.clear();
 325             for linked_project in data.linkedProjects {
 326                 let linked_project = match linked_project {
 327                     ManifestOrProjectJson::Manifest(it) => {
 328                         let path = self.root_path.join(it);
 329                         match ProjectManifest::from_manifest_file(path) {
 330                             Ok(it) => it.into(),
 331                             Err(e) => {
 332                                 log::error!("failed to load linked project: {}", e);
 333                                 continue;
 334                             }
 335                         }
 336                     }
 337                     ManifestOrProjectJson::ProjectJson(it) => {
 338                         ProjectJson::new(&self.root_path, it).into()
 339                     }
 340                 };
 341                 self.linked_projects.push(linked_project);
 342             }
 343         }
 344
 345         self.hover = HoverConfig {
 346             implementations: data.hoverActions_enable && data.hoverActions_implementations,
 347             run: data.hoverActions_enable && data.hoverActions_run,
 348             debug: data.hoverActions_enable && data.hoverActions_debug,
 349             goto_type_def: data.hoverActions_enable && data.hoverActions_gotoTypeDef,
 350             links_in_hover: data.hoverActions_linksInHover,
 351             markdown: true,
 352         };
 353
 354         log::info!("Config::update() = {:#?}", self);
 355     }
 356
 357     pub fn update_caps(&mut self, caps: &ClientCapabilities) {
 358         if let Some(doc_caps) = caps.text_document.as_ref() {
 359             if let Some(value) = doc_caps.hover.as_ref().and_then(|it| it.content_format.as_ref()) {
 360                 self.hover.markdown = value.contains(&MarkupKind::Markdown)
 361             }
 362             if let Some(value) = doc_caps.definition.as_ref().and_then(|it| it.link_support) {
 363                 self.client_caps.location_link = value;
 364             }
 365             if let Some(value) = doc_caps.folding_range.as_ref().and_then(|it| it.line_folding_only)
 366             {
 367                 self.client_caps.line_folding_only = value
 368             }
 369             if let Some(value) = doc_caps
 370                 .document_symbol
 371                 .as_ref()
 372                 .and_then(|it| it.hierarchical_document_symbol_support)
 373             {
 374                 self.client_caps.hierarchical_symbols = value
 375             }
 376             if let Some(value) =
 377                 doc_caps.code_action.as_ref().map(|it| it.code_action_literal_support.is_some())
 378             {
 379                 self.client_caps.code_action_literals = value;
 380             }
 381             if let Some(value) = doc_caps
 382                 .signature_help
 383                 .as_ref()
 384                 .and_then(|it| it.signature_information.as_ref())
 385                 .and_then(|it| it.parameter_information.as_ref())
 386                 .and_then(|it| it.label_offset_support)
 387             {
 388                 self.client_caps.signature_help_label_offsets = value;
 389             }
 390
 391             self.completion.allow_snippets(false);
 392             if let Some(completion) = &doc_caps.completion {
 393                 if let Some(completion_item) = &completion.completion_item {
 394                     if let Some(value) = completion_item.snippet_support {
 395                         self.completion.allow_snippets(value);
 396                     }
 397                 }
 398             }
 399
 400             if let Some(code_action) = &doc_caps.code_action {
 401                 if let Some(resolve_support) = &code_action.resolve_support {
 402                     if resolve_support.properties.iter().any(|it| it == "edit") {
 403                         self.client_caps.code_action_resolve = true;
 404                     }
 405                 }
 406             }
 407         }
 408
 409         if let Some(window_caps) = caps.window.as_ref() {
 410             if let Some(value) = window_caps.work_done_progress {
 411                 self.client_caps.work_done_progress = value;
 412             }
 413         }
 414
 415         self.assist.allow_snippets(false);
 416         if let Some(experimental) = &caps.experimental {
 417             let get_bool =
 418                 |index: &str| experimental.get(index).and_then(|it| it.as_bool()) == Some(true);
 419
 420             let snippet_text_edit = get_bool("snippetTextEdit");
 421             self.assist.allow_snippets(snippet_text_edit);
 422
 423             self.client_caps.code_action_group = get_bool("codeActionGroup");
 424             self.client_caps.hover_actions = get_bool("hoverActions");
 425             self.client_caps.status_notification = get_bool("statusNotification");
 426         }
 427
 428         if let Some(workspace_caps) = caps.workspace.as_ref() {
 429             if let Some(refresh_support) =
 430                 workspace_caps.semantic_tokens.as_ref().and_then(|it| it.refresh_support)
 431             {
 432                 self.semantic_tokens_refresh = refresh_support;
 433             }
 434         }
 435     }
 436 }
 437
 438 #[derive(Deserialize)]
 439 #[serde(untagged)]
 440 enum ManifestOrProjectJson {
 441     Manifest(PathBuf),
 442     ProjectJson(ProjectJsonData),
 443 }
 444
 445 #[derive(Deserialize)]
 446 #[serde(rename_all = "snake_case")]
 447 enum MergeBehaviourDef {
 448     None,
 449     Full,
 450     Last,
 451 }
 452
 453 #[derive(Deserialize)]
 454 #[serde(rename_all = "snake_case")]
 455 enum ImportPrefixDef {
 456     Plain,
 457     BySelf,
 458     ByCrate,
 459 }
 460
 461 macro_rules! config_data {
 462     (struct $name:ident { $($field:ident: $ty:ty = $default:expr,)*}) => {
 463         #[allow(non_snake_case)]
 464         struct $name { $($field: $ty,)* }
 465         impl $name {
 466             fn from_json(mut json: serde_json::Value) -> $name {
 467                 $name {$(
 468                     $field: {
 469                         let pointer = stringify!($field).replace('_', "/");
 470                         let pointer = format!("/{}", pointer);
 471                         json.pointer_mut(&pointer)
 472                             .and_then(|it| serde_json::from_value(it.take()).ok())
 473                             .unwrap_or($default)
 474                     },
 475                 )*}
 476             }
 477         }
 478
 479     };
 480 }
 481
 482 config_data! {
 483     struct ConfigData {
 484         assist_importMergeBehaviour: MergeBehaviourDef = MergeBehaviourDef::None,
 485         assist_importPrefix: ImportPrefixDef           = ImportPrefixDef::Plain,
 486
 487         callInfo_full: bool = true,
 488
 489         cargo_autoreload: bool           = true,
 490         cargo_allFeatures: bool          = false,
 491         cargo_features: Vec<String>      = Vec::new(),
 492         cargo_loadOutDirsFromCheck: bool = false,
 493         cargo_noDefaultFeatures: bool    = false,
 494         cargo_target: Option<String>     = None,
 495
 496         checkOnSave_enable: bool                         = true,
 497         checkOnSave_allFeatures: Option<bool>            = None,
 498         checkOnSave_allTargets: bool                     = true,
 499         checkOnSave_command: String                      = "check".into(),
 500         checkOnSave_noDefaultFeatures: Option<bool>      = None,
 501         checkOnSave_target: Option<String>               = None,
 502         checkOnSave_extraArgs: Vec<String>               = Vec::new(),
 503         checkOnSave_features: Option<Vec<String>>        = None,
 504         checkOnSave_overrideCommand: Option<Vec<String>> = None,
 505
 506         completion_addCallArgumentSnippets: bool = true,
 507         completion_addCallParenthesis: bool      = true,
 508         completion_postfix_enable: bool          = true,
 509
 510         diagnostics_enable: bool                = true,
 511         diagnostics_enableExperimental: bool    = true,
 512         diagnostics_disabled: FxHashSet<String> = FxHashSet::default(),
 513         diagnostics_warningsAsHint: Vec<String> = Vec::new(),
 514         diagnostics_warningsAsInfo: Vec<String> = Vec::new(),
 515
 516         files_watcher: String = "client".into(),
 517
 518         hoverActions_debug: bool           = true,
 519         hoverActions_enable: bool          = true,
 520         hoverActions_gotoTypeDef: bool     = true,
 521         hoverActions_implementations: bool = true,
 522         hoverActions_run: bool             = true,
 523         hoverActions_linksInHover: bool    = true,
 524
 525         inlayHints_chainingHints: bool      = true,
 526         inlayHints_maxLength: Option<usize> = None,
 527         inlayHints_parameterHints: bool     = true,
 528         inlayHints_typeHints: bool          = true,
 529
 530         lens_debug: bool            = true,
 531         lens_enable: bool           = true,
 532         lens_implementations: bool  = true,
 533         lens_run: bool              = true,
 534         lens_methodReferences: bool = false,
 535
 536         linkedProjects: Vec<ManifestOrProjectJson> = Vec::new(),
 537         lruCapacity: Option<usize>                 = None,
 538         notifications_cargoTomlNotFound: bool      = true,
 539         procMacro_enable: bool                     = false,
 540
 541         runnables_overrideCargo: Option<String> = None,
 542         runnables_cargoExtraArgs: Vec<String>   = Vec::new(),
 543
 544         rustfmt_extraArgs: Vec<String>               = Vec::new(),
 545         rustfmt_overrideCommand: Option<Vec<String>> = None,
 546
 547         withSysroot: bool = true,
 548         rustcSource : Option<String> = None,
 549     }
 550 }