feat: add nushell completions (#11311)

* feat: add nushell completions

- `clap_complete` doesn't come with nushell completions built-in but they
  have another crate `clap_complete_nushell` that does. Sucks it isn't
  supported by default, see clap-rs/clap#5880.
  This PR implements a wrapper around the enum with nushell included to
  support nushell completions too.
- moved `clap_complete` to workspace dependency to prevent conflicting
  versions between foundry-common and cast/anvil/forge.

* chore: fix typo and clippy error

* chore: move clap_complete_nushell to workspace dependencies

Author: 0xferrous

Cargo.lock

@@ -274,6 +274,8 @@ alloy-op-evm = "0.18.3"
 anstream = "0.6"
 anstyle = "1.0"
 terminal_size = "0.4"
+clap_complete = "4"
+clap_complete_nushell = "4"
 
 # macros
 proc-macro2 = "1.0"

Cargo.toml

@@ -100,7 +100,7 @@ clap = { version = "4", features = [
     "env",
     "wrap_help",
 ], optional = true }
-clap_complete = { version = "4", optional = true }
+clap_complete = { workspace = true, optional = true}
 chrono.workspace = true
 ctrlc = { version = "3", optional = true }
 fdlimit = { version = "0.3", optional = true }

crates/anvil/Cargo.toml

@@ -79,7 +79,9 @@ mod tests {
         let args: Anvil = Anvil::parse_from(["anvil", "completions", "bash"]);
         assert!(matches!(
             args.cmd,
-            Some(AnvilSubcommand::Completions { shell: clap_complete::Shell::Bash })
+            Some(AnvilSubcommand::Completions {
+                shell: foundry_common::clap::Shell::ClapCompleteShell(clap_complete::Shell::Bash)
+            })
         ));
     }
 }

crates/anvil/src/args.rs

@@ -24,7 +24,7 @@ pub enum AnvilSubcommand {
     #[command(visible_alias = "com")]
     Completions {
         #[arg(value_enum)]
-        shell: clap_complete::Shell,
+        shell: foundry_common::clap::Shell,
     },
 
     /// Generate Fig autocompletion spec.

crates/anvil/src/opts.rs

@@ -72,7 +72,7 @@ serde.workspace = true
 foundry-cli.workspace = true
 
 clap = { version = "4", features = ["derive", "env", "unicode", "wrap_help"] }
-clap_complete = "4"
+clap_complete.workspace = true
 clap_complete_fig = "4"
 comfy-table.workspace = true
 dunce.workspace = true

crates/cast/Cargo.toml

@@ -1065,7 +1065,7 @@ pub enum CastSubcommand {
     #[command(visible_alias = "com")]
     Completions {
         #[arg(value_enum)]
-        shell: clap_complete::Shell,
+        shell: foundry_common::clap::Shell,
     },
 
     /// Generate Fig autocompletion spec.

crates/cast/src/opts.rs

@@ -50,6 +50,8 @@ solar-sema.workspace = true
 tower.workspace = true
 
 clap = { version = "4", features = ["derive", "env", "unicode", "wrap_help"] }
+clap_complete.workspace = true
+clap_complete_nushell.workspace = true
 comfy-table.workspace = true
 dunce.workspace = true
 eyre.workspace = true

crates/common/Cargo.toml

@@ -0,0 +1,44 @@
+use clap_complete::{Shell as ClapCompleteShell, aot::Generator};
+use clap_complete_nushell::Nushell;
+
+#[derive(Clone, Copy)]
+pub enum Shell {
+    ClapCompleteShell(ClapCompleteShell),
+    Nushell,
+}
+
+impl clap::ValueEnum for Shell {
+    fn value_variants<'a>() -> &'a [Self] {
+        &[
+            Self::ClapCompleteShell(ClapCompleteShell::Bash),
+            Self::ClapCompleteShell(ClapCompleteShell::Zsh),
+            Self::ClapCompleteShell(ClapCompleteShell::Fish),
+            Self::ClapCompleteShell(ClapCompleteShell::PowerShell),
+            Self::ClapCompleteShell(ClapCompleteShell::Elvish),
+            Self::Nushell,
+        ]
+    }
+
+    fn to_possible_value(&self) -> Option<clap::builder::PossibleValue> {
+        match self {
+            Self::ClapCompleteShell(shell) => shell.to_possible_value(),
+            Self::Nushell => Some(clap::builder::PossibleValue::new("nushell")),
+        }
+    }
+}
+
+impl Generator for Shell {
+    fn file_name(&self, name: &str) -> String {
+        match self {
+            Self::ClapCompleteShell(shell) => shell.file_name(name),
+            Self::Nushell => Nushell.file_name(name),
+        }
+    }
+
+    fn generate(&self, cmd: &clap::Command, buf: &mut dyn std::io::Write) {
+        match self {
+            Self::ClapCompleteShell(shell) => shell.generate(cmd, buf),
+            Self::Nushell => Nushell.generate(cmd, buf),
+        }
+    }
+}

crates/common/src/clap.rs

@@ -18,6 +18,7 @@ pub use foundry_common_fmt as fmt;
 
 pub mod abi;
 pub mod calc;
+pub mod clap;
 pub mod comments;
 pub mod compile;
 pub mod constants;