rust-lang/rust
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

Fix up config docs

Browse Source
This commit is contained in:
Lukas Wirth
2022-04-29 15:48:48 +02:00
parent cb6032bdf4
commit 291f94e22e
5 changed files with 93 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

24
editors/code/package.json
View File

@@ -369,7 +369,7 @@
},
"$generated-start": {},
"rust-analyzer.assist.expressionFillDefault": {
"markdownDescription": "Placeholder for missing expressions in assists.",
"markdownDescription": "Placeholder expression to use for missing expressions in assists.",
"default": "todo",
"type": "string",
"enum": [
@@ -392,7 +392,7 @@
"type": "boolean"
},
"rust-analyzer.cargo.buildScripts.overrideCommand": {
"markdownDescription": "Advanced option, fully override the command rust-analyzer uses to\nrun build scripts and build procedural macros. The command should\ninclude `--message-format=json` or a similar option.",
"markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefor include `--message-format=json` or a similar\noption.\n\nBy default, a cargo invocation will be constructed for the configured\ntargets and features, with the following base command line:\n\n```bash\ncargo check --quiet --workspace --message-format=json --all-targets\n```\n.",
"default": null,
"type": [
"null",
@@ -408,7 +408,7 @@
"type": "boolean"
},
"rust-analyzer.cargo.features": {
"markdownDescription": "List of features to activate. Set to `\"all\"` to pass `--all-features` to cargo.",
"markdownDescription": "List of features to activate.\n\nSet this to `\"all\"` to pass `--all-features` to cargo.",
"default": [],
"type": [
"string",
@@ -425,7 +425,7 @@
]
},
"rust-analyzer.cargo.noDefaultFeatures": {
"markdownDescription": "Do not activate the `default` feature.",
"markdownDescription": "Whether to pass `--no-default-features` to cargo.",
"default": false,
"type": "boolean"
},
@@ -476,7 +476,7 @@
}
},
"rust-analyzer.checkOnSave.features": {
"markdownDescription": "List of features to activate. Defaults to\n`#rust-analyzer.cargo.features#`. Set to `\"all\"` to pass `--all-features` to cargo.",
"markdownDescription": "List of features to activate. Defaults to\n`#rust-analyzer.cargo.features#`.\n\nSet to `\"all\"` to pass `--all-features` to cargo.",
"default": null,
"type": [
"string",
@@ -502,7 +502,7 @@
]
},
"rust-analyzer.checkOnSave.overrideCommand": {
"markdownDescription": "Advanced option, fully override the command rust-analyzer uses for\nchecking. The command should include `--message-format=json` or\nsimilar option.",
"markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefor include `--message-format=json` or a similar\noption.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
"default": null,
"type": [
"null",
@@ -655,22 +655,22 @@
"type": "string"
},
"rust-analyzer.highlightRelated.breakPoints.enable": {
"markdownDescription": "Enables highlighting of related references while hovering your mouse `break`, `loop`, `while`, or `for` keywords.",
"markdownDescription": "Enables highlighting of related references while the cursor is on `break`, `loop`, `while`, or `for` keywords.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.exitPoints.enable": {
"markdownDescription": "Enables highlighting of all exit points while hovering your mouse above any `return`, `?`, or return type arrow (`->`).",
"markdownDescription": "Enables highlighting of all exit points while the cursor is on any `return`, `?`, `fn`, or return type arrow (`->`).",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.references.enable": {
"markdownDescription": "Enables highlighting of related references while hovering your mouse above any identifier.",
"markdownDescription": "Enables highlighting of related references while the cursor is on any identifier.",
"default": true,
"type": "boolean"
},
"rust-analyzer.highlightRelated.yieldPoints.enable": {
"markdownDescription": "Enables highlighting of all break points for a loop or block context while hovering your mouse above any `async` or `await` keywords.",
"markdownDescription": "Enables highlighting of all break points for a loop or block context while the cursor is on any `async` or `await` keywords.",
"default": true,
"type": "boolean"
},
@@ -824,7 +824,7 @@
"type": "boolean"
},
"rust-analyzer.inlayHints.typeHints.hideNamedConstructor": {
"markdownDescription": "Whether to hide inlay hints for constructors.",
"markdownDescription": "Whether to hide inlay type hints for constructors.",
"default": false,
"type": "boolean"
},
@@ -936,7 +936,7 @@
"type": "boolean"
},
"rust-analyzer.procMacro.enable": {
"markdownDescription": "Enable support for procedural macros, implies `#rust-analyzer.cargo.runBuildScripts#`.",
"markdownDescription": "Enable support for procedural macros, implies `#rust-analyzer.cargo.buildScripts.enable#`.",
"default": true,
"type": "boolean"
},