From 37b7b5682119c94c282cce85a9ac2783957c50d4 Mon Sep 17 00:00:00 2001
From: Aleksey Kladov <aleksey.kladov@gmail.com>
Date: Tue, 9 Mar 2021 14:43:05 +0300
Subject: [PATCH] Make code less surprising
Theres no reason to have literal `\n\n` in the source code
---
crates/rust-analyzer/src/config.rs | 38 ++--
docs/user/generated_config.adoc | 322 ++++++++++++++++++++++++-----
editors/code/package.json | 48 ++---
3 files changed, 310 insertions(+), 98 deletions(-)
diff --git a/crates/rust-analyzer/src/config.rs b/crates/rust-analyzer/src/config.rs
index 28e2212714c..25df1355460 100644
--- a/crates/rust-analyzer/src/config.rs
+++ b/crates/rust-analyzer/src/config.rs
@@ -16,7 +16,6 @@ use ide_db::helpers::{
insert_use::{InsertUseConfig, MergeBehavior},
SnippetCap,
};
-use itertools::Itertools;
use lsp_types::{ClientCapabilities, MarkupKind};
use project_model::{CargoConfig, ProjectJson, ProjectJsonData, ProjectManifest, RustcSource};
use rustc_hash::FxHashSet;
@@ -98,13 +97,15 @@ config_data! {
diagnostics_enableExperimental: bool = "true",
/// List of rust-analyzer diagnostics to disable.
diagnostics_disabled: FxHashSet<String> = "[]",
- /// List of warnings that should be displayed with info severity.\n\nThe
- /// warnings will be indicated by a blue squiggly underline in code and
- /// a blue icon in the `Problems Panel`.
+ /// List of warnings that should be displayed with info severity.
+ ///
+ /// The warnings will be indicated by a blue squiggly underline in code
+ /// and a blue icon in the `Problems Panel`.
diagnostics_warningsAsHint: Vec<String> = "[]",
- /// List of warnings that should be displayed with hint severity.\n\nThe
- /// warnings will be indicated by faded text or three dots in code and
- /// will not show up in the `Problems Panel`.
+ /// List of warnings that should be displayed with hint severity.
+ ///
+ /// The warnings will be indicated by faded text or three dots in code
+ /// and will not show up in the `Problems Panel`.
diagnostics_warningsAsInfo: Vec<String> = "[]",
/// Controls file watching implementation.
@@ -158,7 +159,9 @@ config_data! {
lens_references: bool = "false",
/// Disable project auto-discovery in favor of explicitly specified set
- /// of projects.\n\nElements must be paths pointing to `Cargo.toml`,
+ /// of projects.
+ ///
+ /// Elements must be paths pointing to `Cargo.toml`,
/// `rust-project.json`, or JSON objects in `rust-project.json` format.
linkedProjects: Vec<ManifestOrProjectJson> = "[]",
@@ -177,7 +180,7 @@ config_data! {
/// Command to be executed instead of 'cargo' for runnables.
runnables_overrideCargo: Option<String> = "null",
/// Additional arguments to be passed to cargo for runnables such as
- /// tests or binaries.\nFor example, it may be `--release`.
+ /// tests or binaries. For example, it may be `--release`.
runnables_cargoExtraArgs: Vec<String> = "[]",
/// Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
@@ -765,7 +768,8 @@ fn schema(fields: &[(&'static str, &'static str, &[&str], &str)]) -> serde_json:
}
fn field_props(field: &str, ty: &str, doc: &[&str], default: &str) -> serde_json::Value {
- let doc = doc.iter().map(|it| it.trim()).join(" ");
+ let doc = doc_comment_to_string(doc);
+ let doc = doc.trim_end_matches('\n');
assert!(
doc.ends_with('.') && doc.starts_with(char::is_uppercase),
"bad docs for {}: {:?}",
@@ -854,11 +858,16 @@ fn manual(fields: &[(&'static str, &'static str, &[&str], &str)]) -> String {
.iter()
.map(|(field, _ty, doc, default)| {
let name = format!("rust-analyzer.{}", field.replace("_", "."));
- format!("[[{}]]{} (default: `{}`)::\n{}\n", name, name, default, doc.join(" "))
+ let doc = doc_comment_to_string(*doc);
+ format!("[[{}]]{} (default: `{}`)::\n+\n--\n{}--\n", name, name, default, doc)
})
.collect::<String>()
}
+fn doc_comment_to_string(doc: &[&str]) -> String {
+ doc.iter().map(|it| it.strip_prefix(' ').unwrap_or(it)).map(|it| format!("{}\n", it)).collect()
+}
+
#[cfg(test)]
mod tests {
use std::fs;
@@ -901,13 +910,8 @@ mod tests {
#[test]
fn generate_config_documentation() {
let docs_path = project_root().join("docs/user/generated_config.adoc");
- let current = fs::read_to_string(&docs_path).unwrap();
let expected = ConfigData::manual();
-
- if remove_ws(¤t) != remove_ws(&expected) {
- fs::write(&docs_path, expected).unwrap();
- panic!("updated config manual");
- }
+ ensure_file_contents(&docs_path, &expected);
}
fn remove_ws(text: &str) -> String {
diff --git a/docs/user/generated_config.adoc b/docs/user/generated_config.adoc
index e0ffcc4843c..042ba2d54c0 100644
--- a/docs/user/generated_config.adoc
+++ b/docs/user/generated_config.adoc
@@ -1,114 +1,322 @@
[[rust-analyzer.assist.importMergeBehavior]]rust-analyzer.assist.importMergeBehavior (default: `"full"`)::
- The strategy to use when inserting new imports or merging imports.
++
+--
+The strategy to use when inserting new imports or merging imports.
+--
[[rust-analyzer.assist.importPrefix]]rust-analyzer.assist.importPrefix (default: `"plain"`)::
- The path structure for newly inserted paths to use.
++
+--
+The path structure for newly inserted paths to use.
+--
[[rust-analyzer.assist.importGroup]]rust-analyzer.assist.importGroup (default: `true`)::
- Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
++
+--
+Group inserted imports by the [following order](https://rust-analyzer.github.io/manual.html#auto-import). Groups are separated by newlines.
+--
[[rust-analyzer.callInfo.full]]rust-analyzer.callInfo.full (default: `true`)::
- Show function name and docs in parameter hints.
++
+--
+Show function name and docs in parameter hints.
+--
[[rust-analyzer.cargo.autoreload]]rust-analyzer.cargo.autoreload (default: `true`)::
- Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes.
++
+--
+Automatically refresh project info via `cargo metadata` on
+`Cargo.toml` changes.
+--
[[rust-analyzer.cargo.allFeatures]]rust-analyzer.cargo.allFeatures (default: `false`)::
- Activate all available features (`--all-features`).
++
+--
+Activate all available features (`--all-features`).
+--
[[rust-analyzer.cargo.features]]rust-analyzer.cargo.features (default: `[]`)::
- List of features to activate.
++
+--
+List of features to activate.
+--
[[rust-analyzer.cargo.runBuildScripts]]rust-analyzer.cargo.runBuildScripts (default: `true`)::
- Run build scripts (`build.rs`) for more precise code analysis.
++
+--
+Run build scripts (`build.rs`) for more precise code analysis.
+--
[[rust-analyzer.cargo.noDefaultFeatures]]rust-analyzer.cargo.noDefaultFeatures (default: `false`)::
- Do not activate the `default` feature.
++
+--
+Do not activate the `default` feature.
+--
[[rust-analyzer.cargo.target]]rust-analyzer.cargo.target (default: `null`)::
- Compilation target (target triple).
++
+--
+Compilation target (target triple).
+--
[[rust-analyzer.cargo.noSysroot]]rust-analyzer.cargo.noSysroot (default: `false`)::
- Internal config for debugging, disables loading of sysroot crates.
++
+--
+Internal config for debugging, disables loading of sysroot crates.
+--
[[rust-analyzer.checkOnSave.enable]]rust-analyzer.checkOnSave.enable (default: `true`)::
- Run specified `cargo check` command for diagnostics on save.
++
+--
+Run specified `cargo check` command for diagnostics on save.
+--
[[rust-analyzer.checkOnSave.allFeatures]]rust-analyzer.checkOnSave.allFeatures (default: `null`)::
- Check with all features (`--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`.
++
+--
+Check with all features (`--all-features`).
+Defaults to `#rust-analyzer.cargo.allFeatures#`.
+--
[[rust-analyzer.checkOnSave.allTargets]]rust-analyzer.checkOnSave.allTargets (default: `true`)::
- Check all targets and tests (`--all-targets`).
++
+--
+Check all targets and tests (`--all-targets`).
+--
[[rust-analyzer.checkOnSave.command]]rust-analyzer.checkOnSave.command (default: `"check"`)::
- Cargo command to use for `cargo check`.
++
+--
+Cargo command to use for `cargo check`.
+--
[[rust-analyzer.checkOnSave.noDefaultFeatures]]rust-analyzer.checkOnSave.noDefaultFeatures (default: `null`)::
- Do not activate the `default` feature.
++
+--
+Do not activate the `default` feature.
+--
[[rust-analyzer.checkOnSave.target]]rust-analyzer.checkOnSave.target (default: `null`)::
- Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`.
++
+--
+Check for a specific target. Defaults to
+`#rust-analyzer.cargo.target#`.
+--
[[rust-analyzer.checkOnSave.extraArgs]]rust-analyzer.checkOnSave.extraArgs (default: `[]`)::
- Extra arguments for `cargo check`.
++
+--
+Extra arguments for `cargo check`.
+--
[[rust-analyzer.checkOnSave.features]]rust-analyzer.checkOnSave.features (default: `null`)::
- List of features to activate. Defaults to `#rust-analyzer.cargo.features#`.
++
+--
+List of features to activate. Defaults to
+`#rust-analyzer.cargo.features#`.
+--
[[rust-analyzer.checkOnSave.overrideCommand]]rust-analyzer.checkOnSave.overrideCommand (default: `null`)::
- Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option.
++
+--
+Advanced option, fully override the command rust-analyzer uses for
+checking. The command should include `--message-format=json` or
+similar option.
+--
[[rust-analyzer.completion.addCallArgumentSnippets]]rust-analyzer.completion.addCallArgumentSnippets (default: `true`)::
- Whether to add argument snippets when completing functions.
++
+--
+Whether to add argument snippets when completing functions.
+--
[[rust-analyzer.completion.addCallParenthesis]]rust-analyzer.completion.addCallParenthesis (default: `true`)::
- Whether to add parenthesis when completing functions.
++
+--
+Whether to add parenthesis when completing functions.
+--
[[rust-analyzer.completion.postfix.enable]]rust-analyzer.completion.postfix.enable (default: `true`)::
- Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
++
+--
+Whether to show postfix snippets like `dbg`, `if`, `not`, etc.
+--
[[rust-analyzer.completion.autoimport.enable]]rust-analyzer.completion.autoimport.enable (default: `true`)::
- Toggles the additional completions that automatically add imports when completed. Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
++
+--
+Toggles the additional completions that automatically add imports when completed.
+Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.
+--
[[rust-analyzer.diagnostics.enable]]rust-analyzer.diagnostics.enable (default: `true`)::
- Whether to show native rust-analyzer diagnostics.
++
+--
+Whether to show native rust-analyzer diagnostics.
+--
[[rust-analyzer.diagnostics.enableExperimental]]rust-analyzer.diagnostics.enableExperimental (default: `true`)::
- Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.
++
+--
+Whether to show experimental rust-analyzer diagnostics that might
+have more false positives than usual.
+--
[[rust-analyzer.diagnostics.disabled]]rust-analyzer.diagnostics.disabled (default: `[]`)::
- List of rust-analyzer diagnostics to disable.
++
+--
+List of rust-analyzer diagnostics to disable.
+--
[[rust-analyzer.diagnostics.warningsAsHint]]rust-analyzer.diagnostics.warningsAsHint (default: `[]`)::
- List of warnings that should be displayed with info severity.\n\nThe warnings will be indicated by a blue squiggly underline in code and a blue icon in the `Problems Panel`.
++
+--
+List of warnings that should be displayed with info severity.
+
+The warnings will be indicated by a blue squiggly underline in code
+and a blue icon in the `Problems Panel`.
+--
[[rust-analyzer.diagnostics.warningsAsInfo]]rust-analyzer.diagnostics.warningsAsInfo (default: `[]`)::
- List of warnings that should be displayed with hint severity.\n\nThe warnings will be indicated by faded text or three dots in code and will not show up in the `Problems Panel`.
++
+--
+List of warnings that should be displayed with hint severity.
+
+The warnings will be indicated by faded text or three dots in code
+and will not show up in the `Problems Panel`.
+--
[[rust-analyzer.files.watcher]]rust-analyzer.files.watcher (default: `"client"`)::
- Controls file watching implementation.
++
+--
+Controls file watching implementation.
+--
[[rust-analyzer.files.excludeDirs]]rust-analyzer.files.excludeDirs (default: `[]`)::
- These directories will be ignored by rust-analyzer.
++
+--
+These directories will be ignored by rust-analyzer.
+--
[[rust-analyzer.hoverActions.debug]]rust-analyzer.hoverActions.debug (default: `true`)::
- Whether to show `Debug` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
++
+--
+Whether to show `Debug` action. Only applies when
+`#rust-analyzer.hoverActions.enable#` is set.
+--
[[rust-analyzer.hoverActions.enable]]rust-analyzer.hoverActions.enable (default: `true`)::
- Whether to show HoverActions in Rust files.
++
+--
+Whether to show HoverActions in Rust files.
+--
[[rust-analyzer.hoverActions.gotoTypeDef]]rust-analyzer.hoverActions.gotoTypeDef (default: `true`)::
- Whether to show `Go to Type Definition` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
++
+--
+Whether to show `Go to Type Definition` action. Only applies when
+`#rust-analyzer.hoverActions.enable#` is set.
+--
[[rust-analyzer.hoverActions.implementations]]rust-analyzer.hoverActions.implementations (default: `true`)::
- Whether to show `Implementations` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
++
+--
+Whether to show `Implementations` action. Only applies when
+`#rust-analyzer.hoverActions.enable#` is set.
+--
[[rust-analyzer.hoverActions.run]]rust-analyzer.hoverActions.run (default: `true`)::
- Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.
++
+--
+Whether to show `Run` action. Only applies when
+`#rust-analyzer.hoverActions.enable#` is set.
+--
[[rust-analyzer.hoverActions.linksInHover]]rust-analyzer.hoverActions.linksInHover (default: `true`)::
- Use markdown syntax for links in hover.
++
+--
+Use markdown syntax for links in hover.
+--
[[rust-analyzer.inlayHints.chainingHints]]rust-analyzer.inlayHints.chainingHints (default: `true`)::
- Whether to show inlay type hints for method chains.
++
+--
+Whether to show inlay type hints for method chains.
+--
[[rust-analyzer.inlayHints.maxLength]]rust-analyzer.inlayHints.maxLength (default: `null`)::
- Maximum length for inlay hints. Default is unlimited.
++
+--
+Maximum length for inlay hints. Default is unlimited.
+--
[[rust-analyzer.inlayHints.parameterHints]]rust-analyzer.inlayHints.parameterHints (default: `true`)::
- Whether to show function parameter name inlay hints at the call site.
++
+--
+Whether to show function parameter name inlay hints at the call
+site.
+--
[[rust-analyzer.inlayHints.typeHints]]rust-analyzer.inlayHints.typeHints (default: `true`)::
- Whether to show inlay type hints for variables.
++
+--
+Whether to show inlay type hints for variables.
+--
[[rust-analyzer.lens.debug]]rust-analyzer.lens.debug (default: `true`)::
- Whether to show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
++
+--
+Whether to show `Debug` lens. Only applies when
+`#rust-analyzer.lens.enable#` is set.
+--
[[rust-analyzer.lens.enable]]rust-analyzer.lens.enable (default: `true`)::
- Whether to show CodeLens in Rust files.
++
+--
+Whether to show CodeLens in Rust files.
+--
[[rust-analyzer.lens.implementations]]rust-analyzer.lens.implementations (default: `true`)::
- Whether to show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
++
+--
+Whether to show `Implementations` lens. Only applies when
+`#rust-analyzer.lens.enable#` is set.
+--
[[rust-analyzer.lens.run]]rust-analyzer.lens.run (default: `true`)::
- Whether to show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
++
+--
+Whether to show `Run` lens. Only applies when
+`#rust-analyzer.lens.enable#` is set.
+--
[[rust-analyzer.lens.methodReferences]]rust-analyzer.lens.methodReferences (default: `false`)::
- Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
++
+--
+Whether to show `Method References` lens. Only applies when
+`#rust-analyzer.lens.enable#` is set.
+--
[[rust-analyzer.lens.references]]rust-analyzer.lens.references (default: `false`)::
- Whether to show `References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.
++
+--
+Whether to show `References` lens. Only applies when
+`#rust-analyzer.lens.enable#` is set.
+--
[[rust-analyzer.linkedProjects]]rust-analyzer.linkedProjects (default: `[]`)::
- Disable project auto-discovery in favor of explicitly specified set of projects.\n\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format.
++
+--
+Disable project auto-discovery in favor of explicitly specified set
+of projects.
+
+Elements must be paths pointing to `Cargo.toml`,
+`rust-project.json`, or JSON objects in `rust-project.json` format.
+--
[[rust-analyzer.lruCapacity]]rust-analyzer.lruCapacity (default: `null`)::
- Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
++
+--
+Number of syntax trees rust-analyzer keeps in memory. Defaults to 128.
+--
[[rust-analyzer.notifications.cargoTomlNotFound]]rust-analyzer.notifications.cargoTomlNotFound (default: `true`)::
- Whether to show `can't find Cargo.toml` error message.
++
+--
+Whether to show `can't find Cargo.toml` error message.
+--
[[rust-analyzer.procMacro.enable]]rust-analyzer.procMacro.enable (default: `false`)::
- Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
++
+--
+Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.
+--
[[rust-analyzer.procMacro.server]]rust-analyzer.procMacro.server (default: `null`)::
- Internal config, path to proc-macro server executable (typically, this is rust-analyzer itself, but we override this in tests).
++
+--
+Internal config, path to proc-macro server executable (typically,
+this is rust-analyzer itself, but we override this in tests).
+--
[[rust-analyzer.runnables.overrideCargo]]rust-analyzer.runnables.overrideCargo (default: `null`)::
- Command to be executed instead of 'cargo' for runnables.
++
+--
+Command to be executed instead of 'cargo' for runnables.
+--
[[rust-analyzer.runnables.cargoExtraArgs]]rust-analyzer.runnables.cargoExtraArgs (default: `[]`)::
- Additional arguments to be passed to cargo for runnables such as tests or binaries.\nFor example, it may be `--release`.
++
+--
+Additional arguments to be passed to cargo for runnables such as
+tests or binaries. For example, it may be `--release`.
+--
[[rust-analyzer.rustcSource]]rust-analyzer.rustcSource (default: `null`)::
- Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or "discover" to try to automatically find it. Any project which uses rust-analyzer with the rustcPrivate crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
++
+--
+Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private
+projects, or "discover" to try to automatically find it.
+
+Any project which uses rust-analyzer with the rustcPrivate
+crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.
+
+This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.
+--
[[rust-analyzer.rustfmt.extraArgs]]rust-analyzer.rustfmt.extraArgs (default: `[]`)::
- Additional arguments to `rustfmt`.
++
+--
+Additional arguments to `rustfmt`.
+--
[[rust-analyzer.rustfmt.overrideCommand]]rust-analyzer.rustfmt.overrideCommand (default: `null`)::
- Advanced option, fully override the command rust-analyzer uses for formatting.
++
+--
+Advanced option, fully override the command rust-analyzer uses for
+formatting.
+--
diff --git a/editors/code/package.json b/editors/code/package.json
index e15e7875be5..b29f006f071 100644
--- a/editors/code/package.json
+++ b/editors/code/package.json
@@ -397,7 +397,7 @@
"type": "boolean"
},
"rust-analyzer.cargo.autoreload": {
- "markdownDescription": "Automatically refresh project info via `cargo metadata` on `Cargo.toml` changes.",
+ "markdownDescription": "Automatically refresh project info via `cargo metadata` on\n`Cargo.toml` changes.",
"default": true,
"type": "boolean"
},
@@ -443,7 +443,7 @@
"type": "boolean"
},
"rust-analyzer.checkOnSave.allFeatures": {
- "markdownDescription": "Check with all features (`--all-features`). Defaults to `#rust-analyzer.cargo.allFeatures#`.",
+ "markdownDescription": "Check with all features (`--all-features`).\nDefaults to `#rust-analyzer.cargo.allFeatures#`.",
"default": null,
"type": [
"null",
@@ -469,7 +469,7 @@
]
},
"rust-analyzer.checkOnSave.target": {
- "markdownDescription": "Check for a specific target. Defaults to `#rust-analyzer.cargo.target#`.",
+ "markdownDescription": "Check for a specific target. Defaults to\n`#rust-analyzer.cargo.target#`.",
"default": null,
"type": [
"null",
@@ -485,7 +485,7 @@
}
},
"rust-analyzer.checkOnSave.features": {
- "markdownDescription": "List of features to activate. Defaults to `#rust-analyzer.cargo.features#`.",
+ "markdownDescription": "List of features to activate. Defaults to\n`#rust-analyzer.cargo.features#`.",
"default": null,
"type": [
"null",
@@ -496,7 +496,7 @@
}
},
"rust-analyzer.checkOnSave.overrideCommand": {
- "markdownDescription": "Advanced option, fully override the command rust-analyzer uses for checking. The command should include `--message-format=json` or similar option.",
+ "markdownDescription": "Advanced option, fully override the command rust-analyzer uses for\nchecking. The command should include `--message-format=json` or\nsimilar option.",
"default": null,
"type": [
"null",
@@ -522,7 +522,7 @@
"type": "boolean"
},
"rust-analyzer.completion.autoimport.enable": {
- "markdownDescription": "Toggles the additional completions that automatically add imports when completed. Note that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.",
+ "markdownDescription": "Toggles the additional completions that automatically add imports when completed.\nNote that your client must specify the `additionalTextEdits` LSP client capability to truly have this feature enabled.",
"default": true,
"type": "boolean"
},
@@ -532,7 +532,7 @@
"type": "boolean"
},
"rust-analyzer.diagnostics.enableExperimental": {
- "markdownDescription": "Whether to show experimental rust-analyzer diagnostics that might have more false positives than usual.",
+ "markdownDescription": "Whether to show experimental rust-analyzer diagnostics that might\nhave more false positives than usual.",
"default": true,
"type": "boolean"
},
@@ -546,7 +546,7 @@
"uniqueItems": true
},
"rust-analyzer.diagnostics.warningsAsHint": {
- "markdownDescription": "List of warnings that should be displayed with info severity.\\n\\nThe warnings will be indicated by a blue squiggly underline in code and a blue icon in the `Problems Panel`.",
+ "markdownDescription": "List of warnings that should be displayed with info severity.\n\nThe warnings will be indicated by a blue squiggly underline in code\nand a blue icon in the `Problems Panel`.",
"default": [],
"type": "array",
"items": {
@@ -554,7 +554,7 @@
}
},
"rust-analyzer.diagnostics.warningsAsInfo": {
- "markdownDescription": "List of warnings that should be displayed with hint severity.\\n\\nThe warnings will be indicated by faded text or three dots in code and will not show up in the `Problems Panel`.",
+ "markdownDescription": "List of warnings that should be displayed with hint severity.\n\nThe warnings will be indicated by faded text or three dots in code\nand will not show up in the `Problems Panel`.",
"default": [],
"type": "array",
"items": {
@@ -575,7 +575,7 @@
}
},
"rust-analyzer.hoverActions.debug": {
- "markdownDescription": "Whether to show `Debug` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.",
+ "markdownDescription": "Whether to show `Debug` action. Only applies when\n`#rust-analyzer.hoverActions.enable#` is set.",
"default": true,
"type": "boolean"
},
@@ -585,17 +585,17 @@
"type": "boolean"
},
"rust-analyzer.hoverActions.gotoTypeDef": {
- "markdownDescription": "Whether to show `Go to Type Definition` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.",
+ "markdownDescription": "Whether to show `Go to Type Definition` action. Only applies when\n`#rust-analyzer.hoverActions.enable#` is set.",
"default": true,
"type": "boolean"
},
"rust-analyzer.hoverActions.implementations": {
- "markdownDescription": "Whether to show `Implementations` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.",
+ "markdownDescription": "Whether to show `Implementations` action. Only applies when\n`#rust-analyzer.hoverActions.enable#` is set.",
"default": true,
"type": "boolean"
},
"rust-analyzer.hoverActions.run": {
- "markdownDescription": "Whether to show `Run` action. Only applies when `#rust-analyzer.hoverActions.enable#` is set.",
+ "markdownDescription": "Whether to show `Run` action. Only applies when\n`#rust-analyzer.hoverActions.enable#` is set.",
"default": true,
"type": "boolean"
},
@@ -619,7 +619,7 @@
"minimum": 0
},
"rust-analyzer.inlayHints.parameterHints": {
- "markdownDescription": "Whether to show function parameter name inlay hints at the call site.",
+ "markdownDescription": "Whether to show function parameter name inlay hints at the call\nsite.",
"default": true,
"type": "boolean"
},
@@ -629,7 +629,7 @@
"type": "boolean"
},
"rust-analyzer.lens.debug": {
- "markdownDescription": "Whether to show `Debug` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
+ "markdownDescription": "Whether to show `Debug` lens. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": true,
"type": "boolean"
},
@@ -639,27 +639,27 @@
"type": "boolean"
},
"rust-analyzer.lens.implementations": {
- "markdownDescription": "Whether to show `Implementations` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
+ "markdownDescription": "Whether to show `Implementations` lens. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": true,
"type": "boolean"
},
"rust-analyzer.lens.run": {
- "markdownDescription": "Whether to show `Run` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
+ "markdownDescription": "Whether to show `Run` lens. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": true,
"type": "boolean"
},
"rust-analyzer.lens.methodReferences": {
- "markdownDescription": "Whether to show `Method References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
+ "markdownDescription": "Whether to show `Method References` lens. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": false,
"type": "boolean"
},
"rust-analyzer.lens.references": {
- "markdownDescription": "Whether to show `References` lens. Only applies when `#rust-analyzer.lens.enable#` is set.",
+ "markdownDescription": "Whether to show `References` lens. Only applies when\n`#rust-analyzer.lens.enable#` is set.",
"default": false,
"type": "boolean"
},
"rust-analyzer.linkedProjects": {
- "markdownDescription": "Disable project auto-discovery in favor of explicitly specified set of projects.\\n\\nElements must be paths pointing to `Cargo.toml`, `rust-project.json`, or JSON objects in `rust-project.json` format.",
+ "markdownDescription": "Disable project auto-discovery in favor of explicitly specified set\nof projects.\n\nElements must be paths pointing to `Cargo.toml`,\n`rust-project.json`, or JSON objects in `rust-project.json` format.",
"default": [],
"type": "array",
"items": {
@@ -689,7 +689,7 @@
"type": "boolean"
},
"rust-analyzer.procMacro.server": {
- "markdownDescription": "Internal config, path to proc-macro server executable (typically, this is rust-analyzer itself, but we override this in tests).",
+ "markdownDescription": "Internal config, path to proc-macro server executable (typically,\nthis is rust-analyzer itself, but we override this in tests).",
"default": null,
"type": [
"null",
@@ -705,7 +705,7 @@
]
},
"rust-analyzer.runnables.cargoExtraArgs": {
- "markdownDescription": "Additional arguments to be passed to cargo for runnables such as tests or binaries.\\nFor example, it may be `--release`.",
+ "markdownDescription": "Additional arguments to be passed to cargo for runnables such as\ntests or binaries. For example, it may be `--release`.",
"default": [],
"type": "array",
"items": {
@@ -713,7 +713,7 @@
}
},
"rust-analyzer.rustcSource": {
- "markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private projects, or \"discover\" to try to automatically find it. Any project which uses rust-analyzer with the rustcPrivate crates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it. This option is not reloaded automatically; you must restart rust-analyzer for it to take effect.",
+ "markdownDescription": "Path to the Cargo.toml of the rust compiler workspace, for usage in rustc_private\nprojects, or \"discover\" to try to automatically find it.\n\nAny project which uses rust-analyzer with the rustcPrivate\ncrates must set `[package.metadata.rust-analyzer] rustc_private=true` to use it.\n\nThis option is not reloaded automatically; you must restart rust-analyzer for it to take effect.",
"default": null,
"type": [
"null",
@@ -729,7 +729,7 @@
}
},
"rust-analyzer.rustfmt.overrideCommand": {
- "markdownDescription": "Advanced option, fully override the command rust-analyzer uses for formatting.",
+ "markdownDescription": "Advanced option, fully override the command rust-analyzer uses for\nformatting.",
"default": null,
"type": [
"null",