Mirrors/servo
1
0
Fork 0
mirror of https://github.com/servo/servo.git synced 2025-07-22 06:43:40 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add vscode/rust-analyzer info.

Browse source
This commit is contained in:
Teymour Aldridge 2022-01-20 18:46:37 +00:00
parent 4401622eb1
commit c25822d886
1 changed files with 43 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

43
docs/HACKING_QUICKSTART.md
View file

@ -134,6 +134,49 @@ Both will tell any cargo project to not use the online version of the dependency
For more details about overriding dependencies, see [Cargo's documentation](https://doc.crates.io/specifying-dependencies.html#overriding-dependencies).
## Editor support
### Visual Studio Code
Running plain `cargo` will cause problems! This is because the rustflags (flags passed to the rust compiler) that
standard `cargo` provides are different to what `./mach` uses, and so every time Servo is built using `cargo` it will
undo all the work done by `./mach` (and vice versa).
You can override this in a `.vscode/settings.json` file:
```
{
"rust-analyzer.checkOnSave.overrideCommand": [
"./mach",
"check",
"--message-format=json",
],
"rust-analyzer.rustfmt.overrideCommand": [
"./mach",
"fmt"
],
}
```
If that still causes problems, then supplying a different target directory should fix this (although it will increase
the amount of disc space used).
```
{
"rust-analyzer.checkOnSave.overrideCommand": [
"./mach",
"check",
"--message-format=json",
"--target-dir",
"target/lsp"
],
"rust-analyzer.rustfmt.overrideCommand": [
"./mach",
"fmt"
],
}
```
## Debugging
### Logging: