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;
15 AssistConfig, CompletionConfig, DiagnosticsConfig, HoverConfig, InlayHintsConfig,
18 use lsp_types::{ClientCapabilities, MarkupKind};
19 use project_model::{CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest};
20 use rustc_hash::FxHashSet;
21 use serde::Deserialize;
24 use crate::diagnostics::DiagnosticsMapConfig;
26 #[derive(Debug, Clone)]
28 pub client_caps: ClientCapsConfig,
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,
38 pub cargo_autoreload: bool,
39 pub cargo: CargoConfig,
40 pub rustfmt: RustfmtConfig,
41 pub flycheck: Option<FlycheckConfig>,
42 pub runnables: RunnablesConfig,
44 pub inlay_hints: InlayHintsConfig,
45 pub completion: CompletionConfig,
46 pub assist: AssistConfig,
47 pub call_info_full: bool,
49 pub hover: HoverConfig,
50 pub semantic_tokens_refresh: bool,
52 pub linked_projects: Vec<LinkedProject>,
53 pub root_path: AbsPathBuf,
56 #[derive(Debug, Clone, Eq, PartialEq)]
57 pub enum LinkedProject {
58 ProjectManifest(ProjectManifest),
59 InlineJsonProject(ProjectJson),
62 impl From<ProjectManifest> for LinkedProject {
63 fn from(v: ProjectManifest) -> Self {
64 LinkedProject::ProjectManifest(v)
68 impl From<ProjectJson> for LinkedProject {
69 fn from(v: ProjectJson) -> Self {
70 LinkedProject::InlineJsonProject(v)
74 #[derive(Clone, Debug, PartialEq, Eq)]
75 pub struct LensConfig {
78 pub implementations: bool,
79 pub method_refs: bool,
82 impl Default for LensConfig {
83 fn default() -> Self {
84 Self { run: true, debug: true, implementations: true, method_refs: false }
89 pub fn any(&self) -> bool {
90 self.implementations || self.runnable() || self.references()
93 pub fn none(&self) -> bool {
97 pub fn runnable(&self) -> bool {
98 self.run || self.debug
101 pub fn references(&self) -> bool {
106 #[derive(Debug, Clone)]
107 pub struct FilesConfig {
108 pub watcher: FilesWatcher,
109 pub exclude: Vec<String>,
112 #[derive(Debug, Clone)]
113 pub enum FilesWatcher {
118 #[derive(Debug, Clone)]
119 pub struct NotificationsConfig {
120 pub cargo_toml_not_found: bool,
123 #[derive(Debug, Clone)]
124 pub enum RustfmtConfig {
125 Rustfmt { extra_args: Vec<String> },
126 CustomCommand { command: String, args: Vec<String> },
129 /// Configuration for runnable items, such as `main` function or tests.
130 #[derive(Debug, Clone, Default)]
131 pub struct RunnablesConfig {
132 /// Custom command to be executed instead of `cargo` for runnables.
133 pub override_cargo: Option<String>,
134 /// Additional arguments for the `cargo`, e.g. `--release`.
135 pub cargo_extra_args: Vec<String>,
138 #[derive(Debug, Clone, Default)]
139 pub struct ClientCapsConfig {
140 pub location_link: bool,
141 pub line_folding_only: bool,
142 pub hierarchical_symbols: bool,
143 pub code_action_literals: bool,
144 pub work_done_progress: bool,
145 pub code_action_group: bool,
146 pub code_action_resolve: bool,
147 pub hover_actions: bool,
148 pub status_notification: bool,
149 pub signature_help_label_offsets: bool,
153 pub fn new(root_path: AbsPathBuf) -> Self {
155 client_caps: ClientCapsConfig::default(),
157 publish_diagnostics: true,
158 diagnostics: DiagnosticsConfig::default(),
159 diagnostics_map: DiagnosticsMapConfig::default(),
161 proc_macro_srv: None,
162 files: FilesConfig { watcher: FilesWatcher::Notify, exclude: Vec::new() },
163 notifications: NotificationsConfig { cargo_toml_not_found: true },
165 cargo_autoreload: true,
166 cargo: CargoConfig::default(),
167 rustfmt: RustfmtConfig::Rustfmt { extra_args: Vec::new() },
168 flycheck: Some(FlycheckConfig::CargoCommand {
169 command: "check".to_string(),
171 no_default_features: false,
174 extra_args: Vec::new(),
175 features: Vec::new(),
177 runnables: RunnablesConfig::default(),
179 inlay_hints: InlayHintsConfig {
181 parameter_hints: true,
182 chaining_hints: true,
185 completion: CompletionConfig {
186 enable_postfix_completions: true,
187 add_call_parenthesis: true,
188 add_call_argument_snippets: true,
189 ..CompletionConfig::default()
191 assist: AssistConfig::default(),
192 call_info_full: true,
193 lens: LensConfig::default(),
194 hover: HoverConfig::default(),
195 semantic_tokens_refresh: false,
196 linked_projects: Vec::new(),
201 pub fn update(&mut self, json: serde_json::Value) {
202 log::info!("Config::update({:#})", json);
204 if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
208 let data = ConfigData::from_json(json);
210 self.publish_diagnostics = data.diagnostics_enable;
211 self.diagnostics = DiagnosticsConfig {
212 disable_experimental: !data.diagnostics_enableExperimental,
213 disabled: data.diagnostics_disabled,
215 self.diagnostics_map = DiagnosticsMapConfig {
216 warnings_as_info: data.diagnostics_warningsAsInfo,
217 warnings_as_hint: data.diagnostics_warningsAsHint,
219 self.lru_capacity = data.lruCapacity;
220 self.files.watcher = match data.files_watcher.as_str() {
221 "notify" => FilesWatcher::Notify,
222 "client" | _ => FilesWatcher::Client,
225 NotificationsConfig { cargo_toml_not_found: data.notifications_cargoTomlNotFound };
226 self.cargo_autoreload = data.cargo_autoreload;
228 let rustc_source = if let Some(rustc_source) = data.rustcSource {
229 let rustpath: PathBuf = rustc_source.into();
230 AbsPathBuf::try_from(rustpath)
232 log::error!("rustc source directory must be an absolute path");
239 self.cargo = CargoConfig {
240 no_default_features: data.cargo_noDefaultFeatures,
241 all_features: data.cargo_allFeatures,
242 features: data.cargo_features.clone(),
243 load_out_dirs_from_check: data.cargo_loadOutDirsFromCheck,
244 target: data.cargo_target.clone(),
245 rustc_source: rustc_source,
246 no_sysroot: data.cargo_noSysroot,
248 self.runnables = RunnablesConfig {
249 override_cargo: data.runnables_overrideCargo,
250 cargo_extra_args: data.runnables_cargoExtraArgs,
253 self.proc_macro_srv = if data.procMacro_enable {
254 std::env::current_exe().ok().map(|path| (path, vec!["proc-macro".into()]))
259 self.rustfmt = match data.rustfmt_overrideCommand {
260 Some(mut args) if !args.is_empty() => {
261 let command = args.remove(0);
262 RustfmtConfig::CustomCommand { command, args }
264 Some(_) | None => RustfmtConfig::Rustfmt { extra_args: data.rustfmt_extraArgs },
267 self.flycheck = if data.checkOnSave_enable {
268 let flycheck_config = match data.checkOnSave_overrideCommand {
269 Some(mut args) if !args.is_empty() => {
270 let command = args.remove(0);
271 FlycheckConfig::CustomCommand { command, args }
273 Some(_) | None => FlycheckConfig::CargoCommand {
274 command: data.checkOnSave_command,
275 target_triple: data.checkOnSave_target.or(data.cargo_target),
276 all_targets: data.checkOnSave_allTargets,
277 no_default_features: data
278 .checkOnSave_noDefaultFeatures
279 .unwrap_or(data.cargo_noDefaultFeatures),
280 all_features: data.checkOnSave_allFeatures.unwrap_or(data.cargo_allFeatures),
281 features: data.checkOnSave_features.unwrap_or(data.cargo_features),
282 extra_args: data.checkOnSave_extraArgs,
285 Some(flycheck_config)
290 self.inlay_hints = InlayHintsConfig {
291 type_hints: data.inlayHints_typeHints,
292 parameter_hints: data.inlayHints_parameterHints,
293 chaining_hints: data.inlayHints_chainingHints,
294 max_length: data.inlayHints_maxLength,
297 self.completion.enable_postfix_completions = data.completion_postfix_enable;
298 self.completion.add_call_parenthesis = data.completion_addCallParenthesis;
299 self.completion.add_call_argument_snippets = data.completion_addCallArgumentSnippets;
301 self.assist.insert_use.merge = match data.assist_importMergeBehaviour {
302 MergeBehaviourDef::None => None,
303 MergeBehaviourDef::Full => Some(MergeBehaviour::Full),
304 MergeBehaviourDef::Last => Some(MergeBehaviour::Last),
306 self.assist.insert_use.prefix_kind = match data.assist_importPrefix {
307 ImportPrefixDef::Plain => PrefixKind::Plain,
308 ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
309 ImportPrefixDef::BySelf => PrefixKind::BySelf,
312 self.call_info_full = data.callInfo_full;
314 self.lens = LensConfig {
315 run: data.lens_enable && data.lens_run,
316 debug: data.lens_enable && data.lens_debug,
317 implementations: data.lens_enable && data.lens_implementations,
318 method_refs: data.lens_enable && data.lens_methodReferences,
321 if !data.linkedProjects.is_empty() {
322 self.linked_projects.clear();
323 for linked_project in data.linkedProjects {
324 let linked_project = match linked_project {
325 ManifestOrProjectJson::Manifest(it) => {
326 let path = self.root_path.join(it);
327 match ProjectManifest::from_manifest_file(path) {
330 log::error!("failed to load linked project: {}", e);
335 ManifestOrProjectJson::ProjectJson(it) => {
336 ProjectJson::new(&self.root_path, it).into()
339 self.linked_projects.push(linked_project);
343 self.hover = HoverConfig {
344 implementations: data.hoverActions_enable && data.hoverActions_implementations,
345 run: data.hoverActions_enable && data.hoverActions_run,
346 debug: data.hoverActions_enable && data.hoverActions_debug,
347 goto_type_def: data.hoverActions_enable && data.hoverActions_gotoTypeDef,
348 links_in_hover: data.hoverActions_linksInHover,
352 log::info!("Config::update() = {:#?}", self);
355 pub fn update_caps(&mut self, caps: &ClientCapabilities) {
356 if let Some(doc_caps) = caps.text_document.as_ref() {
357 if let Some(value) = doc_caps.hover.as_ref().and_then(|it| it.content_format.as_ref()) {
358 self.hover.markdown = value.contains(&MarkupKind::Markdown)
360 if let Some(value) = doc_caps.definition.as_ref().and_then(|it| it.link_support) {
361 self.client_caps.location_link = value;
363 if let Some(value) = doc_caps.folding_range.as_ref().and_then(|it| it.line_folding_only)
365 self.client_caps.line_folding_only = value
367 if let Some(value) = doc_caps
370 .and_then(|it| it.hierarchical_document_symbol_support)
372 self.client_caps.hierarchical_symbols = value
375 doc_caps.code_action.as_ref().map(|it| it.code_action_literal_support.is_some())
377 self.client_caps.code_action_literals = value;
379 if let Some(value) = doc_caps
382 .and_then(|it| it.signature_information.as_ref())
383 .and_then(|it| it.parameter_information.as_ref())
384 .and_then(|it| it.label_offset_support)
386 self.client_caps.signature_help_label_offsets = value;
389 self.completion.allow_snippets(false);
390 if let Some(completion) = &doc_caps.completion {
391 if let Some(completion_item) = &completion.completion_item {
392 if let Some(value) = completion_item.snippet_support {
393 self.completion.allow_snippets(value);
398 if let Some(code_action) = &doc_caps.code_action {
399 if let Some(resolve_support) = &code_action.resolve_support {
400 if resolve_support.properties.iter().any(|it| it == "edit") {
401 self.client_caps.code_action_resolve = true;
407 if let Some(window_caps) = caps.window.as_ref() {
408 if let Some(value) = window_caps.work_done_progress {
409 self.client_caps.work_done_progress = value;
413 self.assist.allow_snippets(false);
414 if let Some(experimental) = &caps.experimental {
416 |index: &str| experimental.get(index).and_then(|it| it.as_bool()) == Some(true);
418 let snippet_text_edit = get_bool("snippetTextEdit");
419 self.assist.allow_snippets(snippet_text_edit);
421 self.client_caps.code_action_group = get_bool("codeActionGroup");
422 self.client_caps.hover_actions = get_bool("hoverActions");
423 self.client_caps.status_notification = get_bool("statusNotification");
426 if let Some(workspace_caps) = caps.workspace.as_ref() {
427 if let Some(refresh_support) =
428 workspace_caps.semantic_tokens.as_ref().and_then(|it| it.refresh_support)
430 self.semantic_tokens_refresh = refresh_support;
436 #[derive(Deserialize)]
438 enum ManifestOrProjectJson {
440 ProjectJson(ProjectJsonData),
443 #[derive(Deserialize)]
444 #[serde(rename_all = "snake_case")]
445 enum MergeBehaviourDef {
451 #[derive(Deserialize)]
452 #[serde(rename_all = "snake_case")]
453 enum ImportPrefixDef {
459 macro_rules! config_data {
460 (struct $name:ident { $($field:ident: $ty:ty = $default:expr,)*}) => {
461 #[allow(non_snake_case)]
462 struct $name { $($field: $ty,)* }
464 fn from_json(mut json: serde_json::Value) -> $name {
467 let pointer = stringify!($field).replace('_', "/");
468 let pointer = format!("/{}", pointer);
469 json.pointer_mut(&pointer)
470 .and_then(|it| serde_json::from_value(it.take()).ok())
482 assist_importMergeBehaviour: MergeBehaviourDef = MergeBehaviourDef::None,
483 assist_importPrefix: ImportPrefixDef = ImportPrefixDef::Plain,
485 callInfo_full: bool = true,
487 cargo_autoreload: bool = true,
488 cargo_allFeatures: bool = false,
489 cargo_features: Vec<String> = Vec::new(),
490 cargo_loadOutDirsFromCheck: bool = false,
491 cargo_noDefaultFeatures: bool = false,
492 cargo_target: Option<String> = None,
493 cargo_noSysroot: bool = false,
495 checkOnSave_enable: bool = true,
496 checkOnSave_allFeatures: Option<bool> = None,
497 checkOnSave_allTargets: bool = true,
498 checkOnSave_command: String = "check".into(),
499 checkOnSave_noDefaultFeatures: Option<bool> = None,
500 checkOnSave_target: Option<String> = None,
501 checkOnSave_extraArgs: Vec<String> = Vec::new(),
502 checkOnSave_features: Option<Vec<String>> = None,
503 checkOnSave_overrideCommand: Option<Vec<String>> = None,
505 completion_addCallArgumentSnippets: bool = true,
506 completion_addCallParenthesis: bool = true,
507 completion_postfix_enable: bool = true,
509 diagnostics_enable: bool = true,
510 diagnostics_enableExperimental: bool = true,
511 diagnostics_disabled: FxHashSet<String> = FxHashSet::default(),
512 diagnostics_warningsAsHint: Vec<String> = Vec::new(),
513 diagnostics_warningsAsInfo: Vec<String> = Vec::new(),
515 files_watcher: String = "client".into(),
517 hoverActions_debug: bool = true,
518 hoverActions_enable: bool = true,
519 hoverActions_gotoTypeDef: bool = true,
520 hoverActions_implementations: bool = true,
521 hoverActions_run: bool = true,
522 hoverActions_linksInHover: bool = true,
524 inlayHints_chainingHints: bool = true,
525 inlayHints_maxLength: Option<usize> = None,
526 inlayHints_parameterHints: bool = true,
527 inlayHints_typeHints: bool = true,
529 lens_debug: bool = true,
530 lens_enable: bool = true,
531 lens_implementations: bool = true,
532 lens_run: bool = true,
533 lens_methodReferences: bool = false,
535 linkedProjects: Vec<ManifestOrProjectJson> = Vec::new(),
536 lruCapacity: Option<usize> = None,
537 notifications_cargoTomlNotFound: bool = true,
538 procMacro_enable: bool = false,
540 runnables_overrideCargo: Option<String> = None,
541 runnables_cargoExtraArgs: Vec<String> = Vec::new(),
543 rustfmt_extraArgs: Vec<String> = Vec::new(),
544 rustfmt_overrideCommand: Option<Vec<String>> = None,
546 rustcSource : Option<String> = None,