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 enable_experimental_completions: true,
188 add_call_parenthesis: true,
189 add_call_argument_snippets: true,
190 ..CompletionConfig::default()
192 assist: AssistConfig::default(),
193 call_info_full: true,
194 lens: LensConfig::default(),
195 hover: HoverConfig::default(),
196 semantic_tokens_refresh: false,
197 linked_projects: Vec::new(),
202 pub fn update(&mut self, json: serde_json::Value) {
203 log::info!("Config::update({:#})", json);
205 if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
209 let data = ConfigData::from_json(json);
211 self.publish_diagnostics = data.diagnostics_enable;
212 self.diagnostics = DiagnosticsConfig {
213 disable_experimental: !data.diagnostics_enableExperimental,
214 disabled: data.diagnostics_disabled,
216 self.diagnostics_map = DiagnosticsMapConfig {
217 warnings_as_info: data.diagnostics_warningsAsInfo,
218 warnings_as_hint: data.diagnostics_warningsAsHint,
220 self.lru_capacity = data.lruCapacity;
221 self.files.watcher = match data.files_watcher.as_str() {
222 "notify" => FilesWatcher::Notify,
223 "client" | _ => FilesWatcher::Client,
226 NotificationsConfig { cargo_toml_not_found: data.notifications_cargoTomlNotFound };
227 self.cargo_autoreload = data.cargo_autoreload;
229 let rustc_source = if let Some(rustc_source) = data.rustcSource {
230 let rustpath: PathBuf = rustc_source.into();
231 AbsPathBuf::try_from(rustpath)
233 log::error!("rustc source directory must be an absolute path");
240 self.cargo = CargoConfig {
241 no_default_features: data.cargo_noDefaultFeatures,
242 all_features: data.cargo_allFeatures,
243 features: data.cargo_features.clone(),
244 load_out_dirs_from_check: data.cargo_loadOutDirsFromCheck,
245 target: data.cargo_target.clone(),
246 rustc_source: rustc_source,
247 no_sysroot: data.cargo_noSysroot,
249 self.runnables = RunnablesConfig {
250 override_cargo: data.runnables_overrideCargo,
251 cargo_extra_args: data.runnables_cargoExtraArgs,
254 self.proc_macro_srv = if data.procMacro_enable {
255 std::env::current_exe().ok().map(|path| (path, vec!["proc-macro".into()]))
260 self.rustfmt = match data.rustfmt_overrideCommand {
261 Some(mut args) if !args.is_empty() => {
262 let command = args.remove(0);
263 RustfmtConfig::CustomCommand { command, args }
265 Some(_) | None => RustfmtConfig::Rustfmt { extra_args: data.rustfmt_extraArgs },
268 self.flycheck = if data.checkOnSave_enable {
269 let flycheck_config = match data.checkOnSave_overrideCommand {
270 Some(mut args) if !args.is_empty() => {
271 let command = args.remove(0);
272 FlycheckConfig::CustomCommand { command, args }
274 Some(_) | None => FlycheckConfig::CargoCommand {
275 command: data.checkOnSave_command,
276 target_triple: data.checkOnSave_target.or(data.cargo_target),
277 all_targets: data.checkOnSave_allTargets,
278 no_default_features: data
279 .checkOnSave_noDefaultFeatures
280 .unwrap_or(data.cargo_noDefaultFeatures),
281 all_features: data.checkOnSave_allFeatures.unwrap_or(data.cargo_allFeatures),
282 features: data.checkOnSave_features.unwrap_or(data.cargo_features),
283 extra_args: data.checkOnSave_extraArgs,
286 Some(flycheck_config)
291 self.inlay_hints = InlayHintsConfig {
292 type_hints: data.inlayHints_typeHints,
293 parameter_hints: data.inlayHints_parameterHints,
294 chaining_hints: data.inlayHints_chainingHints,
295 max_length: data.inlayHints_maxLength,
298 self.assist.insert_use.merge = match data.assist_importMergeBehaviour {
299 MergeBehaviourDef::None => None,
300 MergeBehaviourDef::Full => Some(MergeBehaviour::Full),
301 MergeBehaviourDef::Last => Some(MergeBehaviour::Last),
303 self.assist.insert_use.prefix_kind = match data.assist_importPrefix {
304 ImportPrefixDef::Plain => PrefixKind::Plain,
305 ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
306 ImportPrefixDef::BySelf => PrefixKind::BySelf,
309 self.completion.enable_postfix_completions = data.completion_postfix_enable;
310 self.completion.enable_experimental_completions = data.completion_enableExperimental;
311 self.completion.add_call_parenthesis = data.completion_addCallParenthesis;
312 self.completion.add_call_argument_snippets = data.completion_addCallArgumentSnippets;
313 self.completion.merge = self.assist.insert_use.merge;
315 self.call_info_full = data.callInfo_full;
317 self.lens = LensConfig {
318 run: data.lens_enable && data.lens_run,
319 debug: data.lens_enable && data.lens_debug,
320 implementations: data.lens_enable && data.lens_implementations,
321 method_refs: data.lens_enable && data.lens_methodReferences,
324 if !data.linkedProjects.is_empty() {
325 self.linked_projects.clear();
326 for linked_project in data.linkedProjects {
327 let linked_project = match linked_project {
328 ManifestOrProjectJson::Manifest(it) => {
329 let path = self.root_path.join(it);
330 match ProjectManifest::from_manifest_file(path) {
333 log::error!("failed to load linked project: {}", e);
338 ManifestOrProjectJson::ProjectJson(it) => {
339 ProjectJson::new(&self.root_path, it).into()
342 self.linked_projects.push(linked_project);
346 self.hover = HoverConfig {
347 implementations: data.hoverActions_enable && data.hoverActions_implementations,
348 run: data.hoverActions_enable && data.hoverActions_run,
349 debug: data.hoverActions_enable && data.hoverActions_debug,
350 goto_type_def: data.hoverActions_enable && data.hoverActions_gotoTypeDef,
351 links_in_hover: data.hoverActions_linksInHover,
355 log::info!("Config::update() = {:#?}", self);
358 pub fn update_caps(&mut self, caps: &ClientCapabilities) {
359 if let Some(doc_caps) = caps.text_document.as_ref() {
360 if let Some(value) = doc_caps.hover.as_ref().and_then(|it| it.content_format.as_ref()) {
361 self.hover.markdown = value.contains(&MarkupKind::Markdown)
363 if let Some(value) = doc_caps.definition.as_ref().and_then(|it| it.link_support) {
364 self.client_caps.location_link = value;
366 if let Some(value) = doc_caps.folding_range.as_ref().and_then(|it| it.line_folding_only)
368 self.client_caps.line_folding_only = value
370 if let Some(value) = doc_caps
373 .and_then(|it| it.hierarchical_document_symbol_support)
375 self.client_caps.hierarchical_symbols = value
378 doc_caps.code_action.as_ref().map(|it| it.code_action_literal_support.is_some())
380 self.client_caps.code_action_literals = value;
382 if let Some(value) = doc_caps
385 .and_then(|it| it.signature_information.as_ref())
386 .and_then(|it| it.parameter_information.as_ref())
387 .and_then(|it| it.label_offset_support)
389 self.client_caps.signature_help_label_offsets = value;
392 self.completion.allow_snippets(false);
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::None,
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_enableExperimental: 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,