chore: deprecate generate-fig-spec commands; use completions fig (#11727)

* chore: deprecate `generate-fig-spec` commands; use `completions fig` instead

* fix: use `sh_eprintln` to make clippy happy

Author: mablr

Cargo.lock

@@ -106,7 +106,6 @@ clap_complete = { workspace = true, optional = true}
 chrono.workspace = true
 ctrlc = { version = "3", optional = true }
 fdlimit = { version = "0.3", optional = true }
-clap_complete_fig = "4"
 
 [dev-dependencies]
 alloy-provider = { workspace = true, features = ["txpool-api"] }

crates/anvil/Cargo.toml

@@ -33,12 +33,17 @@ pub fn run_command(args: Anvil) -> Result<()> {
                     &mut std::io::stdout(),
                 );
             }
-            AnvilSubcommand::GenerateFigSpec => clap_complete::generate(
-                clap_complete_fig::Fig,
-                &mut Anvil::command(),
-                "anvil",
-                &mut std::io::stdout(),
-            ),
+            AnvilSubcommand::GenerateFigSpec => {
+                clap_complete::generate(
+                    foundry_common::clap::Shell::Fig,
+                    &mut Anvil::command(),
+                    "anvil",
+                    &mut std::io::stdout(),
+                );
+                sh_eprintln!(
+                    "[deprecated] `anvil generate-fig-spec` is deprecated; use `anvil completions fig`"
+                )?;
+            }
         }
         return Ok(());
     }

crates/anvil/src/args.rs

@@ -27,7 +27,7 @@ pub enum AnvilSubcommand {
         shell: foundry_common::clap::Shell,
     },
 
-    /// Generate Fig autocompletion spec.
-    #[command(visible_alias = "fig")]
+    /// Generate Fig autocompletion spec. Deprecated: use `anvil completions fig` instead.
+    #[command(visible_alias = "fig", hide = true)]
     GenerateFigSpec,
 }

crates/anvil/src/opts.rs

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

crates/cast/Cargo.toml

@@ -729,12 +729,17 @@ pub async fn run_command(args: CastArgs) -> Result<()> {
         CastSubcommand::Completions { shell } => {
             generate(shell, &mut CastArgs::command(), "cast", &mut std::io::stdout())
         }
-        CastSubcommand::GenerateFigSpec => clap_complete::generate(
-            clap_complete_fig::Fig,
-            &mut CastArgs::command(),
-            "cast",
-            &mut std::io::stdout(),
-        ),
+        CastSubcommand::GenerateFigSpec => {
+            generate(
+                foundry_common::clap::Shell::Fig,
+                &mut CastArgs::command(),
+                "cast",
+                &mut std::io::stdout(),
+            );
+            sh_eprintln!(
+                "[deprecated] `cast generate-fig-spec` is deprecated; use `cast completions fig`"
+            )?;
+        }
         CastSubcommand::Logs(cmd) => cmd.run().await?,
         CastSubcommand::DecodeTransaction { tx } => {
             let tx = stdin::unwrap_line(tx)?;

crates/cast/src/args.rs

@@ -1079,8 +1079,8 @@ pub enum CastSubcommand {
         shell: foundry_common::clap::Shell,
     },
 
-    /// Generate Fig autocompletion spec.
-    #[command(visible_alias = "fig")]
+    /// Generate Fig autocompletion spec. Deprecated: use `cast completions fig` instead.
+    #[command(visible_alias = "fig", hide = true)]
     GenerateFigSpec,
 
     /// Runs a published transaction in a local environment and prints the trace.

crates/cast/src/opts.rs

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

crates/common/Cargo.toml

@@ -1,10 +1,12 @@
 use clap_complete::{Shell as ClapCompleteShell, aot::Generator};
+use clap_complete_fig::Fig as ClapFig;
 use clap_complete_nushell::Nushell;
 
 #[derive(Clone, Copy)]
 pub enum Shell {
     ClapCompleteShell(ClapCompleteShell),
     Nushell,
+    Fig,
 }
 
 impl clap::ValueEnum for Shell {
@@ -16,13 +18,15 @@ impl clap::ValueEnum for Shell {
             Self::ClapCompleteShell(ClapCompleteShell::PowerShell),
             Self::ClapCompleteShell(ClapCompleteShell::Elvish),
             Self::Nushell,
+            Self::Fig,
         ]
     }
 
     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")),
+            Self::Fig => Some(clap::builder::PossibleValue::new("fig")),
         }
     }
 }
@@ -32,13 +36,15 @@ impl Generator for Shell {
         match self {
             Self::ClapCompleteShell(shell) => shell.file_name(name),
             Self::Nushell => Nushell.file_name(name),
+            Self::Fig => ClapFig.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),
+            Self::Fig => ClapFig.generate(cmd, buf),
         }
     }
 }

crates/common/src/clap.rs

@@ -67,7 +67,6 @@ revm.workspace = true
 
 clap = { version = "4", features = ["derive", "env", "unicode", "wrap_help"] }
 clap_complete.workspace = true
-clap_complete_fig = "4"
 dunce.workspace = true
 indicatif.workspace = true
 inferno = { version = "0.12", default-features = false }