language-servers/rust-analyzer
1
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer.git synced 2025-10-29 10:58:02 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

Update documentation for overrideCommand config options

Browse source
This commit is contained in:
Ifeanyi Orizu 2025-07-31 22:38:49 -05:00
parent 68e7ec90bf
commit 76b2333c1b
3 changed files with 21 additions and 7 deletions
Download patch file Download diff file Expand all files Collapse all files

11
crates/rust-analyzer/src/config.rs
View file

@ -726,7 +726,9 @@ config_data! {
/// ```bash /// ```bash
/// cargo check --quiet --workspace --message-format=json --all-targets --keep-going /// cargo check --quiet --workspace --message-format=json --all-targets --keep-going
/// ``` /// ```
/// . ///
/// Note: The option must be specified as an array of command line arguments, with
/// the first argument being the name of the command to run.
cargo_buildScripts_overrideCommand: Option<Vec<String>> = None, cargo_buildScripts_overrideCommand: Option<Vec<String>> = None,
/// Rerun proc-macros building/build-scripts running when proc-macro /// Rerun proc-macros building/build-scripts running when proc-macro
/// or build-script sources change and are saved. /// or build-script sources change and are saved.
@ -840,7 +842,9 @@ config_data! {
/// ```bash /// ```bash
/// cargo check --workspace --message-format=json --all-targets /// cargo check --workspace --message-format=json --all-targets
/// ``` /// ```
/// . ///
/// Note: The option must be specified as an array of command line arguments, with
/// the first argument being the name of the command to run.
check_overrideCommand | checkOnSave_overrideCommand: Option<Vec<String>> = None, check_overrideCommand | checkOnSave_overrideCommand: Option<Vec<String>> = None,
/// Check for specific targets. Defaults to `#rust-analyzer.cargo.target#` if empty. /// Check for specific targets. Defaults to `#rust-analyzer.cargo.target#` if empty.
/// ///
@ -890,6 +894,9 @@ config_data! {
/// not that of `cargo fmt`. The file contents will be passed on the /// not that of `cargo fmt`. The file contents will be passed on the
/// standard input and the formatted result will be read from the /// standard input and the formatted result will be read from the
/// standard output. /// standard output.
///
/// Note: The option must be specified as an array of command line arguments, with
/// the first argument being the name of the command to run.
rustfmt_overrideCommand: Option<Vec<String>> = None, rustfmt_overrideCommand: Option<Vec<String>> = None,
/// Enables the use of rustfmt's unstable range formatting command for the /// Enables the use of rustfmt's unstable range formatting command for the
/// `textDocument/rangeFormatting` request. The rustfmt option is unstable and only /// `textDocument/rangeFormatting` request. The rustfmt option is unstable and only

11
docs/book/src/configuration_generated.md
View file

@ -104,7 +104,9 @@ targets and features, with the following base command line:
```bash ```bash
cargo check --quiet --workspace --message-format=json --all-targets --keep-going cargo check --quiet --workspace --message-format=json --all-targets --keep-going
``` ```
.
Note: The option must be specified as an array of command line arguments, with
the first argument being the name of the command to run.
## rust-analyzer.cargo.buildScripts.rebuildOnSave {#cargo.buildScripts.rebuildOnSave} ## rust-analyzer.cargo.buildScripts.rebuildOnSave {#cargo.buildScripts.rebuildOnSave}
@ -331,7 +333,9 @@ An example command would be:
```bash ```bash
cargo check --workspace --message-format=json --all-targets cargo check --workspace --message-format=json --all-targets
``` ```
.
Note: The option must be specified as an array of command line arguments, with
the first argument being the name of the command to run.
## rust-analyzer.check.targets {#check.targets} ## rust-analyzer.check.targets {#check.targets}
@ -1343,6 +1347,9 @@ not that of `cargo fmt`. The file contents will be passed on the
standard input and the formatted result will be read from the standard input and the formatted result will be read from the
standard output. standard output.
Note: The option must be specified as an array of command line arguments, with
the first argument being the name of the command to run.
## rust-analyzer.rustfmt.rangeFormatting.enable {#rustfmt.rangeFormatting.enable} ## rust-analyzer.rustfmt.rangeFormatting.enable {#rustfmt.rangeFormatting.enable}

6
editors/code/package.json
View file

@ -887,7 +887,7 @@
"title": "Cargo", "title": "Cargo",
"properties": { "properties": {
"rust-analyzer.cargo.buildScripts.overrideCommand": { "rust-analyzer.cargo.buildScripts.overrideCommand": {
"markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefore include `--message-format=json` or a similar\noption.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.cargo.buildScripts.invocationStrategy#`.\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 --keep-going\n```\n.", "markdownDescription": "Override the command rust-analyzer uses to run build scripts and\nbuild procedural macros. The command is required to output json\nand should therefore include `--message-format=json` or a similar\noption.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.cargo.buildScripts.invocationStrategy#`.\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 --keep-going\n```\n\nNote: The option must be specified as an array of command line arguments, with\nthe first argument being the name of the command to run.",
"default": null, "default": null,
"type": [ "type": [
"null", "null",
@ -1207,7 +1207,7 @@
"title": "Check", "title": "Check",
"properties": { "properties": {
"rust-analyzer.check.overrideCommand": { "rust-analyzer.check.overrideCommand": {
"markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.check.invocationStrategy#`.\n\nIf `$saved_file` is part of the command, rust-analyzer will pass\nthe absolute path of the saved file to the provided command. This is\nintended to be used with non-Cargo build systems.\nNote that `$saved_file` is experimental and may be removed in the future.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.", "markdownDescription": "Override the command rust-analyzer uses instead of `cargo check` for\ndiagnostics on save. The command is required to output json and\nshould therefore include `--message-format=json` or a similar option\n(if your client supports the `colorDiagnosticOutput` experimental\ncapability, you can use `--message-format=json-diagnostic-rendered-ansi`).\n\nIf you're changing this because you're using some tool wrapping\nCargo, you might also want to change\n`#rust-analyzer.cargo.buildScripts.overrideCommand#`.\n\nIf there are multiple linked projects/workspaces, this command is invoked for\neach of them, with the working directory being the workspace root\n(i.e., the folder containing the `Cargo.toml`). This can be overwritten\nby changing `#rust-analyzer.check.invocationStrategy#`.\n\nIf `$saved_file` is part of the command, rust-analyzer will pass\nthe absolute path of the saved file to the provided command. This is\nintended to be used with non-Cargo build systems.\nNote that `$saved_file` is experimental and may be removed in the future.\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n\nNote: The option must be specified as an array of command line arguments, with\nthe first argument being the name of the command to run.",
"default": null, "default": null,
"type": [ "type": [
"null", "null",
@ -2808,7 +2808,7 @@
"title": "Rustfmt", "title": "Rustfmt",
"properties": { "properties": {
"rust-analyzer.rustfmt.overrideCommand": { "rust-analyzer.rustfmt.overrideCommand": {
"markdownDescription": "Advanced option, fully override the command rust-analyzer uses for\nformatting. This should be the equivalent of `rustfmt` here, and\nnot that of `cargo fmt`. The file contents will be passed on the\nstandard input and the formatted result will be read from the\nstandard output.", "markdownDescription": "Advanced option, fully override the command rust-analyzer uses for\nformatting. This should be the equivalent of `rustfmt` here, and\nnot that of `cargo fmt`. The file contents will be passed on the\nstandard input and the formatted result will be read from the\nstandard output.\n\nNote: The option must be specified as an array of command line arguments, with\nthe first argument being the name of the command to run.",
"default": null, "default": null,
"type": [ "type": [
"null", "null",