Get VS Code working again (rust-lang#766)

* Added extra config to cargo.toml

* Developer documentation

* Apply suggestions from code review

Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>

* Added lines to bookrunner cargo.toml

Co-authored-by: Adrian Palacios <73246657+adpaco-aws@users.noreply.github.com>

Author: 2 people

kani-docs/src/dev-documentation.md

@@ -96,6 +96,29 @@ git log --graph --oneline origin/upstream-rustc..origin/main
 git diff --stat origin/upstream-rustc..origin/main
 ```
 
+## Set up `rust-analyzer` in VSCode
+
+Add the following to the `rust-analyzer` extension settings in `settings.json`:
+```
+    "rust-analyzer.updates.channel": "nightly",
+    "rust-analyzer.rustcSource": "discover",
+    "rust-analyzer.workspace.symbol.search.scope": "workspace_and_dependencies",
+```
+
+Ensure that any packages that use `rustc` data structures have the following line set in their `Cargo.toml`
+
+```
+[package.metadata.rust-analyzer]
+# This package uses rustc crates.
+rustc_private=true
+```
+
+You may also need to install the `rustc-dev` package using rustup
+
+```
+rustup toolchain install nightly --component rustc-dev   
+```
+
 ## Kani command cheat sheet
 
 These can help understand what Kani is generating or encountering on an example or test file:

src/kani-compiler/rustc_codegen_kani/Cargo.toml

@@ -25,3 +25,6 @@ kani_queries = { path = "../kani_queries" }
 kani_restrictions = { path = "../../../library/kani_restrictions" }
 rustc-demangle = "0.1.21"
 smallvec = { version = "1.6.1", features = ["union", "may_dangle"] }
+
+[package.metadata.rust-analyzer]
+rustc_private=true

src/tools/bookrunner/Cargo.toml

@@ -14,3 +14,7 @@ walkdir = "2.3.2"
 serde = { version = "1.0", features = ["derive"] }
 serde_json = "1.0"
 toml = "0.5"
+
+[package.metadata.rust-analyzer]
+# This package uses rustc crates.
+rustc_private=true