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::{ffi::OsString, iter, path::PathBuf};
12 use flycheck::FlycheckConfig;
14 AssistConfig, CompletionConfig, DiagnosticsConfig, HoverConfig, HoverDocFormat,
15 InlayHintsConfig, JoinLinesConfig,
17 use ide_db::helpers::{
18 insert_use::{ImportGranularity, InsertUseConfig, PrefixKind},
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};
28 caps::completion_item_edit_resolve, diagnostics::DiagnosticsMapConfig,
29 line_index::OffsetEncoding, lsp_ext::supports_utf8, lsp_ext::WorkspaceSymbolSearchKind,
30 lsp_ext::WorkspaceSymbolSearchScope,
33 // Defines the server-side configuration of the rust-analyzer. We generate
34 // *parts* of VS Code's `package.json` config from this.
36 // However, editor specific config, which the server doesn't know about, should
37 // be specified directly in `package.json`.
39 // To deprecate an option by replacing it with another name use `new_name | `old_name` so that we keep
40 // parsing the old name.
43 /// How imports should be grouped into use statements.
44 assist_importGranularity |
45 assist_importMergeBehavior |
46 assist_importMergeBehaviour: ImportGranularityDef = "\"crate\"",
47 /// 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.
48 assist_importEnforceGranularity: bool = "false",
49 /// The path structure for newly inserted paths to use.
50 assist_importPrefix: ImportPrefixDef = "\"plain\"",
51 /// Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
52 assist_importGroup: bool = "true",
53 /// Whether to allow import insertion to merge new imports into single path glob imports like `use std::fmt::*;`.
54 assist_allowMergingIntoGlobImports: bool = "true",
56 /// Show function name and docs in parameter hints.
57 callInfo_full: bool = "true",
59 /// Automatically refresh project info via `cargo metadata` on
60 /// `Cargo.toml` changes.
61 cargo_autoreload: bool = "true",
62 /// Activate all available features (`--all-features`).
63 cargo_allFeatures: bool = "false",
64 /// Unsets `#[cfg(test)]` for the specified crates.
65 cargo_unsetTest: Vec<String> = "[\"core\"]",
66 /// List of features to activate.
67 cargo_features: Vec<String> = "[]",
68 /// Run build scripts (`build.rs`) for more precise code analysis.
69 cargo_runBuildScripts |
70 cargo_loadOutDirsFromCheck: bool = "true",
71 /// Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to
72 /// avoid compiling unnecessary things.
73 cargo_useRustcWrapperForBuildScripts: bool = "true",
74 /// Do not activate the `default` feature.
75 cargo_noDefaultFeatures: bool = "false",
76 /// Compilation target (target triple).
77 cargo_target: Option<String> = "null",
78 /// Internal config for debugging, disables loading of sysroot crates.
79 cargo_noSysroot: bool = "false",
81 /// Run specified `cargo check` command for diagnostics on save.
82 checkOnSave_enable: bool = "true",
83 /// Check with all features (`--all-features`).
84 /// Defaults to `#rust-analyzer.cargo.allFeatures#`.
85 checkOnSave_allFeatures: Option<bool> = "null",
86 /// Check all targets and tests (`--all-targets`).
87 checkOnSave_allTargets: bool = "true",
88 /// Cargo command to use for `cargo check`.
89 checkOnSave_command: String = "\"check\"",
90 /// Do not activate the `default` feature.
91 checkOnSave_noDefaultFeatures: Option<bool> = "null",
92 /// Check for a specific target. Defaults to
93 /// `#rust-analyzer.cargo.target#`.
94 checkOnSave_target: Option<String> = "null",
95 /// Extra arguments for `cargo check`.
96 checkOnSave_extraArgs: Vec<String> = "[]",
97 /// List of features to activate. Defaults to
98 /// `#rust-analyzer.cargo.features#`.
99 checkOnSave_features: Option<Vec<String>> = "null",
100 /// Advanced option, fully override the command rust-analyzer uses for
101 /// checking. The command should include `--message-format=json` or
103 checkOnSave_overrideCommand: Option<Vec<String>> = "null",
105 /// Whether to add argument snippets when completing functions.
106 /// Only applies when `#rust-analyzer.completion.addCallParenthesis#` is set.
107 completion_addCallArgumentSnippets: bool = "true",
108 /// Whether to add parenthesis when completing functions.
109 completion_addCallParenthesis: bool = "true",
110 /// Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
111 completion_postfix_enable: bool = "true",
112 /// Toggles the additional completions that automatically add imports when completed.
113 /// Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
114 completion_autoimport_enable: bool = "true",
115 /// Toggles the additional completions that automatically show method calls and field accesses
116 /// with `self` prefixed to them when inside a method.
117 completion_autoself_enable: bool = "true",
119 /// Whether to show native rust-analyzer diagnostics.
120 diagnostics_enable: bool = "true",
121 /// Whether to show experimental rust-analyzer diagnostics that might
122 /// have more false positives than usual.
123 diagnostics_enableExperimental: bool = "true",
124 /// List of rust-analyzer diagnostics to disable.
125 diagnostics_disabled: FxHashSet<String> = "[]",
126 /// Map of prefixes to be substituted when parsing diagnostic file paths.
127 /// This should be the reverse mapping of what is passed to `rustc` as `--remap-path-prefix`.
128 diagnostics_remapPrefix: FxHashMap<String, String> = "{}",
129 /// List of warnings that should be displayed with hint severity.
131 /// The warnings will be indicated by faded text or three dots in code
132 /// and will not show up in the `Problems Panel`.
133 diagnostics_warningsAsHint: Vec<String> = "[]",
134 /// List of warnings that should be displayed with info severity.
136 /// The warnings will be indicated by a blue squiggly underline in code
137 /// and a blue icon in the `Problems Panel`.
138 diagnostics_warningsAsInfo: Vec<String> = "[]",
140 /// Expand attribute macros.
141 experimental_procAttrMacros: bool = "false",
143 /// Controls file watching implementation.
144 files_watcher: String = "\"client\"",
145 /// These directories will be ignored by rust-analyzer.
146 files_excludeDirs: Vec<PathBuf> = "[]",
148 /// Use semantic tokens for strings.
150 /// In some editors (e.g. vscode) semantic tokens override other highlighting grammars.
151 /// By disabling semantic tokens for strings, other grammars can be used to highlight
153 highlighting_strings: bool = "true",
155 /// Whether to show documentation on hover.
156 hover_documentation: bool = "true",
157 /// Use markdown syntax for links in hover.
159 hoverActions_linksInHover: bool = "true",
161 /// Whether to show `Debug` action. Only applies when
162 /// `#rust-analyzer.hoverActions.enable#` is set.
163 hoverActions_debug: bool = "true",
164 /// Whether to show HoverActions in Rust files.
165 hoverActions_enable: bool = "true",
166 /// Whether to show `Go to Type Definition` action. Only applies when
167 /// `#rust-analyzer.hoverActions.enable#` is set.
168 hoverActions_gotoTypeDef: bool = "true",
169 /// Whether to show `Implementations` action. Only applies when
170 /// `#rust-analyzer.hoverActions.enable#` is set.
171 hoverActions_implementations: bool = "true",
172 /// Whether to show `References` action. Only applies when
173 /// `#rust-analyzer.hoverActions.enable#` is set.
174 hoverActions_references: bool = "false",
175 /// Whether to show `Run` action. Only applies when
176 /// `#rust-analyzer.hoverActions.enable#` is set.
177 hoverActions_run: bool = "true",
179 /// Whether to show inlay type hints for method chains.
180 inlayHints_chainingHints: bool = "true",
181 /// Maximum length for inlay hints. Set to null to have an unlimited length.
182 inlayHints_maxLength: Option<usize> = "25",
183 /// Whether to show function parameter name inlay hints at the call
185 inlayHints_parameterHints: bool = "true",
186 /// Whether to show inlay type hints for variables.
187 inlayHints_typeHints: bool = "true",
189 /// Join lines inserts else between consecutive ifs.
190 joinLines_joinElseIf: bool = "true",
191 /// Join lines removes trailing commas.
192 joinLines_removeTrailingComma: bool = "true",
193 /// Join lines unwraps trivial blocks.
194 joinLines_unwrapTrivialBlock: bool = "true",
196 /// Whether to show `Debug` lens. Only applies when
197 /// `#rust-analyzer.lens.enable#` is set.
198 lens_debug: bool = "true",
199 /// Whether to show CodeLens in Rust files.
200 lens_enable: bool = "true",
201 /// Whether to show `Implementations` lens. Only applies when
202 /// `#rust-analyzer.lens.enable#` is set.
203 lens_implementations: bool = "true",
204 /// Whether to show `Run` lens. Only applies when
205 /// `#rust-analyzer.lens.enable#` is set.
206 lens_run: bool = "true",
207 /// Whether to show `Method References` lens. Only applies when
208 /// `#rust-analyzer.lens.enable#` is set.
209 lens_methodReferences: bool = "false",
210 /// Whether to show `References` lens. Only applies when
211 /// `#rust-analyzer.lens.enable#` is set.
212 lens_references: bool = "false",
214 /// Disable project auto-discovery in favor of explicitly specified set
217 /// Elements must be paths pointing to `Cargo.toml`,
218 /// `rust-project.json`, or JSON objects in `rust-project.json` format.
219 linkedProjects: Vec<ManifestOrProjectJson> = "[]",
221 /// Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
222 lruCapacity: Option<usize> = "null",
224 /// Whether to show `can't find Cargo.toml` error message.
225 notifications_cargoTomlNotFound: bool = "true",
227 /// Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
228 procMacro_enable: bool = "true",
229 /// Internal config, path to proc-macro server executable (typically,
230 /// this is rust-analyzer itself, but we override this in tests).
231 procMacro_server: Option<PathBuf> = "null",
233 /// Command to be executed instead of 'cargo' for runnables.
234 runnables_overrideCargo: Option<String> = "null",
235 /// Additional arguments to be passed to cargo for runnables such as
236 /// tests or binaries. For example, it may be `--release`.
237 runnables_cargoExtraArgs: Vec<String> = "[]",
239 /// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
240 /// projects, or "discover" to try to automatically find it.
242 /// Any project which uses rust-analyzer with the rustcPrivate
243 /// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
245 /// This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
246 rustcSource: Option<String> = "null",
248 /// Additional arguments to `rustfmt`.
249 rustfmt_extraArgs: Vec<String> = "[]",
250 /// Advanced option, fully override the command rust-analyzer uses for
252 rustfmt_overrideCommand: Option<Vec<String>> = "null",
253 /// Enables the use of rustfmt's unstable range formatting command for the
254 /// `textDocument/rangeFormatting` request. The rustfmt option is unstable and only
255 /// available on a nightly build.
256 rustfmt_enableRangeFormatting: bool = "false",
258 /// Workspace symbol search scope.
259 workspace_symbol_search_scope: WorskpaceSymbolSearchScopeDef = "\"workspace\"",
260 /// Workspace symbol search kind.
261 workspace_symbol_search_kind: WorskpaceSymbolSearchKindDef = "\"only_types\"",
265 impl Default for ConfigData {
266 fn default() -> Self {
267 ConfigData::from_json(serde_json::Value::Null)
271 #[derive(Debug, Clone)]
273 pub caps: lsp_types::ClientCapabilities,
275 detached_files: Vec<AbsPathBuf>,
276 pub discovered_projects: Option<Vec<ProjectManifest>>,
277 pub root_path: AbsPathBuf,
280 #[derive(Debug, Clone, Eq, PartialEq)]
281 pub enum LinkedProject {
282 ProjectManifest(ProjectManifest),
283 InlineJsonProject(ProjectJson),
286 impl From<ProjectManifest> for LinkedProject {
287 fn from(v: ProjectManifest) -> Self {
288 LinkedProject::ProjectManifest(v)
292 impl From<ProjectJson> for LinkedProject {
293 fn from(v: ProjectJson) -> Self {
294 LinkedProject::InlineJsonProject(v)
298 #[derive(Clone, Debug, PartialEq, Eq)]
299 pub struct LensConfig {
302 pub implementations: bool,
303 pub method_refs: bool,
304 pub refs: bool, // for Struct, Enum, Union and Trait
308 pub fn any(&self) -> bool {
309 self.implementations || self.runnable() || self.references()
312 pub fn none(&self) -> bool {
316 pub fn runnable(&self) -> bool {
317 self.run || self.debug
320 pub fn references(&self) -> bool {
321 self.method_refs || self.refs
325 #[derive(Clone, Debug, PartialEq, Eq)]
326 pub struct HoverActionsConfig {
327 pub implementations: bool,
328 pub references: bool,
331 pub goto_type_def: bool,
334 impl HoverActionsConfig {
335 pub const NO_ACTIONS: Self = Self {
336 implementations: false,
340 goto_type_def: false,
343 pub fn any(&self) -> bool {
344 self.implementations || self.references || self.runnable() || self.goto_type_def
347 pub fn none(&self) -> bool {
351 pub fn runnable(&self) -> bool {
352 self.run || self.debug
356 #[derive(Debug, Clone)]
357 pub struct FilesConfig {
358 pub watcher: FilesWatcher,
359 pub exclude: Vec<AbsPathBuf>,
362 #[derive(Debug, Clone)]
363 pub enum FilesWatcher {
368 #[derive(Debug, Clone)]
369 pub struct NotificationsConfig {
370 pub cargo_toml_not_found: bool,
373 #[derive(Debug, Clone)]
374 pub enum RustfmtConfig {
375 Rustfmt { extra_args: Vec<String>, enable_range_formatting: bool },
376 CustomCommand { command: String, args: Vec<String> },
379 /// Configuration for runnable items, such as `main` function or tests.
380 #[derive(Debug, Clone)]
381 pub struct RunnablesConfig {
382 /// Custom command to be executed instead of `cargo` for runnables.
383 pub override_cargo: Option<String>,
384 /// Additional arguments for the `cargo`, e.g. `--release`.
385 pub cargo_extra_args: Vec<String>,
388 /// Configuration for workspace symbol search requests.
389 #[derive(Debug, Clone)]
390 pub struct WorkspaceSymbolConfig {
391 /// In what scope should the symbol be searched in.
392 pub search_scope: WorkspaceSymbolSearchScope,
393 /// What kind of symbol is being search for.
394 pub search_kind: WorkspaceSymbolSearchKind,
398 pub fn new(root_path: AbsPathBuf, caps: ClientCapabilities) -> Self {
401 data: ConfigData::default(),
402 detached_files: Vec::new(),
403 discovered_projects: None,
407 pub fn update(&mut self, mut json: serde_json::Value) {
408 log::info!("updating config from JSON: {:#}", json);
409 if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
412 self.detached_files = get_field::<Vec<PathBuf>>(&mut json, "detachedFiles", None, "[]")
414 .map(AbsPathBuf::assert)
416 self.data = ConfigData::from_json(json);
419 pub fn json_schema() -> serde_json::Value {
420 ConfigData::json_schema()
426 || -> _ { Some($expr) }()
429 macro_rules! try_or {
430 ($expr:expr, $or:expr) => {
431 try_!($expr).unwrap_or($or)
436 pub fn linked_projects(&self) -> Vec<LinkedProject> {
437 if self.data.linkedProjects.is_empty() {
438 self.discovered_projects
443 .map(LinkedProject::from)
449 .filter_map(|linked_project| {
450 let res = match linked_project {
451 ManifestOrProjectJson::Manifest(it) => {
452 let path = self.root_path.join(it);
453 ProjectManifest::from_manifest_file(path)
454 .map_err(|e| log::error!("failed to load linked project: {}", e))
458 ManifestOrProjectJson::ProjectJson(it) => {
459 ProjectJson::new(&self.root_path, it.clone()).into()
468 pub fn detached_files(&self) -> &[AbsPathBuf] {
472 pub fn did_save_text_document_dynamic_registration(&self) -> bool {
474 try_or!(self.caps.text_document.as_ref()?.synchronization.clone()?, Default::default());
475 caps.did_save == Some(true) && caps.dynamic_registration == Some(true)
477 pub fn did_change_watched_files_dynamic_registration(&self) -> bool {
479 self.caps.workspace.as_ref()?.did_change_watched_files.as_ref()?.dynamic_registration?,
484 pub fn location_link(&self) -> bool {
485 try_or!(self.caps.text_document.as_ref()?.definition?.link_support?, false)
487 pub fn line_folding_only(&self) -> bool {
488 try_or!(self.caps.text_document.as_ref()?.folding_range.as_ref()?.line_folding_only?, false)
490 pub fn hierarchical_symbols(&self) -> bool {
497 .hierarchical_document_symbol_support?,
501 pub fn code_action_literals(&self) -> bool {
508 .code_action_literal_support
512 pub fn work_done_progress(&self) -> bool {
513 try_or!(self.caps.window.as_ref()?.work_done_progress?, false)
515 pub fn will_rename(&self) -> bool {
516 try_or!(self.caps.workspace.as_ref()?.file_operations.as_ref()?.will_rename?, false)
518 pub fn change_annotation_support(&self) -> bool {
525 .change_annotation_support
529 pub fn code_action_resolve(&self) -> bool {
543 .any(|it| it == "edit")
545 pub fn signature_help_label_offsets(&self) -> bool {
552 .signature_information
554 .parameter_information
556 .label_offset_support?,
560 pub fn offset_encoding(&self) -> OffsetEncoding {
561 if supports_utf8(&self.caps) {
564 OffsetEncoding::Utf16
568 fn experimental(&self, index: &'static str) -> bool {
569 try_or!(self.caps.experimental.as_ref()?.get(index)?.as_bool()?, false)
571 pub fn code_action_group(&self) -> bool {
572 self.experimental("codeActionGroup")
574 pub fn experimental_hover_actions(&self) -> bool {
575 self.experimental("hoverActions")
577 pub fn server_status_notification(&self) -> bool {
578 self.experimental("serverStatusNotification")
581 pub fn publish_diagnostics(&self) -> bool {
582 self.data.diagnostics_enable
584 pub fn diagnostics(&self) -> DiagnosticsConfig {
586 disable_experimental: !self.data.diagnostics_enableExperimental,
587 disabled: self.data.diagnostics_disabled.clone(),
590 pub fn diagnostics_map(&self) -> DiagnosticsMapConfig {
591 DiagnosticsMapConfig {
592 remap_prefix: self.data.diagnostics_remapPrefix.clone(),
593 warnings_as_info: self.data.diagnostics_warningsAsInfo.clone(),
594 warnings_as_hint: self.data.diagnostics_warningsAsHint.clone(),
597 pub fn lru_capacity(&self) -> Option<usize> {
598 self.data.lruCapacity
600 pub fn proc_macro_srv(&self) -> Option<(AbsPathBuf, Vec<OsString>)> {
601 if !self.data.procMacro_enable {
604 let path = match &self.data.procMacro_server {
605 Some(it) => self.root_path.join(it),
606 None => AbsPathBuf::assert(std::env::current_exe().ok()?),
608 Some((path, vec!["proc-macro".into()]))
610 pub fn expand_proc_attr_macros(&self) -> bool {
611 self.data.experimental_procAttrMacros
613 pub fn files(&self) -> FilesConfig {
615 watcher: match self.data.files_watcher.as_str() {
616 "notify" => FilesWatcher::Notify,
617 "client" | _ => FilesWatcher::Client,
619 exclude: self.data.files_excludeDirs.iter().map(|it| self.root_path.join(it)).collect(),
622 pub fn notifications(&self) -> NotificationsConfig {
623 NotificationsConfig { cargo_toml_not_found: self.data.notifications_cargoTomlNotFound }
625 pub fn cargo_autoreload(&self) -> bool {
626 self.data.cargo_autoreload
628 pub fn run_build_scripts(&self) -> bool {
629 self.data.cargo_runBuildScripts || self.data.procMacro_enable
631 pub fn wrap_rustc(&self) -> bool {
632 self.data.cargo_useRustcWrapperForBuildScripts
634 pub fn cargo(&self) -> CargoConfig {
635 let rustc_source = self.data.rustcSource.as_ref().map(|rustc_src| {
636 if rustc_src == "discover" {
637 RustcSource::Discover
639 RustcSource::Path(self.root_path.join(rustc_src))
644 no_default_features: self.data.cargo_noDefaultFeatures,
645 all_features: self.data.cargo_allFeatures,
646 features: self.data.cargo_features.clone(),
647 target: self.data.cargo_target.clone(),
649 no_sysroot: self.data.cargo_noSysroot,
650 unset_test_crates: self.data.cargo_unsetTest.clone(),
654 pub fn rustfmt(&self) -> RustfmtConfig {
655 match &self.data.rustfmt_overrideCommand {
656 Some(args) if !args.is_empty() => {
657 let mut args = args.clone();
658 let command = args.remove(0);
659 RustfmtConfig::CustomCommand { command, args }
661 Some(_) | None => RustfmtConfig::Rustfmt {
662 extra_args: self.data.rustfmt_extraArgs.clone(),
663 enable_range_formatting: self.data.rustfmt_enableRangeFormatting,
667 pub fn flycheck(&self) -> Option<FlycheckConfig> {
668 if !self.data.checkOnSave_enable {
671 let flycheck_config = match &self.data.checkOnSave_overrideCommand {
672 Some(args) if !args.is_empty() => {
673 let mut args = args.clone();
674 let command = args.remove(0);
675 FlycheckConfig::CustomCommand { command, args }
677 Some(_) | None => FlycheckConfig::CargoCommand {
678 command: self.data.checkOnSave_command.clone(),
683 .or_else(|| self.data.cargo_target.clone()),
684 all_targets: self.data.checkOnSave_allTargets,
685 no_default_features: self
687 .checkOnSave_noDefaultFeatures
688 .unwrap_or(self.data.cargo_noDefaultFeatures),
691 .checkOnSave_allFeatures
692 .unwrap_or(self.data.cargo_allFeatures),
695 .checkOnSave_features
697 .unwrap_or_else(|| self.data.cargo_features.clone()),
698 extra_args: self.data.checkOnSave_extraArgs.clone(),
701 Some(flycheck_config)
703 pub fn runnables(&self) -> RunnablesConfig {
705 override_cargo: self.data.runnables_overrideCargo.clone(),
706 cargo_extra_args: self.data.runnables_cargoExtraArgs.clone(),
709 pub fn inlay_hints(&self) -> InlayHintsConfig {
711 type_hints: self.data.inlayHints_typeHints,
712 parameter_hints: self.data.inlayHints_parameterHints,
713 chaining_hints: self.data.inlayHints_chainingHints,
714 max_length: self.data.inlayHints_maxLength,
717 fn insert_use_config(&self) -> InsertUseConfig {
719 granularity: match self.data.assist_importGranularity {
720 ImportGranularityDef::Preserve => ImportGranularity::Preserve,
721 ImportGranularityDef::Item => ImportGranularity::Item,
722 ImportGranularityDef::Crate => ImportGranularity::Crate,
723 ImportGranularityDef::Module => ImportGranularity::Module,
725 enforce_granularity: self.data.assist_importEnforceGranularity,
726 prefix_kind: match self.data.assist_importPrefix {
727 ImportPrefixDef::Plain => PrefixKind::Plain,
728 ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
729 ImportPrefixDef::BySelf => PrefixKind::BySelf,
731 group: self.data.assist_importGroup,
732 skip_glob_imports: !self.data.assist_allowMergingIntoGlobImports,
735 pub fn completion(&self) -> CompletionConfig {
737 enable_postfix_completions: self.data.completion_postfix_enable,
738 enable_imports_on_the_fly: self.data.completion_autoimport_enable
739 && completion_item_edit_resolve(&self.caps),
740 enable_self_on_the_fly: self.data.completion_autoself_enable,
741 add_call_parenthesis: self.data.completion_addCallParenthesis,
742 add_call_argument_snippets: self.data.completion_addCallArgumentSnippets,
743 insert_use: self.insert_use_config(),
744 snippet_cap: SnippetCap::new(try_or!(
757 pub fn assist(&self) -> AssistConfig {
759 snippet_cap: SnippetCap::new(self.experimental("snippetTextEdit")),
761 insert_use: self.insert_use_config(),
764 pub fn join_lines(&self) -> JoinLinesConfig {
766 join_else_if: self.data.joinLines_joinElseIf,
767 remove_trailing_comma: self.data.joinLines_removeTrailingComma,
768 unwrap_trivial_blocks: self.data.joinLines_unwrapTrivialBlock,
771 pub fn call_info_full(&self) -> bool {
772 self.data.callInfo_full
774 pub fn lens(&self) -> LensConfig {
776 run: self.data.lens_enable && self.data.lens_run,
777 debug: self.data.lens_enable && self.data.lens_debug,
778 implementations: self.data.lens_enable && self.data.lens_implementations,
779 method_refs: self.data.lens_enable && self.data.lens_methodReferences,
780 refs: self.data.lens_enable && self.data.lens_references,
783 pub fn hover_actions(&self) -> HoverActionsConfig {
785 implementations: self.data.hoverActions_enable
786 && self.data.hoverActions_implementations,
787 references: self.data.hoverActions_enable && self.data.hoverActions_references,
788 run: self.data.hoverActions_enable && self.data.hoverActions_run,
789 debug: self.data.hoverActions_enable && self.data.hoverActions_debug,
790 goto_type_def: self.data.hoverActions_enable && self.data.hoverActions_gotoTypeDef,
793 pub fn highlighting_strings(&self) -> bool {
794 self.data.highlighting_strings
796 pub fn hover(&self) -> HoverConfig {
798 links_in_hover: self.data.hover_linksInHover,
799 documentation: self.data.hover_documentation.then(|| {
800 let is_markdown = try_or!(
811 .contains(&MarkupKind::Markdown);
813 HoverDocFormat::Markdown
815 HoverDocFormat::PlainText
821 pub fn workspace_symbol(&self) -> WorkspaceSymbolConfig {
822 WorkspaceSymbolConfig {
823 search_scope: match self.data.workspace_symbol_search_scope {
824 WorskpaceSymbolSearchScopeDef::Workspace => WorkspaceSymbolSearchScope::Workspace,
825 WorskpaceSymbolSearchScopeDef::WorkspaceAndDependencies => {
826 WorkspaceSymbolSearchScope::WorkspaceAndDependencies
829 search_kind: match self.data.workspace_symbol_search_kind {
830 WorskpaceSymbolSearchKindDef::OnlyTypes => WorkspaceSymbolSearchKind::OnlyTypes,
831 WorskpaceSymbolSearchKindDef::AllSymbols => WorkspaceSymbolSearchKind::AllSymbols,
836 pub fn semantic_tokens_refresh(&self) -> bool {
837 try_or!(self.caps.workspace.as_ref()?.semantic_tokens.as_ref()?.refresh_support?, false)
839 pub fn code_lens_refresh(&self) -> bool {
840 try_or!(self.caps.workspace.as_ref()?.code_lens.as_ref()?.refresh_support?, false)
842 pub fn insert_replace_support(&self) -> bool {
851 .insert_replace_support?,
857 #[derive(Deserialize, Debug, Clone)]
859 enum ManifestOrProjectJson {
861 ProjectJson(ProjectJsonData),
864 #[derive(Deserialize, Debug, Clone)]
865 #[serde(rename_all = "snake_case")]
866 enum ImportGranularityDef {
868 #[serde(alias = "none")]
870 #[serde(alias = "full")]
872 #[serde(alias = "last")]
876 #[derive(Deserialize, Debug, Clone)]
877 #[serde(rename_all = "snake_case")]
878 enum ImportPrefixDef {
880 #[serde(alias = "self")]
882 #[serde(alias = "crate")]
886 #[derive(Deserialize, Debug, Clone)]
887 #[serde(rename_all = "snake_case")]
888 enum WorskpaceSymbolSearchScopeDef {
890 WorkspaceAndDependencies,
893 #[derive(Deserialize, Debug, Clone)]
894 #[serde(rename_all = "snake_case")]
895 enum WorskpaceSymbolSearchKindDef {
900 macro_rules! _config_data {
901 (struct $name:ident {
903 $(#[doc=$doc:literal])*
904 $field:ident $(| $alias:ident)*: $ty:ty = $default:expr,
907 #[allow(non_snake_case)]
908 #[derive(Debug, Clone)]
909 struct $name { $($field: $ty,)* }
911 fn from_json(mut json: serde_json::Value) -> $name {
916 None$(.or(Some(stringify!($alias))))*,
922 fn json_schema() -> serde_json::Value {
925 let field = stringify!($field);
926 let ty = stringify!($ty);
928 (field, ty, &[$($doc),*], $default)
934 fn manual() -> String {
937 let field = stringify!($field);
938 let ty = stringify!($ty);
940 (field, ty, &[$($doc),*], $default)
947 use _config_data as config_data;
949 fn get_field<T: DeserializeOwned>(
950 json: &mut serde_json::Value,
952 alias: Option<&'static str>,
955 let default = serde_json::from_str(default).unwrap();
957 // XXX: check alias first, to work-around the VS Code where it pre-fills the
958 // defaults instead of sending an empty object.
961 .chain(iter::once(field))
962 .find_map(move |field| {
963 let mut pointer = field.replace('_', "/");
964 pointer.insert(0, '/');
965 json.pointer_mut(&pointer).and_then(|it| serde_json::from_value(it.take()).ok())
970 fn schema(fields: &[(&'static str, &'static str, &[&str], &str)]) -> serde_json::Value {
971 for ((f1, ..), (f2, ..)) in fields.iter().zip(&fields[1..]) {
972 fn key(f: &str) -> &str {
973 f.splitn(2, '_').next().unwrap()
975 assert!(key(f1) <= key(f2), "wrong field order: {:?} {:?}", f1, f2);
980 .map(|(field, ty, doc, default)| {
981 let name = field.replace("_", ".");
982 let name = format!("rust-analyzer.{}", name);
983 let props = field_props(field, ty, doc, default);
986 .collect::<serde_json::Map<_, _>>();
990 fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json::Value {
991 let doc = doc_comment_to_string(doc);
992 let doc = doc.trim_end_matches('\n');
994 doc.ends_with('.') && doc.starts_with(char::is_uppercase),
995 "bad docs for {}: {:?}",
999 let default = default.parse::<serde_json::Value>().unwrap();
1001 let mut map = serde_json::Map::default();
1003 ($($key:literal: $value:tt),*$(,)?) => {{$(
1004 map.insert($key.into(), serde_json::json!($value));
1007 set!("markdownDescription": doc);
1008 set!("default": default);
1011 "bool" => set!("type": "boolean"),
1012 "String" => set!("type": "string"),
1013 "Vec<String>" => set! {
1015 "items": { "type": "string" },
1017 "Vec<PathBuf>" => set! {
1019 "items": { "type": "string" },
1021 "FxHashSet<String>" => set! {
1023 "items": { "type": "string" },
1024 "uniqueItems": true,
1026 "FxHashMap<String, String>" => set! {
1029 "Option<usize>" => set! {
1030 "type": ["null", "integer"],
1033 "Option<String>" => set! {
1034 "type": ["null", "string"],
1036 "Option<PathBuf>" => set! {
1037 "type": ["null", "string"],
1039 "Option<bool>" => set! {
1040 "type": ["null", "boolean"],
1042 "Option<Vec<String>>" => set! {
1043 "type": ["null", "array"],
1044 "items": { "type": "string" },
1046 "MergeBehaviorDef" => set! {
1048 "enum": ["none", "crate", "module"],
1049 "enumDescriptions": [
1050 "Do not merge imports at all.",
1051 "Merge imports from the same crate into a single `use` statement.",
1052 "Merge imports from the same module into a single `use` statement."
1055 "ImportGranularityDef" => set! {
1057 "enum": ["preserve", "crate", "module", "item"],
1058 "enumDescriptions": [
1059 "Do not change the granularity of any imports and preserve the original structure written by the developer.",
1060 "Merge imports from the same crate into a single use statement. Conversely, imports from different crates are split into separate statements.",
1061 "Merge imports from the same module into a single use statement. Conversely, imports from different modules are split into separate statements.",
1062 "Flatten imports so that each has its own use statement."
1065 "ImportPrefixDef" => set! {
1072 "enumDescriptions": [
1073 "Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item.",
1074 "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.",
1075 "Force import paths to be absolute by always starting them with `crate` or the extern crate name they come from."
1078 "Vec<ManifestOrProjectJson>" => set! {
1080 "items": { "type": ["string", "object"] },
1082 "WorskpaceSymbolSearchScopeDef" => set! {
1084 "enum": ["workspace", "workspace_and_dependencies"],
1085 "enumDescriptions": [
1086 "Search in current workspace only",
1087 "Search in current workspace and dependencies"
1090 "WorskpaceSymbolSearchKindDef" => set! {
1092 "enum": ["only_types", "all_symbols"],
1093 "enumDescriptions": [
1094 "Search for types only",
1095 "Search for all symbols kinds"
1098 _ => panic!("{}: {}", ty, default),
1105 fn manual(fields: &[(&'static str, &'static str, &[&str], &str)]) -> String {
1108 .map(|(field, _ty, doc, default)| {
1109 let name = format!("rust-analyzer.{}", field.replace("_", "."));
1110 let doc = doc_comment_to_string(*doc);
1111 format!("[[{}]]{} (default: `{}`)::\n+\n--\n{}--\n", name, name, default, doc)
1113 .collect::<String>()
1116 fn doc_comment_to_string(doc: &[&str]) -> String {
1117 doc.iter().map(|it| it.strip_prefix(' ').unwrap_or(it)).map(|it| format!("{}\n", it)).collect()
1124 use test_utils::{ensure_file_contents, project_root};
1129 fn generate_package_json_config() {
1130 let s = Config::json_schema();
1131 let schema = format!("{:#}", s);
1132 let mut schema = schema
1133 .trim_start_matches('{')
1134 .trim_end_matches('}')
1136 .replace("\n", "\n ")
1137 .trim_start_matches('\n')
1140 schema.push_str(",\n");
1142 let package_json_path = project_root().join("editors/code/package.json");
1143 let mut package_json = fs::read_to_string(&package_json_path).unwrap();
1145 let start_marker = " \"$generated-start\": {},\n";
1146 let end_marker = " \"$generated-end\": {}\n";
1148 let start = package_json.find(start_marker).unwrap() + start_marker.len();
1149 let end = package_json.find(end_marker).unwrap();
1151 let p = remove_ws(&package_json[start..end]);
1152 let s = remove_ws(&schema);
1153 if !p.contains(&s) {
1154 package_json.replace_range(start..end, &schema);
1155 ensure_file_contents(&package_json_path, &package_json)
1160 fn generate_config_documentation() {
1161 let docs_path = project_root().join("docs/user/generated_config.adoc");
1162 let expected = ConfigData::manual();
1163 ensure_file_contents(&docs_path, &expected);
1166 fn remove_ws(text: &str) -> String {
1167 text.replace(char::is_whitespace, "")