Copy `extension_api` Rust files to `OUT_DIR` when building `extension` to work around rust-analyzer limitation (#16064)

Nathan Sobo created 1 year ago

Copies rust files from extension_api/wit to the OUT_DIR to allow
including them from within the crate, which is supported by
rust-analyzer. This allows rust-analyzer to deal with the included
files. It doesn't currently support files outside the crate.

Release Notes:

- N/A

Change summary

crates/extension/build.rs                          | 43 ++++++++++++++++
crates/extension/src/wasm_host/wit/since_v0_0_6.rs |  2 
crates/extension/src/wasm_host/wit/since_v0_0_7.rs |  2 
3 files changed, 45 insertions(+), 2 deletions(-)

Detailed changes

crates/extension/build.rs

@@ -0,0 +1,43 @@
+use std::env;
+use std::fs;
+use std::path::PathBuf;
+
+fn main() -> Result<(), Box<dyn std::error::Error>> {
+    copy_extension_api_rust_files()
+}
+
+// rust-analyzer doesn't support include! for files from outside the crate.
+// Copy them to the OUT_DIR, so we can include them from there, which is supported.
+fn copy_extension_api_rust_files() -> Result<(), Box<dyn std::error::Error>> {
+    let out_dir = env::var("OUT_DIR")?;
+    let input_dir = PathBuf::from("../extension_api/wit");
+    let output_dir = PathBuf::from(out_dir);
+
+    for entry in fs::read_dir(&input_dir)? {
+        let entry = entry?;
+        let path = entry.path();
+        if path.is_dir() {
+            for subentry in fs::read_dir(&path)? {
+                let subentry = subentry?;
+                let subpath = subentry.path();
+                if subpath.extension() == Some(std::ffi::OsStr::new("rs")) {
+                    let relative_path = subpath.strip_prefix(&input_dir)?;
+                    let destination = output_dir.join(relative_path);
+
+                    fs::create_dir_all(destination.parent().unwrap())?;
+                    fs::copy(&subpath, &destination)?;
+                    println!("cargo:rerun-if-changed={}", subpath.display());
+                }
+            }
+        } else if path.extension() == Some(std::ffi::OsStr::new("rs")) {
+            let relative_path = path.strip_prefix(&input_dir)?;
+            let destination = output_dir.join(relative_path);
+
+            fs::create_dir_all(destination.parent().unwrap())?;
+            fs::copy(&path, &destination)?;
+            println!("cargo:rerun-if-changed={}", path.display());
+        }
+    }
+
+    Ok(())
+}

crates/extension/src/wasm_host/wit/since_v0_0_6.rs

@@ -23,7 +23,7 @@ wasmtime::component::bindgen!({
 });
 
 mod settings {
-    include!("../../../../extension_api/wit/since_v0.0.6/settings.rs");
+    include!(concat!(env!("OUT_DIR"), "/since_v0.0.6/settings.rs"));
 }
 
 pub type ExtensionWorktree = Arc<dyn LspAdapterDelegate>;

crates/extension/src/wasm_host/wit/since_v0_0_7.rs

@@ -37,7 +37,7 @@ wasmtime::component::bindgen!({
 pub use self::zed::extension::*;
 
 mod settings {
-    include!("../../../../extension_api/wit/since_v0.0.7/settings.rs");
+    include!(concat!(env!("OUT_DIR"), "/since_v0.0.7/settings.rs"));
 }
 
 pub type ExtensionWorktree = Arc<dyn LspAdapterDelegate>;