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, HighlightRelatedConfig, HoverConfig,
15 HoverDocFormat, InlayHintsConfig, JoinLinesConfig,
17 use ide_db::helpers::{
18 insert_use::{ImportGranularity, InsertUseConfig, PrefixKind},
21 use lsp_types::{ClientCapabilities, MarkupKind};
23 CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest, RustcSource, UnsetTestCrates,
25 use rustc_hash::{FxHashMap, FxHashSet};
26 use serde::{de::DeserializeOwned, Deserialize};
30 caps::completion_item_edit_resolve,
31 diagnostics::DiagnosticsMapConfig,
32 line_index::OffsetEncoding,
33 lsp_ext::supports_utf8,
34 lsp_ext::WorkspaceSymbolSearchScope,
35 lsp_ext::{self, WorkspaceSymbolSearchKind},
38 // Defines the server-side configuration of the rust-analyzer. We generate
39 // *parts* of VS Code's `package.json` config from this.
41 // However, editor specific config, which the server doesn't know about, should
42 // be specified directly in `package.json`.
44 // To deprecate an option by replacing it with another name use `new_name | `old_name` so that we keep
45 // parsing the old name.
48 /// How imports should be grouped into use statements.
49 assist_importGranularity |
50 assist_importMergeBehavior |
51 assist_importMergeBehaviour: ImportGranularityDef = "\"crate\"",
52 /// 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.
53 assist_importEnforceGranularity: bool = "false",
54 /// The path structure for newly inserted paths to use.
55 assist_importPrefix: ImportPrefixDef = "\"plain\"",
56 /// Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
57 assist_importGroup: bool = "true",
58 /// Whether to allow import insertion to merge new imports into single path glob imports like `use std::fmt::*;`.
59 assist_allowMergingIntoGlobImports: bool = "true",
61 /// Show function name and docs in parameter hints.
62 callInfo_full: bool = "true",
64 /// Automatically refresh project info via `cargo metadata` on
65 /// `Cargo.toml` changes.
66 cargo_autoreload: bool = "true",
67 /// Activate all available features (`--all-features`).
68 cargo_allFeatures: bool = "false",
69 /// Unsets `#[cfg(test)]` for the specified crates.
70 cargo_unsetTest: Vec<String> = "[\"core\"]",
71 /// List of features to activate.
72 cargo_features: Vec<String> = "[]",
73 /// Run build scripts (`build.rs`) for more precise code analysis.
74 cargo_runBuildScripts |
75 cargo_loadOutDirsFromCheck: bool = "true",
76 /// Use `RUSTC_WRAPPER=rust-analyzer` when running build scripts to
77 /// avoid compiling unnecessary things.
78 cargo_useRustcWrapperForBuildScripts: bool = "true",
79 /// Do not activate the `default` feature.
80 cargo_noDefaultFeatures: bool = "false",
81 /// Compilation target (target triple).
82 cargo_target: Option<String> = "null",
83 /// Internal config for debugging, disables loading of sysroot crates.
84 cargo_noSysroot: bool = "false",
86 /// Run specified `cargo check` command for diagnostics on save.
87 checkOnSave_enable: bool = "true",
88 /// Check with all features (`--all-features`).
89 /// Defaults to `#rust-analyzer.cargo.allFeatures#`.
90 checkOnSave_allFeatures: Option<bool> = "null",
91 /// Check all targets and tests (`--all-targets`).
92 checkOnSave_allTargets: bool = "true",
93 /// Cargo command to use for `cargo check`.
94 checkOnSave_command: String = "\"check\"",
95 /// Do not activate the `default` feature.
96 checkOnSave_noDefaultFeatures: Option<bool> = "null",
97 /// Check for a specific target. Defaults to
98 /// `#rust-analyzer.cargo.target#`.
99 checkOnSave_target: Option<String> = "null",
100 /// Extra arguments for `cargo check`.
101 checkOnSave_extraArgs: Vec<String> = "[]",
102 /// List of features to activate. Defaults to
103 /// `#rust-analyzer.cargo.features#`.
104 checkOnSave_features: Option<Vec<String>> = "null",
105 /// Advanced option, fully override the command rust-analyzer uses for
106 /// checking. The command should include `--message-format=json` or
108 checkOnSave_overrideCommand: Option<Vec<String>> = "null",
110 /// Whether to add argument snippets when completing functions.
111 /// Only applies when `#rust-analyzer.completion.addCallParenthesis#` is set.
112 completion_addCallArgumentSnippets: bool = "true",
113 /// Whether to add parenthesis when completing functions.
114 completion_addCallParenthesis: bool = "true",
115 /// Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
116 completion_postfix_enable: bool = "true",
117 /// Toggles the additional completions that automatically add imports when completed.
118 /// Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
119 completion_autoimport_enable: bool = "true",
120 /// Toggles the additional completions that automatically show method calls and field accesses
121 /// with `self` prefixed to them when inside a method.
122 completion_autoself_enable: bool = "true",
124 /// Whether to show native rust-analyzer diagnostics.
125 diagnostics_enable: bool = "true",
126 /// Whether to show experimental rust-analyzer diagnostics that might
127 /// have more false positives than usual.
128 diagnostics_enableExperimental: bool = "true",
129 /// List of rust-analyzer diagnostics to disable.
130 diagnostics_disabled: FxHashSet<String> = "[]",
131 /// Map of prefixes to be substituted when parsing diagnostic file paths.
132 /// This should be the reverse mapping of what is passed to `rustc` as `--remap-path-prefix`.
133 diagnostics_remapPrefix: FxHashMap<String, String> = "{}",
134 /// List of warnings that should be displayed with hint severity.
136 /// The warnings will be indicated by faded text or three dots in code
137 /// and will not show up in the `Problems Panel`.
138 diagnostics_warningsAsHint: Vec<String> = "[]",
139 /// List of warnings that should be displayed with info severity.
141 /// The warnings will be indicated by a blue squiggly underline in code
142 /// and a blue icon in the `Problems Panel`.
143 diagnostics_warningsAsInfo: Vec<String> = "[]",
145 /// Expand attribute macros.
146 experimental_procAttrMacros: bool = "false",
148 /// Controls file watching implementation.
149 files_watcher: String = "\"client\"",
150 /// These directories will be ignored by rust-analyzer. They are
151 /// relative to the workspace root, and globs are not supported. You may
152 /// also need to add the folders to Code's `files.watcherExclude`.
153 files_excludeDirs: Vec<PathBuf> = "[]",
155 /// Enables highlighting of related references while hovering your mouse above any identifier.
156 highlightRelated_references: bool = "true",
157 /// Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).
158 highlightRelated_exitPoints: bool = "true",
159 /// Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.
160 highlightRelated_breakPoints: bool = "true",
161 /// Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.
162 highlightRelated_yieldPoints: bool = "true",
164 /// Use semantic tokens for strings.
166 /// In some editors (e.g. vscode) semantic tokens override other highlighting grammars.
167 /// By disabling semantic tokens for strings, other grammars can be used to highlight
169 highlighting_strings: bool = "true",
171 /// Whether to show documentation on hover.
172 hover_documentation: bool = "true",
173 /// Use markdown syntax for links in hover.
175 hoverActions_linksInHover: bool = "true",
177 /// Whether to show `Debug` action. Only applies when
178 /// `#rust-analyzer.hoverActions.enable#` is set.
179 hoverActions_debug: bool = "true",
180 /// Whether to show HoverActions in Rust files.
181 hoverActions_enable: bool = "true",
182 /// Whether to show `Go to Type Definition` action. Only applies when
183 /// `#rust-analyzer.hoverActions.enable#` is set.
184 hoverActions_gotoTypeDef: bool = "true",
185 /// Whether to show `Implementations` action. Only applies when
186 /// `#rust-analyzer.hoverActions.enable#` is set.
187 hoverActions_implementations: bool = "true",
188 /// Whether to show `References` action. Only applies when
189 /// `#rust-analyzer.hoverActions.enable#` is set.
190 hoverActions_references: bool = "false",
191 /// Whether to show `Run` action. Only applies when
192 /// `#rust-analyzer.hoverActions.enable#` is set.
193 hoverActions_run: bool = "true",
195 /// Whether to show inlay type hints for method chains.
196 inlayHints_chainingHints: bool = "true",
197 /// Maximum length for inlay hints. Set to null to have an unlimited length.
198 inlayHints_maxLength: Option<usize> = "25",
199 /// Whether to show function parameter name inlay hints at the call
201 inlayHints_parameterHints: bool = "true",
202 /// Whether to show inlay type hints for variables.
203 inlayHints_typeHints: bool = "true",
205 /// Join lines inserts else between consecutive ifs.
206 joinLines_joinElseIf: bool = "true",
207 /// Join lines removes trailing commas.
208 joinLines_removeTrailingComma: bool = "true",
209 /// Join lines unwraps trivial blocks.
210 joinLines_unwrapTrivialBlock: bool = "true",
211 /// Join lines merges consecutive declaration and initialization of an assignment.
212 joinLines_joinAssignments: bool = "true",
214 /// Whether to show `Debug` lens. Only applies when
215 /// `#rust-analyzer.lens.enable#` is set.
216 lens_debug: bool = "true",
217 /// Whether to show CodeLens in Rust files.
218 lens_enable: bool = "true",
219 /// Whether to show `Implementations` lens. Only applies when
220 /// `#rust-analyzer.lens.enable#` is set.
221 lens_implementations: bool = "true",
222 /// Whether to show `Run` lens. Only applies when
223 /// `#rust-analyzer.lens.enable#` is set.
224 lens_run: bool = "true",
225 /// Whether to show `Method References` lens. Only applies when
226 /// `#rust-analyzer.lens.enable#` is set.
227 lens_methodReferences: bool = "false",
228 /// Whether to show `References` lens. Only applies when
229 /// `#rust-analyzer.lens.enable#` is set.
230 lens_references: bool = "false",
231 /// Internal config: use custom client-side commands even when the
232 /// client doesn't set the corresponding capability.
233 lens_forceCustomCommands: bool = "true",
235 /// Disable project auto-discovery in favor of explicitly specified set
238 /// Elements must be paths pointing to `Cargo.toml`,
239 /// `rust-project.json`, or JSON objects in `rust-project.json` format.
240 linkedProjects: Vec<ManifestOrProjectJson> = "[]",
242 /// Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
243 lruCapacity: Option<usize> = "null",
245 /// Whether to show `can't find Cargo.toml` error message.
246 notifications_cargoTomlNotFound: bool = "true",
248 /// Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
249 procMacro_enable: bool = "true",
250 /// Internal config, path to proc-macro server executable (typically,
251 /// this is rust-analyzer itself, but we override this in tests).
252 procMacro_server: Option<PathBuf> = "null",
254 /// Command to be executed instead of 'cargo' for runnables.
255 runnables_overrideCargo: Option<String> = "null",
256 /// Additional arguments to be passed to cargo for runnables such as
257 /// tests or binaries. For example, it may be `--release`.
258 runnables_cargoExtraArgs: Vec<String> = "[]",
260 /// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
261 /// projects, or "discover" to try to automatically find it.
263 /// Any project which uses rust-analyzer with the rustcPrivate
264 /// crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
266 /// This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
267 rustcSource: Option<String> = "null",
269 /// Additional arguments to `rustfmt`.
270 rustfmt_extraArgs: Vec<String> = "[]",
271 /// Advanced option, fully override the command rust-analyzer uses for
273 rustfmt_overrideCommand: Option<Vec<String>> = "null",
274 /// Enables the use of rustfmt's unstable range formatting command for the
275 /// `textDocument/rangeFormatting` request. The rustfmt option is unstable and only
276 /// available on a nightly build.
277 rustfmt_enableRangeFormatting: bool = "false",
279 /// Workspace symbol search scope.
280 workspace_symbol_search_scope: WorskpaceSymbolSearchScopeDef = "\"workspace\"",
281 /// Workspace symbol search kind.
282 workspace_symbol_search_kind: WorskpaceSymbolSearchKindDef = "\"only_types\"",
286 impl Default for ConfigData {
287 fn default() -> Self {
288 ConfigData::from_json(serde_json::Value::Null)
292 #[derive(Debug, Clone)]
294 pub caps: lsp_types::ClientCapabilities,
296 detached_files: Vec<AbsPathBuf>,
297 pub discovered_projects: Option<Vec<ProjectManifest>>,
298 pub root_path: AbsPathBuf,
301 #[derive(Debug, Clone, Eq, PartialEq)]
302 pub enum LinkedProject {
303 ProjectManifest(ProjectManifest),
304 InlineJsonProject(ProjectJson),
307 impl From<ProjectManifest> for LinkedProject {
308 fn from(v: ProjectManifest) -> Self {
309 LinkedProject::ProjectManifest(v)
313 impl From<ProjectJson> for LinkedProject {
314 fn from(v: ProjectJson) -> Self {
315 LinkedProject::InlineJsonProject(v)
319 #[derive(Clone, Debug, PartialEq, Eq)]
320 pub struct LensConfig {
323 pub implementations: bool,
324 pub method_refs: bool,
325 pub refs: bool, // for Struct, Enum, Union and Trait
329 pub fn any(&self) -> bool {
330 self.implementations || self.runnable() || self.references()
333 pub fn none(&self) -> bool {
337 pub fn runnable(&self) -> bool {
338 self.run || self.debug
341 pub fn references(&self) -> bool {
342 self.method_refs || self.refs
346 #[derive(Clone, Debug, PartialEq, Eq)]
347 pub struct HoverActionsConfig {
348 pub implementations: bool,
349 pub references: bool,
352 pub goto_type_def: bool,
355 impl HoverActionsConfig {
356 pub const NO_ACTIONS: Self = Self {
357 implementations: false,
361 goto_type_def: false,
364 pub fn any(&self) -> bool {
365 self.implementations || self.references || self.runnable() || self.goto_type_def
368 pub fn none(&self) -> bool {
372 pub fn runnable(&self) -> bool {
373 self.run || self.debug
377 #[derive(Debug, Clone)]
378 pub struct FilesConfig {
379 pub watcher: FilesWatcher,
380 pub exclude: Vec<AbsPathBuf>,
383 #[derive(Debug, Clone)]
384 pub enum FilesWatcher {
389 #[derive(Debug, Clone)]
390 pub struct NotificationsConfig {
391 pub cargo_toml_not_found: bool,
394 #[derive(Debug, Clone)]
395 pub enum RustfmtConfig {
396 Rustfmt { extra_args: Vec<String>, enable_range_formatting: bool },
397 CustomCommand { command: String, args: Vec<String> },
400 /// Configuration for runnable items, such as `main` function or tests.
401 #[derive(Debug, Clone)]
402 pub struct RunnablesConfig {
403 /// Custom command to be executed instead of `cargo` for runnables.
404 pub override_cargo: Option<String>,
405 /// Additional arguments for the `cargo`, e.g. `--release`.
406 pub cargo_extra_args: Vec<String>,
409 /// Configuration for workspace symbol search requests.
410 #[derive(Debug, Clone)]
411 pub struct WorkspaceSymbolConfig {
412 /// In what scope should the symbol be searched in.
413 pub search_scope: WorkspaceSymbolSearchScope,
414 /// What kind of symbol is being search for.
415 pub search_kind: WorkspaceSymbolSearchKind,
418 pub struct ClientCommandsConfig {
419 pub run_single: bool,
420 pub debug_single: bool,
421 pub show_reference: bool,
422 pub goto_location: bool,
423 pub trigger_parameter_hints: bool,
427 pub fn new(root_path: AbsPathBuf, caps: ClientCapabilities) -> Self {
430 data: ConfigData::default(),
431 detached_files: Vec::new(),
432 discovered_projects: None,
436 pub fn update(&mut self, mut json: serde_json::Value) {
437 log::info!("updating config from JSON: {:#}", json);
438 if json.is_null() || json.as_object().map_or(false, |it| it.is_empty()) {
441 self.detached_files = get_field::<Vec<PathBuf>>(&mut json, "detachedFiles", None, "[]")
443 .map(AbsPathBuf::assert)
445 self.data = ConfigData::from_json(json);
448 pub fn json_schema() -> serde_json::Value {
449 ConfigData::json_schema()
455 || -> _ { Some($expr) }()
458 macro_rules! try_or {
459 ($expr:expr, $or:expr) => {
460 try_!($expr).unwrap_or($or)
465 pub fn linked_projects(&self) -> Vec<LinkedProject> {
466 if self.data.linkedProjects.is_empty() {
467 self.discovered_projects
472 .map(LinkedProject::from)
478 .filter_map(|linked_project| {
479 let res = match linked_project {
480 ManifestOrProjectJson::Manifest(it) => {
481 let path = self.root_path.join(it);
482 ProjectManifest::from_manifest_file(path)
483 .map_err(|e| log::error!("failed to load linked project: {}", e))
487 ManifestOrProjectJson::ProjectJson(it) => {
488 ProjectJson::new(&self.root_path, it.clone()).into()
497 pub fn detached_files(&self) -> &[AbsPathBuf] {
501 pub fn did_save_text_document_dynamic_registration(&self) -> bool {
503 try_or!(self.caps.text_document.as_ref()?.synchronization.clone()?, Default::default());
504 caps.did_save == Some(true) && caps.dynamic_registration == Some(true)
506 pub fn did_change_watched_files_dynamic_registration(&self) -> bool {
508 self.caps.workspace.as_ref()?.did_change_watched_files.as_ref()?.dynamic_registration?,
513 pub fn location_link(&self) -> bool {
514 try_or!(self.caps.text_document.as_ref()?.definition?.link_support?, false)
516 pub fn line_folding_only(&self) -> bool {
517 try_or!(self.caps.text_document.as_ref()?.folding_range.as_ref()?.line_folding_only?, false)
519 pub fn hierarchical_symbols(&self) -> bool {
526 .hierarchical_document_symbol_support?,
530 pub fn code_action_literals(&self) -> bool {
537 .code_action_literal_support
541 pub fn work_done_progress(&self) -> bool {
542 try_or!(self.caps.window.as_ref()?.work_done_progress?, false)
544 pub fn will_rename(&self) -> bool {
545 try_or!(self.caps.workspace.as_ref()?.file_operations.as_ref()?.will_rename?, false)
547 pub fn change_annotation_support(&self) -> bool {
554 .change_annotation_support
558 pub fn code_action_resolve(&self) -> bool {
572 .any(|it| it == "edit")
574 pub fn signature_help_label_offsets(&self) -> bool {
581 .signature_information
583 .parameter_information
585 .label_offset_support?,
589 pub fn offset_encoding(&self) -> OffsetEncoding {
590 if supports_utf8(&self.caps) {
593 OffsetEncoding::Utf16
597 fn experimental(&self, index: &'static str) -> bool {
598 try_or!(self.caps.experimental.as_ref()?.get(index)?.as_bool()?, false)
600 pub fn code_action_group(&self) -> bool {
601 self.experimental("codeActionGroup")
603 pub fn server_status_notification(&self) -> bool {
604 self.experimental("serverStatusNotification")
607 pub fn publish_diagnostics(&self) -> bool {
608 self.data.diagnostics_enable
610 pub fn diagnostics(&self) -> DiagnosticsConfig {
612 disable_experimental: !self.data.diagnostics_enableExperimental,
613 disabled: self.data.diagnostics_disabled.clone(),
616 pub fn diagnostics_map(&self) -> DiagnosticsMapConfig {
617 DiagnosticsMapConfig {
618 remap_prefix: self.data.diagnostics_remapPrefix.clone(),
619 warnings_as_info: self.data.diagnostics_warningsAsInfo.clone(),
620 warnings_as_hint: self.data.diagnostics_warningsAsHint.clone(),
623 pub fn lru_capacity(&self) -> Option<usize> {
624 self.data.lruCapacity
626 pub fn proc_macro_srv(&self) -> Option<(AbsPathBuf, Vec<OsString>)> {
627 if !self.data.procMacro_enable {
630 let path = match &self.data.procMacro_server {
631 Some(it) => self.root_path.join(it),
632 None => AbsPathBuf::assert(std::env::current_exe().ok()?),
634 Some((path, vec!["proc-macro".into()]))
636 pub fn expand_proc_attr_macros(&self) -> bool {
637 self.data.experimental_procAttrMacros
639 pub fn files(&self) -> FilesConfig {
641 watcher: match self.data.files_watcher.as_str() {
642 "notify" => FilesWatcher::Notify,
643 "client" | _ => FilesWatcher::Client,
645 exclude: self.data.files_excludeDirs.iter().map(|it| self.root_path.join(it)).collect(),
648 pub fn notifications(&self) -> NotificationsConfig {
649 NotificationsConfig { cargo_toml_not_found: self.data.notifications_cargoTomlNotFound }
651 pub fn cargo_autoreload(&self) -> bool {
652 self.data.cargo_autoreload
654 pub fn run_build_scripts(&self) -> bool {
655 self.data.cargo_runBuildScripts || self.data.procMacro_enable
657 pub fn cargo(&self) -> CargoConfig {
658 let rustc_source = self.data.rustcSource.as_ref().map(|rustc_src| {
659 if rustc_src == "discover" {
660 RustcSource::Discover
662 RustcSource::Path(self.root_path.join(rustc_src))
667 no_default_features: self.data.cargo_noDefaultFeatures,
668 all_features: self.data.cargo_allFeatures,
669 features: self.data.cargo_features.clone(),
670 target: self.data.cargo_target.clone(),
671 no_sysroot: self.data.cargo_noSysroot,
673 unset_test_crates: UnsetTestCrates::Only(self.data.cargo_unsetTest.clone()),
674 wrap_rustc_in_build_scripts: self.data.cargo_useRustcWrapperForBuildScripts,
678 pub fn rustfmt(&self) -> RustfmtConfig {
679 match &self.data.rustfmt_overrideCommand {
680 Some(args) if !args.is_empty() => {
681 let mut args = args.clone();
682 let command = args.remove(0);
683 RustfmtConfig::CustomCommand { command, args }
685 Some(_) | None => RustfmtConfig::Rustfmt {
686 extra_args: self.data.rustfmt_extraArgs.clone(),
687 enable_range_formatting: self.data.rustfmt_enableRangeFormatting,
691 pub fn flycheck(&self) -> Option<FlycheckConfig> {
692 if !self.data.checkOnSave_enable {
695 let flycheck_config = match &self.data.checkOnSave_overrideCommand {
696 Some(args) if !args.is_empty() => {
697 let mut args = args.clone();
698 let command = args.remove(0);
699 FlycheckConfig::CustomCommand { command, args }
701 Some(_) | None => FlycheckConfig::CargoCommand {
702 command: self.data.checkOnSave_command.clone(),
707 .or_else(|| self.data.cargo_target.clone()),
708 all_targets: self.data.checkOnSave_allTargets,
709 no_default_features: self
711 .checkOnSave_noDefaultFeatures
712 .unwrap_or(self.data.cargo_noDefaultFeatures),
715 .checkOnSave_allFeatures
716 .unwrap_or(self.data.cargo_allFeatures),
719 .checkOnSave_features
721 .unwrap_or_else(|| self.data.cargo_features.clone()),
722 extra_args: self.data.checkOnSave_extraArgs.clone(),
725 Some(flycheck_config)
727 pub fn runnables(&self) -> RunnablesConfig {
729 override_cargo: self.data.runnables_overrideCargo.clone(),
730 cargo_extra_args: self.data.runnables_cargoExtraArgs.clone(),
733 pub fn inlay_hints(&self) -> InlayHintsConfig {
735 type_hints: self.data.inlayHints_typeHints,
736 parameter_hints: self.data.inlayHints_parameterHints,
737 chaining_hints: self.data.inlayHints_chainingHints,
738 max_length: self.data.inlayHints_maxLength,
741 fn insert_use_config(&self) -> InsertUseConfig {
743 granularity: match self.data.assist_importGranularity {
744 ImportGranularityDef::Preserve => ImportGranularity::Preserve,
745 ImportGranularityDef::Item => ImportGranularity::Item,
746 ImportGranularityDef::Crate => ImportGranularity::Crate,
747 ImportGranularityDef::Module => ImportGranularity::Module,
749 enforce_granularity: self.data.assist_importEnforceGranularity,
750 prefix_kind: match self.data.assist_importPrefix {
751 ImportPrefixDef::Plain => PrefixKind::Plain,
752 ImportPrefixDef::ByCrate => PrefixKind::ByCrate,
753 ImportPrefixDef::BySelf => PrefixKind::BySelf,
755 group: self.data.assist_importGroup,
756 skip_glob_imports: !self.data.assist_allowMergingIntoGlobImports,
759 pub fn completion(&self) -> CompletionConfig {
761 enable_postfix_completions: self.data.completion_postfix_enable,
762 enable_imports_on_the_fly: self.data.completion_autoimport_enable
763 && completion_item_edit_resolve(&self.caps),
764 enable_self_on_the_fly: self.data.completion_autoself_enable,
765 add_call_parenthesis: self.data.completion_addCallParenthesis,
766 add_call_argument_snippets: self.data.completion_addCallArgumentSnippets,
767 insert_use: self.insert_use_config(),
768 snippet_cap: SnippetCap::new(try_or!(
781 pub fn assist(&self) -> AssistConfig {
783 snippet_cap: SnippetCap::new(self.experimental("snippetTextEdit")),
785 insert_use: self.insert_use_config(),
788 pub fn join_lines(&self) -> JoinLinesConfig {
790 join_else_if: self.data.joinLines_joinElseIf,
791 remove_trailing_comma: self.data.joinLines_removeTrailingComma,
792 unwrap_trivial_blocks: self.data.joinLines_unwrapTrivialBlock,
793 join_assignments: self.data.joinLines_joinAssignments,
796 pub fn call_info_full(&self) -> bool {
797 self.data.callInfo_full
799 pub fn lens(&self) -> LensConfig {
801 run: self.data.lens_enable && self.data.lens_run,
802 debug: self.data.lens_enable && self.data.lens_debug,
803 implementations: self.data.lens_enable && self.data.lens_implementations,
804 method_refs: self.data.lens_enable && self.data.lens_methodReferences,
805 refs: self.data.lens_enable && self.data.lens_references,
808 pub fn hover_actions(&self) -> HoverActionsConfig {
809 let enable = self.experimental("hoverActions") && self.data.hoverActions_enable;
811 implementations: enable && self.data.hoverActions_implementations,
812 references: enable && self.data.hoverActions_references,
813 run: enable && self.data.hoverActions_run,
814 debug: enable && self.data.hoverActions_debug,
815 goto_type_def: enable && self.data.hoverActions_gotoTypeDef,
818 pub fn highlighting_strings(&self) -> bool {
819 self.data.highlighting_strings
821 pub fn hover(&self) -> HoverConfig {
823 links_in_hover: self.data.hover_linksInHover,
824 documentation: self.data.hover_documentation.then(|| {
825 let is_markdown = try_or!(
836 .contains(&MarkupKind::Markdown);
838 HoverDocFormat::Markdown
840 HoverDocFormat::PlainText
846 pub fn workspace_symbol(&self) -> WorkspaceSymbolConfig {
847 WorkspaceSymbolConfig {
848 search_scope: match self.data.workspace_symbol_search_scope {
849 WorskpaceSymbolSearchScopeDef::Workspace => WorkspaceSymbolSearchScope::Workspace,
850 WorskpaceSymbolSearchScopeDef::WorkspaceAndDependencies => {
851 WorkspaceSymbolSearchScope::WorkspaceAndDependencies
854 search_kind: match self.data.workspace_symbol_search_kind {
855 WorskpaceSymbolSearchKindDef::OnlyTypes => WorkspaceSymbolSearchKind::OnlyTypes,
856 WorskpaceSymbolSearchKindDef::AllSymbols => WorkspaceSymbolSearchKind::AllSymbols,
861 pub fn semantic_tokens_refresh(&self) -> bool {
862 try_or!(self.caps.workspace.as_ref()?.semantic_tokens.as_ref()?.refresh_support?, false)
864 pub fn code_lens_refresh(&self) -> bool {
865 try_or!(self.caps.workspace.as_ref()?.code_lens.as_ref()?.refresh_support?, false)
867 pub fn insert_replace_support(&self) -> bool {
876 .insert_replace_support?,
880 pub fn client_commands(&self) -> ClientCommandsConfig {
882 try_or!(self.caps.experimental.as_ref()?.get("commands")?, &serde_json::Value::Null);
883 let commands: Option<lsp_ext::ClientCommandOptions> =
884 serde_json::from_value(commands.clone()).ok();
885 let force = commands.is_none() && self.data.lens_forceCustomCommands;
886 let commands = commands.map(|it| it.commands).unwrap_or_default();
888 let get = |name: &str| commands.iter().any(|it| it == name) || force;
890 ClientCommandsConfig {
891 run_single: get("rust-analyzer.runSingle"),
892 debug_single: get("rust-analyzer.debugSingle"),
893 show_reference: get("rust-analyzer.showReferences"),
894 goto_location: get("rust-analyzer.gotoLocation"),
895 trigger_parameter_hints: get("editor.action.triggerParameterHints"),
899 pub fn highlight_related(&self) -> HighlightRelatedConfig {
900 HighlightRelatedConfig {
901 references: self.data.highlightRelated_references,
902 break_points: self.data.highlightRelated_breakPoints,
903 exit_points: self.data.highlightRelated_exitPoints,
904 yield_points: self.data.highlightRelated_yieldPoints,
909 #[derive(Deserialize, Debug, Clone)]
911 enum ManifestOrProjectJson {
913 ProjectJson(ProjectJsonData),
916 #[derive(Deserialize, Debug, Clone)]
917 #[serde(rename_all = "snake_case")]
918 enum ImportGranularityDef {
920 #[serde(alias = "none")]
922 #[serde(alias = "full")]
924 #[serde(alias = "last")]
928 #[derive(Deserialize, Debug, Clone)]
929 #[serde(rename_all = "snake_case")]
930 enum ImportPrefixDef {
932 #[serde(alias = "self")]
934 #[serde(alias = "crate")]
938 #[derive(Deserialize, Debug, Clone)]
939 #[serde(rename_all = "snake_case")]
940 enum WorskpaceSymbolSearchScopeDef {
942 WorkspaceAndDependencies,
945 #[derive(Deserialize, Debug, Clone)]
946 #[serde(rename_all = "snake_case")]
947 enum WorskpaceSymbolSearchKindDef {
952 macro_rules! _config_data {
953 (struct $name:ident {
955 $(#[doc=$doc:literal])*
956 $field:ident $(| $alias:ident)*: $ty:ty = $default:expr,
959 #[allow(non_snake_case)]
960 #[derive(Debug, Clone)]
961 struct $name { $($field: $ty,)* }
963 fn from_json(mut json: serde_json::Value) -> $name {
968 None$(.or(Some(stringify!($alias))))*,
974 fn json_schema() -> serde_json::Value {
977 let field = stringify!($field);
978 let ty = stringify!($ty);
980 (field, ty, &[$($doc),*], $default)
986 fn manual() -> String {
989 let field = stringify!($field);
990 let ty = stringify!($ty);
992 (field, ty, &[$($doc),*], $default)
999 use _config_data as config_data;
1001 fn get_field<T: DeserializeOwned>(
1002 json: &mut serde_json::Value,
1003 field: &'static str,
1004 alias: Option<&'static str>,
1007 let default = serde_json::from_str(default).unwrap();
1009 // XXX: check alias first, to work-around the VS Code where it pre-fills the
1010 // defaults instead of sending an empty object.
1013 .chain(iter::once(field))
1014 .find_map(move |field| {
1015 let mut pointer = field.replace('_', "/");
1016 pointer.insert(0, '/');
1017 json.pointer_mut(&pointer).and_then(|it| serde_json::from_value(it.take()).ok())
1022 fn schema(fields: &[(&'static str, &'static str, &[&str], &str)]) -> serde_json::Value {
1023 for ((f1, ..), (f2, ..)) in fields.iter().zip(&fields[1..]) {
1024 fn key(f: &str) -> &str {
1025 f.splitn(2, '_').next().unwrap()
1027 assert!(key(f1) <= key(f2), "wrong field order: {:?} {:?}", f1, f2);
1032 .map(|(field, ty, doc, default)| {
1033 let name = field.replace("_", ".");
1034 let name = format!("rust-analyzer.{}", name);
1035 let props = field_props(field, ty, doc, default);
1038 .collect::<serde_json::Map<_, _>>();
1042 fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json::Value {
1043 let doc = doc_comment_to_string(doc);
1044 let doc = doc.trim_end_matches('\n');
1046 doc.ends_with('.') && doc.starts_with(char::is_uppercase),
1047 "bad docs for {}: {:?}",
1051 let default = default.parse::<serde_json::Value>().unwrap();
1053 let mut map = serde_json::Map::default();
1055 ($($key:literal: $value:tt),*$(,)?) => {{$(
1056 map.insert($key.into(), serde_json::json!($value));
1059 set!("markdownDescription": doc);
1060 set!("default": default);
1063 "bool" => set!("type": "boolean"),
1064 "String" => set!("type": "string"),
1065 "Vec<String>" => set! {
1067 "items": { "type": "string" },
1069 "Vec<PathBuf>" => set! {
1071 "items": { "type": "string" },
1073 "FxHashSet<String>" => set! {
1075 "items": { "type": "string" },
1076 "uniqueItems": true,
1078 "FxHashMap<String, String>" => set! {
1081 "Option<usize>" => set! {
1082 "type": ["null", "integer"],
1085 "Option<String>" => set! {
1086 "type": ["null", "string"],
1088 "Option<PathBuf>" => set! {
1089 "type": ["null", "string"],
1091 "Option<bool>" => set! {
1092 "type": ["null", "boolean"],
1094 "Option<Vec<String>>" => set! {
1095 "type": ["null", "array"],
1096 "items": { "type": "string" },
1098 "MergeBehaviorDef" => set! {
1100 "enum": ["none", "crate", "module"],
1101 "enumDescriptions": [
1102 "Do not merge imports at all.",
1103 "Merge imports from the same crate into a single `use` statement.",
1104 "Merge imports from the same module into a single `use` statement."
1107 "ImportGranularityDef" => set! {
1109 "enum": ["preserve", "crate", "module", "item"],
1110 "enumDescriptions": [
1111 "Do not change the granularity of any imports and preserve the original structure written by the developer.",
1112 "Merge imports from the same crate into a single use statement. Conversely, imports from different crates are split into separate statements.",
1113 "Merge imports from the same module into a single use statement. Conversely, imports from different modules are split into separate statements.",
1114 "Flatten imports so that each has its own use statement."
1117 "ImportPrefixDef" => set! {
1124 "enumDescriptions": [
1125 "Insert import paths relative to the current module, using up to one `super` prefix if the parent module contains the requested item.",
1126 "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.",
1127 "Force import paths to be absolute by always starting them with `crate` or the extern crate name they come from."
1130 "Vec<ManifestOrProjectJson>" => set! {
1132 "items": { "type": ["string", "object"] },
1134 "WorskpaceSymbolSearchScopeDef" => set! {
1136 "enum": ["workspace", "workspace_and_dependencies"],
1137 "enumDescriptions": [
1138 "Search in current workspace only",
1139 "Search in current workspace and dependencies"
1142 "WorskpaceSymbolSearchKindDef" => set! {
1144 "enum": ["only_types", "all_symbols"],
1145 "enumDescriptions": [
1146 "Search for types only",
1147 "Search for all symbols kinds"
1150 _ => panic!("{}: {}", ty, default),
1157 fn manual(fields: &[(&'static str, &'static str, &[&str], &str)]) -> String {
1160 .map(|(field, _ty, doc, default)| {
1161 let name = format!("rust-analyzer.{}", field.replace("_", "."));
1162 let doc = doc_comment_to_string(*doc);
1163 format!("[[{}]]{} (default: `{}`)::\n+\n--\n{}--\n", name, name, default, doc)
1165 .collect::<String>()
1168 fn doc_comment_to_string(doc: &[&str]) -> String {
1169 doc.iter().map(|it| it.strip_prefix(' ').unwrap_or(it)).map(|it| format!("{}\n", it)).collect()
1176 use test_utils::{ensure_file_contents, project_root};
1181 fn generate_package_json_config() {
1182 let s = Config::json_schema();
1183 let schema = format!("{:#}", s);
1184 let mut schema = schema
1185 .trim_start_matches('{')
1186 .trim_end_matches('}')
1188 .replace("\n", "\n ")
1189 .trim_start_matches('\n')
1192 schema.push_str(",\n");
1194 let package_json_path = project_root().join("editors/code/package.json");
1195 let mut package_json = fs::read_to_string(&package_json_path).unwrap();
1197 let start_marker = " \"$generated-start\": {},\n";
1198 let end_marker = " \"$generated-end\": {}\n";
1200 let start = package_json.find(start_marker).unwrap() + start_marker.len();
1201 let end = package_json.find(end_marker).unwrap();
1203 let p = remove_ws(&package_json[start..end]);
1204 let s = remove_ws(&schema);
1205 if !p.contains(&s) {
1206 package_json.replace_range(start..end, &schema);
1207 ensure_file_contents(&package_json_path, &package_json)
1212 fn generate_config_documentation() {
1213 let docs_path = project_root().join("docs/user/generated_config.adoc");
1214 let expected = ConfigData::manual();
1215 ensure_file_contents(&docs_path, &expected);
1218 fn remove_ws(text: &str) -> String {
1219 text.replace(char::is_whitespace, "")