Mirrors/rust-analyzer
2
0
Fork 0
mirror of https://github.com/rust-lang/rust-analyzer synced 2025-01-14 06:03:58 +00:00
Code Issues Projects Releases Packages Wiki Activity

Update docs to include note about ANSI diagnostics

Browse source
This commit is contained in:
Ian Chamberlain 2022-12-25 13:52:42 -05:00 committed by Ian Chamberlain
parent 40207906f4
commit c3e4bc3136
No known key found for this signature in database
GPG key ID: BD7B25D58170E124
3 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -160,7 +160,9 @@ config_data! {
check_noDefaultFeatures | checkOnSave_noDefaultFeatures: Option<bool> = "null", check_noDefaultFeatures | checkOnSave_noDefaultFeatures: Option<bool> = "null",
/// Override the command rust-analyzer uses instead of `cargo check` for /// Override the command rust-analyzer uses instead of `cargo check` for
/// diagnostics on save. The command is required to output json and /// diagnostics on save. The command is required to output json and
/// should therefore include `--message-format=json` or a similar option. /// should therefore include `--message-format=json` or a similar option
/// (for colored diagnostics, use
/// `--message-format=json-diagnostic-rendered-ansi`).
/// ///
/// If you're changing this because you're using some tool wrapping /// If you're changing this because you're using some tool wrapping
/// Cargo, you might also want to change /// Cargo, you might also want to change

4
docs/user/generated_config.adoc
View file

@ -173,7 +173,9 @@ Whether to pass `--no-default-features` to Cargo. Defaults to
-- --
Override the command rust-analyzer uses instead of `cargo check` for Override the command rust-analyzer uses instead of `cargo check` for
diagnostics on save. The command is required to output json and diagnostics on save. The command is required to output json and
should therefore include `--message-format=json` or a similar option. should therefore include `--message-format=json` or a similar option
(for colored diagnostics, use
`--message-format=json-diagnostic-rendered-ansi`).
If you're changing this because you're using some tool wrapping If you're changing this because you're using some tool wrapping
Cargo, you might also want to change Cargo, you might also want to change

2
editors/code/package.json
View file

@ -644,7 +644,7 @@
] ]
}, },
"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\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, this command is invoked for\neach of them, with the working directory being the project root\n(i.e., the folder containing the `Cargo.toml`).\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(for colored diagnostics, use\n`--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, this command is invoked for\neach of them, with the working directory being the project root\n(i.e., the folder containing the `Cargo.toml`).\n\nAn example command would be:\n\n```bash\ncargo check --workspace --message-format=json --all-targets\n```\n.",
"default": null, "default": null,
"type": [ "type": [
"null", "null",