rust-project: add support for alternative Buck2 commands

This is useful for users of wrappers such as Buckle, as well as developers hacking on Buck2 that
need to use a custom build.

Author: cbarrete

integrations/rust-project/src/buck.rs

@@ -51,9 +51,10 @@ pub(crate) fn to_json_project(
     aliases: FxHashMap<Target, AliasedTargetInfo>,
     relative_paths: bool,
     check_cycles: bool,
+    buck2_command: Option<String>,
 ) -> Result<JsonProject, anyhow::Error> {
     let mode = select_mode(None);
-    let buck = Buck::new(mode);
+    let buck = Buck::new(buck2_command, mode);
     let project_root = buck.resolve_project_root()?;
 
     let ExpandedAndResolved {
@@ -437,12 +438,16 @@ fn merge_unit_test_targets(
 
 #[derive(Debug, Default)]
 pub(crate) struct Buck {
+    command: String,
     mode: Option<String>,
 }
 
 impl Buck {
-    pub(crate) fn new(mode: Option<String>) -> Self {
-        Buck { mode }
+    pub(crate) fn new(command: Option<String>, mode: Option<String>) -> Self {
+        Buck {
+            command: command.unwrap_or_else(|| "buck2".into()),
+            mode,
+        }
     }
 
     /// Invoke `buck2` with the given subcommands.
@@ -472,7 +477,7 @@ impl Buck {
         I: IntoIterator<Item = S>,
         S: AsRef<OsStr>,
     {
-        let mut cmd = Command::new("buck2");
+        let mut cmd = Command::new(&self.command);
 
         // rust-analyzer invokes the check-on-save command with `RUST_BACKTRACE=short`
         // set. Unfortunately, buck2 doesn't handle that well and becomes extremely

integrations/rust-project/src/cli/check.rs

@@ -23,11 +23,16 @@ pub(crate) struct Check {
 }
 
 impl Check {
-    pub(crate) fn new(mode: Option<String>, use_clippy: bool, saved_file: PathBuf) -> Self {
+    pub(crate) fn new(
+        buck2_command: Option<String>,
+        mode: Option<String>,
+        use_clippy: bool,
+        saved_file: PathBuf,
+    ) -> Self {
         let saved_file = safe_canonicalize(&saved_file);
 
         let mode = select_mode(mode.as_deref());
-        let buck = buck::Buck::new(mode);
+        let buck = buck::Buck::new(buck2_command, mode);
         Self {
             buck,
             use_clippy,

integrations/rust-project/src/cli/develop.rs

@@ -38,6 +38,7 @@ pub(crate) struct Develop {
     pub(crate) buck: buck::Buck,
     pub(crate) check_cycles: bool,
     pub(crate) invoked_by_ra: bool,
+    pub(crate) buck2_command: Option<String>,
 }
 
 pub(crate) struct OutputCfg {
@@ -64,6 +65,7 @@ impl Develop {
             relative_paths,
             mode,
             check_cycles,
+            buck2_command,
             ..
         } = command
         {
@@ -82,14 +84,15 @@ impl Develop {
             };
 
             let mode = select_mode(mode.as_deref());
-            let buck = buck::Buck::new(mode);
+            let buck = buck::Buck::new(buck2_command.clone(), mode);
 
             let develop = Develop {
                 sysroot,
                 relative_paths,
                 buck,
                 check_cycles,
                 invoked_by_ra: false,
+                buck2_command,
             };
             let out = OutputCfg { out, pretty };
 
@@ -104,7 +107,10 @@ impl Develop {
         }
 
         if let crate::Command::DevelopJson {
-            sysroot_mode, args, ..
+            sysroot_mode,
+            args,
+            buck2_command,
+            ..
         } = command
         {
             let out = Output::Stdout;
@@ -123,14 +129,15 @@ impl Develop {
                 }
             };
 
-            let buck = buck::Buck::new(mode);
+            let buck = buck::Buck::new(buck2_command.clone(), mode);
 
             let develop = Develop {
                 sysroot,
                 relative_paths: false,
                 buck,
                 check_cycles: false,
                 invoked_by_ra: true,
+                buck2_command,
             };
             let out = OutputCfg { out, pretty: false };
 
@@ -230,6 +237,7 @@ impl Develop {
             relative_paths,
             buck,
             check_cycles,
+            buck2_command,
             ..
         } = self;
 
@@ -269,6 +277,7 @@ impl Develop {
             aliased_libraries,
             *relative_paths,
             *check_cycles,
+            buck2_command.clone(),
         )?;
 
         Ok(rust_project)

integrations/rust-project/src/main.rs

@@ -111,6 +111,10 @@ enum Command {
         /// Optional argument specifying build mode.
         #[clap(short = 'm', long)]
         mode: Option<String>,
+
+        /// Command used to run Buck2. Defaults to `buck2`.
+        #[clap(long)]
+        buck2_command: Option<String>,
     },
     /// `DevelopJson` is a more limited, stripped down [`Command::Develop`].
     ///
@@ -131,6 +135,10 @@ enum Command {
         client: Option<String>,
 
         args: JsonArguments,
+
+        /// Command used to run Buck2. Defaults to `buck2`.
+        #[clap(long)]
+        buck2_command: Option<String>,
     },
     /// Build the saved file's owning target. This is meant to be used by IDEs to provide diagnostics on save.
     Check {
@@ -147,6 +155,9 @@ enum Command {
 
         /// The file saved by the user. `rust-project` will infer the owning target(s) of the saved file and build them.
         saved_file: PathBuf,
+        /// Command used to run Buck2. Defaults to `buck2`.
+        #[clap(long)]
+        buck2_command: Option<String>,
     },
 }
 
@@ -287,12 +298,13 @@ fn main() -> Result<(), anyhow::Error> {
             mode,
             use_clippy,
             saved_file,
+            buck2_command,
             ..
         } => {
             let subscriber = tracing_subscriber::registry().with(fmt.with_filter(filter));
             tracing::subscriber::set_global_default(subscriber)?;
 
-            cli::Check::new(mode, use_clippy, saved_file.clone())
+            cli::Check::new(buck2_command, mode, use_clippy, saved_file.clone())
                 .run()
                 .inspect_err(|e| crate::scuba::log_check_error(&e, &saved_file, use_clippy))
         }
@@ -376,6 +388,7 @@ fn json_args_pass() {
             args,
             sysroot_mode: SysrootMode::Rustc,
             client: None,
+            buck2_command: None,
         }),
         version: false,
     };
@@ -393,6 +406,7 @@ fn json_args_pass() {
             args,
             sysroot_mode: SysrootMode::Rustc,
             client: None,
+            buck2_command: None,
         }),
         version: false,
     };
@@ -410,6 +424,7 @@ fn json_args_pass() {
             args,
             sysroot_mode: SysrootMode::Rustc,
             client: None,
+            buck2_command: None,
         }),
         version: false,
     };