diff options
author | bors[bot] <26634292+bors[bot]@users.noreply.github.com> | 2020-05-08 11:11:19 +0100 |
---|---|---|
committer | GitHub <[email protected]> | 2020-05-08 11:11:19 +0100 |
commit | 8295a9340c1fbda805497035054ead0b10c0d88e (patch) | |
tree | ccab3f149b9633ae95570d78fa5d6b8d3b3392e6 /crates/ra_project_model/src/sysroot.rs | |
parent | 363c1f2f493d206f2cc10c348a02f3efadd8c77a (diff) | |
parent | 3077eae2a61f97c28c0d4e3456f6ab873126e5b8 (diff) |
Merge #4329
4329: Look for `cargo`, `rustc`, and `rustup` in standard installation path r=matklad a=cdisselkoen
Discussed in #3118. This is approximately a 90% fix for the issue described there.
This PR creates a new crate `ra_env` with a function `get_path_for_executable()`; see docs there. `get_path_for_executable()` improves and generalizes the function `cargo_binary()` which was previously duplicated in the `ra_project_model` and `ra_flycheck` crates. (Both of those crates now depend on the new `ra_env` crate.) The new function checks (e.g.) `$CARGO` and `$PATH`, but also falls back on `~/.cargo/bin` manually before erroring out. This should allow most users to not have to worry about setting the `$CARGO` or `$PATH` variables for VSCode, which can be difficult e.g. on macOS as discussed in #3118.
I've attempted to replace all calls to `cargo`, `rustc`, and `rustup` in rust-analyzer with appropriate invocations of `get_path_for_executable()`; I don't think I've missed any in Rust code, but there is at least one invocation in TypeScript code which I haven't fixed. (I'm not sure whether it's affected by the same problem or not.) https://github.com/rust-analyzer/rust-analyzer/blob/a4778ddb7a00f552a8e653bbf56ae9fd69cfe1d3/editors/code/src/cargo.ts#L79
I'm sure this PR could be improved a bunch, so I'm happy to take feedback/suggestions on how to solve this problem better, or just bikeshedding variable/function/crate names etc.
cc @Veetaha
Fixes #3118.
Co-authored-by: Craig Disselkoen <[email protected]>
Co-authored-by: veetaha <[email protected]>
Diffstat (limited to 'crates/ra_project_model/src/sysroot.rs')
-rw-r--r-- | crates/ra_project_model/src/sysroot.rs | 16 |
1 files changed, 12 insertions, 4 deletions
diff --git a/crates/ra_project_model/src/sysroot.rs b/crates/ra_project_model/src/sysroot.rs index 55ff5ad80..11c26ad89 100644 --- a/crates/ra_project_model/src/sysroot.rs +++ b/crates/ra_project_model/src/sysroot.rs | |||
@@ -8,6 +8,7 @@ use std::{ | |||
8 | }; | 8 | }; |
9 | 9 | ||
10 | use ra_arena::{Arena, Idx}; | 10 | use ra_arena::{Arena, Idx}; |
11 | use ra_env::get_path_for_executable; | ||
11 | 12 | ||
12 | #[derive(Default, Debug, Clone)] | 13 | #[derive(Default, Debug, Clone)] |
13 | pub struct Sysroot { | 14 | pub struct Sysroot { |
@@ -88,9 +89,14 @@ fn create_command_text(program: &str, args: &[&str]) -> String { | |||
88 | format!("{} {}", program, args.join(" ")) | 89 | format!("{} {}", program, args.join(" ")) |
89 | } | 90 | } |
90 | 91 | ||
91 | fn run_command_in_cargo_dir(cargo_toml: &Path, program: &str, args: &[&str]) -> Result<Output> { | 92 | fn run_command_in_cargo_dir( |
93 | cargo_toml: impl AsRef<Path>, | ||
94 | program: impl AsRef<Path>, | ||
95 | args: &[&str], | ||
96 | ) -> Result<Output> { | ||
97 | let program = program.as_ref().as_os_str().to_str().expect("Invalid Unicode in path"); | ||
92 | let output = Command::new(program) | 98 | let output = Command::new(program) |
93 | .current_dir(cargo_toml.parent().unwrap()) | 99 | .current_dir(cargo_toml.as_ref().parent().unwrap()) |
94 | .args(args) | 100 | .args(args) |
95 | .output() | 101 | .output() |
96 | .context(format!("{} failed", create_command_text(program, args)))?; | 102 | .context(format!("{} failed", create_command_text(program, args)))?; |
@@ -114,13 +120,15 @@ fn get_or_install_rust_src(cargo_toml: &Path) -> Result<PathBuf> { | |||
114 | if let Ok(path) = env::var("RUST_SRC_PATH") { | 120 | if let Ok(path) = env::var("RUST_SRC_PATH") { |
115 | return Ok(path.into()); | 121 | return Ok(path.into()); |
116 | } | 122 | } |
117 | let rustc_output = run_command_in_cargo_dir(cargo_toml, "rustc", &["--print", "sysroot"])?; | 123 | let rustc = get_path_for_executable("rustc")?; |
124 | let rustc_output = run_command_in_cargo_dir(cargo_toml, &rustc, &["--print", "sysroot"])?; | ||
118 | let stdout = String::from_utf8(rustc_output.stdout)?; | 125 | let stdout = String::from_utf8(rustc_output.stdout)?; |
119 | let sysroot_path = Path::new(stdout.trim()); | 126 | let sysroot_path = Path::new(stdout.trim()); |
120 | let src_path = sysroot_path.join("lib/rustlib/src/rust/src"); | 127 | let src_path = sysroot_path.join("lib/rustlib/src/rust/src"); |
121 | 128 | ||
122 | if !src_path.exists() { | 129 | if !src_path.exists() { |
123 | run_command_in_cargo_dir(cargo_toml, "rustup", &["component", "add", "rust-src"])?; | 130 | let rustup = get_path_for_executable("rustup")?; |
131 | run_command_in_cargo_dir(cargo_toml, &rustup, &["component", "add", "rust-src"])?; | ||
124 | } | 132 | } |
125 | if !src_path.exists() { | 133 | if !src_path.exists() { |
126 | bail!( | 134 | bail!( |