Skip to content

Add section on configuring compilation errors when using rust-project.json #10157

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 6, 2021
Merged

Add section on configuring compilation errors when using rust-project.json #10157

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
aae1e97
Add rust-project.json + cargo check info to docs
Sep 5, 2021
a2bc57c
Update manual.adoc
Sep 5, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/user/manual.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,6 +616,15 @@ See https://github.com/rust-analyzer/rust-project.json-example for a small examp

You can set `RA_LOG` environmental variable to `rust_analyzer=info` to inspect how rust-analyzer handles config and project loading.

Note that calls to `cargo check` are disabled when using `rust-project.json` by default, so compilation errors and warnings will no longer be sent to your LSP client. To enable these compilation errors you will need to specify explicitly what command rust-analyzer should run to perform the checks using the `checkOnSave.overrideCommand` configuration. As an example, the following configuration explicitly sets `cargo check` as the `checkOnSave` command.

[source,json]
----
{ "rust-analyzer.checkOnSave.overrideCommand": ["cargo", "check", "--message-format=json"] }
----

The `checkOnSave.overrideCommand` requires the command specified to output json error messages for rust-analyzer to consume. The `--message-format=json` flag does this for `cargo check` so whichever command you use must also output errors in this format. See the <<Configuration>> section for more information.

== Security

At the moment, rust-analyzer assumes that all code is trusted.
Expand Down