1 //! Config used by the language server.
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.
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.
10 use std::{convert::TryFrom, ffi::OsString, path::PathBuf};
12 use flycheck::FlycheckConfig;
14 use ide::{AssistConfig, CompletionConfig, DiagnosticsConfig, HoverConfig, InlayHintsConfig};
15 use ide_db::helpers::insert_use::MergeBehaviour;
16 use lsp_types::{ClientCapabilities, MarkupKind};
17 use project_model::{CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest};
18 use rustc_hash::FxHashSet;
19 use serde::Deserialize;
22 use crate::{caps::enabled_completions_resolve_capabilities, diagnostics::DiagnosticsMapConfig};
24 #[derive(Debug, Clone)]
26 pub client_caps: ClientCapsConfig,
28 pub publish_diagnostics: bool,
29 pub diagnostics: DiagnosticsConfig,
30 pub diagnostics_map: DiagnosticsMapConfig,
31 pub lru_capacity: Option<usize>,
32 pub proc_macro_srv: Option<(PathBuf, Vec<OsString>)>,
33 pub files: FilesConfig,
34 pub notifications: NotificationsConfig,
36 pub cargo_autoreload: bool,
37 pub cargo: CargoConfig,
38 pub rustfmt: RustfmtConfig,
39 pub flycheck: Option<FlycheckConfig>,
40 pub runnables: RunnablesConfig,
42 pub inlay_hints: InlayHintsConfig,
43 pub completion: CompletionConfig,
44 pub assist: AssistConfig,
45 pub call_info_full: bool,
47 pub hover: HoverConfig,
48 pub semantic_tokens_refresh: bool,
50 pub linked_projects: Vec<LinkedProject>,
51 pub root_path: AbsPathBuf,
54 #[derive(Debug, Clone, Eq, PartialEq)]
55 pub enum LinkedProject {
56 ProjectManifest(ProjectManifest),
57 InlineJsonProject(ProjectJson),
60 impl From<ProjectManifest> for LinkedProject {
61 fn from(v: ProjectManifest) -> Self {
62 LinkedProject::ProjectManifest(v)
66 impl From<ProjectJson> for LinkedProject {
67 fn from(v: ProjectJson) -> Self {
68 LinkedProject::InlineJsonProject(v)
72 #[derive(Clone, Debug, PartialEq, Eq)]
73 pub struct LensConfig {
76 pub implementations: bool,
77 pub method_refs: bool,
80 impl Default for LensConfig {
81 fn default() -> Self {
82 Self { run: true, debug: true, implementations: true, method_refs: false }
87 pub fn any(&self) -> bool {
88 self.implementations || self.runnable() || self.references()
91 pub fn none(&self) -> bool {
95 pub fn runnable(&self) -> bool {
96 self.run || self.debug
99 pub fn references(&self) -> bool {
104 #[derive(Debug, Clone)]
105 pub struct FilesConfig {
106 pub watcher: FilesWatcher,
107 pub exclude: Vec<String>,
110 #[derive(Debug, Clone)]
111 pub enum FilesWatcher {
116 #[derive(Debug, Clone)]
117 pub struct NotificationsConfig {
118 pub cargo_toml_not_found: bool,
121 #[derive(Debug, Clone)]
122 pub enum RustfmtConfig {
123 Rustfmt { extra_args: Vec<String> },
124 CustomCommand { command: String, args: Vec<String> },
127 /// Configuration for runnable items, such as `main` function or tests.
128 #[derive(Debug, Clone, Default)]
129 pub struct RunnablesConfig {
130 /// Custom command to be executed instead of `cargo` for runnables.
131 pub override_cargo: Option<String>,
132 /// Additional arguments for the `cargo`, e.g. `--release`.
133 pub cargo_extra_args: Vec<String>,
136 #[derive(Debug, Clone, Default)]
137 pub struct ClientCapsConfig {
138 pub location_link: bool,
139 pub line_folding_only: bool,
140 pub hierarchical_symbols: bool,
141 pub code_action_literals: bool,
142 pub work_done_progress: bool,
143 pub code_action_group: bool,
144 pub code_action_resolve: bool,
145 pub hover_actions: bool,
146 pub status_notification: bool,
147 pub signature_help_label_offsets: bool,
151 pub fn new(root_path: AbsPathBuf) -> Self {
153 client_caps: ClientCapsConfig::default(),
155 publish_diagnostics: true,
156 diagnostics: DiagnosticsConfig::default(),
157 diagnostics_map: DiagnosticsMapConfig::default(),
159 proc_macro_srv: None,
160 files: FilesConfig { watcher: FilesWatcher::Notify, exclude: Vec::new() },
161 notifications: NotificationsConfig { cargo_toml_not_found: true },
163 cargo_autoreload: true,
164 cargo: CargoConfig::default(),
165 rustfmt: RustfmtConfig::Rustfmt { extra_args: Vec::new() },
166 flycheck: Some(FlycheckConfig::CargoCommand {
167 command: "check".to_string(),
169 no_default_features: false,
172 extra_args: Vec::new(),
173 features: Vec::new(),
175 runnables: RunnablesConfig::default(),
177 inlay_hints: InlayHintsConfig {
179 parameter_hints: true,
180 chaining_hints: true,
183 completion: CompletionConfig {
184 enable_postfix_completions: true,
185 enable_autoimport_completions: true,
186 add_call_parenthesis: true,
187 add_call_argument_snippets: true,
188 ..CompletionConfig::default()
190 assist: AssistConfig::default(),
191 call_info_full: true,
192 lens: LensConfig::default(),
193 hover: HoverConfig::default(),
194 semantic_tokens_refresh: false,
195 linked_projects: Vec::new(),
200 pub fn update(&mut self, json: serde_json::Value) {
201 log::info!("Config::update({:#})", json);
203 if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
207 let data = ConfigData::from_json(json);
209 self.publish_diagnostics = data.diagnostics_enable;
210 self.diagnostics = DiagnosticsConfig {
211 disable_experimental: !data.diagnostics_enableExperimental,
212 disabled: data.diagnostics_disabled,
214 self.diagnostics_map = DiagnosticsMapConfig {
215 warnings_as_info: data.diagnostics_warningsAsInfo,
216 warnings_as_hint: data.diagnostics_warningsAsHint,
218 self.lru_capacity = data.lruCapacity;
219 self.files.watcher = match data.files_watcher.as_str() {
220 "notify" => FilesWatcher::Notify,
221 "client" | _ => FilesWatcher::Client,
224 NotificationsConfig { cargo_toml_not_found: data.notifications_cargoTomlNotFound };
225 self.cargo_autoreload = data.cargo_autoreload;
227 let rustc_source = if let Some(rustc_source) = data.rustcSource {
228 let rustpath: PathBuf = rustc_source.into();
229 AbsPathBuf::try_from(rustpath)
231 log::error!("rustc source directory must be an absolute path");
238 self.cargo = CargoConfig {
239 no_default_features: data.cargo_noDefaultFeatures,
240 all_features: data.cargo_allFeatures,
241 features: data.cargo_features.clone(),
242 load_out_dirs_from_check: data.cargo_loadOutDirsFromCheck,
243 target: data.cargo_target.clone(),
244 rustc_source: rustc_source,
245 no_sysroot: data.cargo_noSysroot,
247 self.runnables = RunnablesConfig {
248 override_cargo: data.runnables_overrideCargo,
249 cargo_extra_args: data.runnables_cargoExtraArgs,
252 self.proc_macro_srv = if data.procMacro_enable {
253 std::env::current_exe().ok().map(|path| (path, vec!["proc-macro".into()]))
258 self.rustfmt = match data.rustfmt_overrideCommand {
259 Some(mut args) if !args.is_empty() => {
260 let command = args.remove(0);
261 RustfmtConfig::CustomCommand { command, args }
263 Some(_) | None => RustfmtConfig::Rustfmt { extra_args: data.rustfmt_extraArgs },
266 self.flycheck = if data.checkOnSave_enable {
267 let flycheck_config = match data.checkOnSave_overrideCommand {
268 Some(mut args) if !args.is_empty() => {
269 let command = args.remove(0);
270 FlycheckConfig::CustomCommand { command, args }
272 Some(_) | None => FlycheckConfig::CargoCommand {
273 command: data.checkOnSave_command,
274 target_triple: data.checkOnSave_target.or(data.cargo_target),
275 all_targets: data.checkOnSave_allTargets,
276 no_default_features: data
277 .checkOnSave_noDefaultFeatures
278 .unwrap_or(data.cargo_noDefaultFeatures),
279 all_features: data.checkOnSave_allFeatures.unwrap_or(data.cargo_allFeatures),
280 features: data.checkOnSave_features.unwrap_or(data.cargo_features),
281 extra_args: data.checkOnSave_extraArgs,
284 Some(flycheck_config)
289 self.inlay_hints = InlayHintsConfig {
290 type_hints: data.inlayHints_typeHints,
291 parameter_hints: data.inlayHints_parameterHints,
292 chaining_hints: data.inlayHints_chainingHints,
293 max_length: data.inlayHints_maxLength,
296 self.assist.insert_use.merge = match data.assist_importMergeBehaviour {
297 MergeBehaviourDef::None => None,
298 MergeBehaviourDef::Full => Some(MergeBehaviour::Full),
299 MergeBehaviourDef::Last => Some(MergeBehaviour::Last),
301 self.assist.insert_use.prefix_kind = match data.assist_importPrefix {
302 ImportPrefixDef::Plain => PrefixKind::Plain,
303 ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
304 ImportPrefixDef::BySelf => PrefixKind::BySelf,
307 self.completion.enable_postfix_completions = data.completion_postfix_enable;
308 self.completion.enable_autoimport_completions = data.completion_autoimport_enable;
309 self.completion.add_call_parenthesis = data.completion_addCallParenthesis;
310 self.completion.add_call_argument_snippets = data.completion_addCallArgumentSnippets;
311 self.completion.merge = self.assist.insert_use.merge;
313 self.call_info_full = data.callInfo_full;
315 self.lens = LensConfig {
316 run: data.lens_enable && data.lens_run,
317 debug: data.lens_enable && data.lens_debug,
318 implementations: data.lens_enable && data.lens_implementations,
319 method_refs: data.lens_enable && data.lens_methodReferences,
322 if !data.linkedProjects.is_empty() {
323 self.linked_projects.clear();
324 for linked_project in data.linkedProjects {
325 let linked_project = match linked_project {
326 ManifestOrProjectJson::Manifest(it) => {
327 let path = self.root_path.join(it);
328 match ProjectManifest::from_manifest_file(path) {
331 log::error!("failed to load linked project: {}", e);
336 ManifestOrProjectJson::ProjectJson(it) => {
337 ProjectJson::new(&self.root_path, it).into()
340 self.linked_projects.push(linked_project);
344 self.hover = HoverConfig {
345 implementations: data.hoverActions_enable && data.hoverActions_implementations,
346 run: data.hoverActions_enable && data.hoverActions_run,
347 debug: data.hoverActions_enable && data.hoverActions_debug,
348 goto_type_def: data.hoverActions_enable && data.hoverActions_gotoTypeDef,
349 links_in_hover: data.hoverActions_linksInHover,
353 log::info!("Config::update() = {:#?}", self);
356 pub fn update_caps(&mut self, caps: &ClientCapabilities) {
357 if let Some(doc_caps) = caps.text_document.as_ref() {
358 if let Some(value) = doc_caps.hover.as_ref().and_then(|it| it.content_format.as_ref()) {
359 self.hover.markdown = value.contains(&MarkupKind::Markdown)
361 if let Some(value) = doc_caps.definition.as_ref().and_then(|it| it.link_support) {
362 self.client_caps.location_link = value;
364 if let Some(value) = doc_caps.folding_range.as_ref().and_then(|it| it.line_folding_only)
366 self.client_caps.line_folding_only = value
368 if let Some(value) = doc_caps
371 .and_then(|it| it.hierarchical_document_symbol_support)
373 self.client_caps.hierarchical_symbols = value
376 doc_caps.code_action.as_ref().map(|it| it.code_action_literal_support.is_some())
378 self.client_caps.code_action_literals = value;
380 if let Some(value) = doc_caps
383 .and_then(|it| it.signature_information.as_ref())
384 .and_then(|it| it.parameter_information.as_ref())
385 .and_then(|it| it.label_offset_support)
387 self.client_caps.signature_help_label_offsets = value;
390 self.completion.allow_snippets(false);
391 self.completion.active_resolve_capabilities =
392 enabled_completions_resolve_capabilities(caps).unwrap_or_default();
393 if let Some(completion) = &doc_caps.completion {
394 if let Some(completion_item) = &completion.completion_item {
395 if let Some(value) = completion_item.snippet_support {
396 self.completion.allow_snippets(value);
401 if let Some(code_action) = &doc_caps.code_action {
402 if let Some(resolve_support) = &code_action.resolve_support {
403 if resolve_support.properties.iter().any(|it| it == "edit") {
404 self.client_caps.code_action_resolve = true;
410 if let Some(window_caps) = caps.window.as_ref() {
411 if let Some(value) = window_caps.work_done_progress {
412 self.client_caps.work_done_progress = value;
416 self.assist.allow_snippets(false);
417 if let Some(experimental) = &caps.experimental {
419 |index: &str| experimental.get(index).and_then(|it| it.as_bool()) == Some(true);
421 let snippet_text_edit = get_bool("snippetTextEdit");
422 self.assist.allow_snippets(snippet_text_edit);
424 self.client_caps.code_action_group = get_bool("codeActionGroup");
425 self.client_caps.hover_actions = get_bool("hoverActions");
426 self.client_caps.status_notification = get_bool("statusNotification");
429 if let Some(workspace_caps) = caps.workspace.as_ref() {
430 if let Some(refresh_support) =
431 workspace_caps.semantic_tokens.as_ref().and_then(|it| it.refresh_support)
433 self.semantic_tokens_refresh = refresh_support;
439 #[derive(Deserialize)]
441 enum ManifestOrProjectJson {
443 ProjectJson(ProjectJsonData),
446 #[derive(Deserialize)]
447 #[serde(rename_all = "snake_case")]
448 enum MergeBehaviourDef {
454 #[derive(Deserialize)]
455 #[serde(rename_all = "snake_case")]
456 enum ImportPrefixDef {
462 macro_rules! config_data {
463 (struct $name:ident { $($field:ident: $ty:ty = $default:expr,)*}) => {
464 #[allow(non_snake_case)]
465 struct $name { $($field: $ty,)* }
467 fn from_json(mut json: serde_json::Value) -> $name {
470 let pointer = stringify!($field).replace('_', "/");
471 let pointer = format!("/{}", pointer);
472 json.pointer_mut(&pointer)
473 .and_then(|it| serde_json::from_value(it.take()).ok())
485 assist_importMergeBehaviour: MergeBehaviourDef = MergeBehaviourDef::Full,
486 assist_importPrefix: ImportPrefixDef = ImportPrefixDef::Plain,
488 callInfo_full: bool = true,
490 cargo_autoreload: bool = true,
491 cargo_allFeatures: bool = false,
492 cargo_features: Vec<String> = Vec::new(),
493 cargo_loadOutDirsFromCheck: bool = false,
494 cargo_noDefaultFeatures: bool = false,
495 cargo_target: Option<String> = None,
496 cargo_noSysroot: bool = false,
498 checkOnSave_enable: bool = true,
499 checkOnSave_allFeatures: Option<bool> = None,
500 checkOnSave_allTargets: bool = true,
501 checkOnSave_command: String = "check".into(),
502 checkOnSave_noDefaultFeatures: Option<bool> = None,
503 checkOnSave_target: Option<String> = None,
504 checkOnSave_extraArgs: Vec<String> = Vec::new(),
505 checkOnSave_features: Option<Vec<String>> = None,
506 checkOnSave_overrideCommand: Option<Vec<String>> = None,
508 completion_addCallArgumentSnippets: bool = true,
509 completion_addCallParenthesis: bool = true,
510 completion_postfix_enable: bool = true,
511 completion_autoimport_enable: bool = true,
513 diagnostics_enable: bool = true,
514 diagnostics_enableExperimental: bool = true,
515 diagnostics_disabled: FxHashSet<String> = FxHashSet::default(),
516 diagnostics_warningsAsHint: Vec<String> = Vec::new(),
517 diagnostics_warningsAsInfo: Vec<String> = Vec::new(),
519 files_watcher: String = "client".into(),
521 hoverActions_debug: bool = true,
522 hoverActions_enable: bool = true,
523 hoverActions_gotoTypeDef: bool = true,
524 hoverActions_implementations: bool = true,
525 hoverActions_run: bool = true,
526 hoverActions_linksInHover: bool = true,
528 inlayHints_chainingHints: bool = true,
529 inlayHints_maxLength: Option<usize> = None,
530 inlayHints_parameterHints: bool = true,
531 inlayHints_typeHints: bool = true,
533 lens_debug: bool = true,
534 lens_enable: bool = true,
535 lens_implementations: bool = true,
536 lens_run: bool = true,
537 lens_methodReferences: bool = false,
539 linkedProjects: Vec<ManifestOrProjectJson> = Vec::new(),
540 lruCapacity: Option<usize> = None,
541 notifications_cargoTomlNotFound: bool = true,
542 procMacro_enable: bool = false,
544 runnables_overrideCargo: Option<String> = None,
545 runnables_cargoExtraArgs: Vec<String> = Vec::new(),
547 rustfmt_extraArgs: Vec<String> = Vec::new(),
548 rustfmt_overrideCommand: Option<Vec<String>> = None,
550 rustcSource : Option<String> = None,