[WIP]: generating rust-project file for r-a

.gitignore

@@ -35,6 +35,7 @@ Session.vim
 config.mk
 config.stamp
 no_llvm_build
+rust-project.json
 
 ## Build
 /dl/

src/bootstrap/src/core/build_steps/setup.rs

@@ -2,6 +2,7 @@ use crate::core::builder::{Builder, RunConfig, ShouldRun, Step};
 use crate::t;
 use crate::utils::change_tracker::CONFIG_CHANGE_HISTORY;
 use crate::utils::helpers::hex_encode;
+use crate::utils::ra_project::RustAnalyzerProject;
 use crate::Config;
 use sha2::Digest;
 use std::env::consts::EXE_SUFFIX;
@@ -624,3 +625,53 @@ fn create_vscode_settings_maybe(config: &Config) -> io::Result<bool> {
     }
     Ok(should_create)
 }
+
+/// Sets up `rust-project.json`
+#[derive(Clone, Copy, Debug, Eq, PartialEq, Hash)]
+pub struct RustProjectJson;
+
+impl Step for RustProjectJson {
+    type Output = ();
+    const DEFAULT: bool = true;
+    fn should_run(run: ShouldRun<'_>) -> ShouldRun<'_> {
+        run.alias("rust-project")
+    }
+    fn make_run(run: RunConfig<'_>) {
+        if run.builder.config.dry_run() {
+            return;
+        }
+
+        if let [cmd] = &run.paths[..] {
+            if cmd.assert_single_path().path.as_path().as_os_str() == "rust-project" {
+                run.builder.ensure(RustProjectJson);
+            }
+        }
+    }
+    fn run(self, builder: &Builder<'_>) -> Self::Output {
+        if builder.config.dry_run() {
+            return;
+        }
+
+        while !t!(create_ra_project_json_maybe(builder)) {}
+    }
+}
+
+fn create_ra_project_json_maybe(builder: &Builder<'_>) -> io::Result<bool> {
+    println!("\nx.py can automatically generate `rust-project.json` file for rust-analyzer");
+
+    let should_create = match prompt_user("Would you like to create rust-project.json?: [y/N]")? {
+        Some(PromptResult::Yes) => true,
+        _ => {
+            println!("Ok, skipping rust-project.json!");
+            return Ok(true);
+        }
+    };
+
+    if should_create {
+        let ra_project = RustAnalyzerProject::collect_ra_project_data(builder);
+        ra_project.generate_json_file(&builder.config.src.join("rust-project.json"))?;
+        println!("Created `rust-project.json`");
+    }
+
+    Ok(should_create)
+}

src/bootstrap/src/core/builder.rs

@@ -880,7 +880,13 @@ impl<'a> Builder<'a> {
                 run::GenerateWindowsSys,
                 run::GenerateCompletions,
             ),
-            Kind::Setup => describe!(setup::Profile, setup::Hook, setup::Link, setup::Vscode),
+            Kind::Setup => describe!(
+                setup::Profile,
+                setup::Hook,
+                setup::Link,
+                setup::Vscode,
+                setup::RustProjectJson
+            ),
             Kind::Clean => describe!(clean::CleanAll, clean::Rustc, clean::Std),
             // special-cased in Build::build()
             Kind::Format | Kind::Suggest => vec![],
@@ -2268,7 +2274,7 @@ impl<'a> Builder<'a> {
 ///
 /// `-Z crate-attr` flags will be applied recursively on the target code using the `rustc_parse::parser::Parser`.
 /// See `rustc_builtin_macros::cmdline_attrs::inject` for more information.
-#[derive(Debug, Clone)]
+#[derive(Debug, Default, Clone)]
 struct Rustflags(String, TargetSelection);
 
 impl Rustflags {
@@ -2423,3 +2429,15 @@ impl From<Cargo> for Command {
         cargo.command
     }
 }
+
+impl From<Command> for Cargo {
+    fn from(command: Command) -> Cargo {
+        Cargo {
+            command,
+            rustflags: Default::default(),
+            rustdocflags: Default::default(),
+            hostflags: Default::default(),
+            allow_features: Default::default(),
+        }
+    }
+}

src/bootstrap/src/core/metadata.rs

@@ -5,7 +5,7 @@ use serde_derive::Deserialize;
 
 use crate::utils::cache::INTERNER;
 use crate::utils::helpers::output;
-use crate::{t, Build, Crate};
+use crate::{t, Build, Config, Crate};
 
 /// For more information, see the output of
 /// <https://doc.rust-lang.org/nightly/cargo/commands/cargo-metadata.html>
@@ -17,31 +17,35 @@ struct Output {
 /// For more information, see the output of
 /// <https://doc.rust-lang.org/nightly/cargo/commands/cargo-metadata.html>
 #[derive(Debug, Deserialize)]
-struct Package {
-    name: String,
-    source: Option<String>,
-    manifest_path: String,
-    dependencies: Vec<Dependency>,
-    targets: Vec<Target>,
+pub(crate) struct Package {
+    pub(crate) name: String,
+    pub(crate) source: Option<String>,
+    pub(crate) manifest_path: String,
+    pub(crate) dependencies: Vec<Dependency>,
+    pub(crate) targets: Vec<Target>,
 }
 
 /// For more information, see the output of
 /// <https://doc.rust-lang.org/nightly/cargo/commands/cargo-metadata.html>
-#[derive(Debug, Deserialize)]
-struct Dependency {
-    name: String,
-    source: Option<String>,
+#[derive(Debug, Deserialize, PartialEq)]
+pub(crate) struct Dependency {
+    pub(crate) name: String,
+    pub(crate) source: Option<String>,
 }
 
 #[derive(Debug, Deserialize)]
-struct Target {
-    kind: Vec<String>,
+pub(crate) struct Target {
+    pub(crate) name: String,
+    pub(crate) kind: Vec<String>,
+    pub(crate) crate_types: Vec<String>,
+    pub(crate) src_path: String,
+    pub(crate) edition: String,
 }
 
 /// Collects and stores package metadata of each workspace members into `build`,
 /// by executing `cargo metadata` commands.
 pub fn build(build: &mut Build) {
-    for package in workspace_members(build) {
+    for package in workspace_members(&build.config) {
         if package.source.is_none() {
             let name = INTERNER.intern_string(package.name);
             let mut path = PathBuf::from(package.manifest_path);
@@ -70,9 +74,9 @@ pub fn build(build: &mut Build) {
 ///
 /// Note that `src/tools/cargo` is no longer a workspace member but we still
 /// treat it as one here, by invoking an additional `cargo metadata` command.
-fn workspace_members(build: &Build) -> impl Iterator<Item = Package> {
+pub(crate) fn workspace_members(config: &Config) -> impl Iterator<Item = Package> {
     let collect_metadata = |manifest_path| {
-        let mut cargo = Command::new(&build.initial_cargo);
+        let mut cargo = Command::new(&config.initial_cargo);
         cargo
             // Will read the libstd Cargo.toml
             // which uses the unstable `public-dependency` feature.
@@ -82,7 +86,37 @@ fn workspace_members(build: &Build) -> impl Iterator<Item = Package> {
             .arg("1")
             .arg("--no-deps")
             .arg("--manifest-path")
-            .arg(build.src.join(manifest_path));
+            .arg(config.src.join(manifest_path));
+        let metadata_output = output(&mut cargo);
+        let Output { packages, .. } = t!(serde_json::from_str(&metadata_output));
+        packages
+    };
+
+    // Collects `metadata.packages` from all workspaces.
+    let packages = collect_metadata("Cargo.toml");
+    let cargo_packages = collect_metadata("src/tools/cargo/Cargo.toml");
+    let ra_packages = collect_metadata("src/tools/rust-analyzer/Cargo.toml");
+    let bootstrap_packages = collect_metadata("src/bootstrap/Cargo.toml");
+
+    // We only care about the root package from `src/tool/cargo` workspace.
+    let cargo_package = cargo_packages.into_iter().find(|pkg| pkg.name == "cargo").into_iter();
+
+    packages.into_iter().chain(cargo_package).chain(ra_packages).chain(bootstrap_packages)
+}
+
+/// Invokes `cargo metadata` to get package metadata of whole workspace including the dependencies.
+pub(crate) fn project_metadata(config: &Config) -> impl Iterator<Item = Package> {
+    let collect_metadata = |manifest_path| {
+        let mut cargo = Command::new(&config.initial_cargo);
+        cargo
+            // Will read the libstd Cargo.toml
+            // which uses the unstable `public-dependency` feature.
+            .env("RUSTC_BOOTSTRAP", "1")
+            .arg("metadata")
+            .arg("--format-version")
+            .arg("1")
+            .arg("--manifest-path")
+            .arg(config.src.join(manifest_path));
         let metadata_output = output(&mut cargo);
         let Output { packages, .. } = t!(serde_json::from_str(&metadata_output));
         packages

src/bootstrap/src/utils/mod.rs

@@ -12,5 +12,6 @@ pub(crate) mod helpers;
 pub(crate) mod job;
 #[cfg(feature = "build-metrics")]
 pub(crate) mod metrics;
+pub(crate) mod ra_project;
 pub(crate) mod render_tests;
 pub(crate) mod tarball;