feat(forge): deprecate generate

This command is very simplistic and does not achieve much other than
a simple template replacement. This can easily be implemented in your
editor or extension of choice as a macro, fitting your stylistic needs.

Author: DaniPopes

crates/forge/src/args.rs

@@ -1,5 +1,5 @@
 use crate::{
-    cmd::{cache::CacheSubcommands, generate::GenerateSubcommands, watch},
+    cmd::{cache::CacheSubcommands, watch},
     opts::{Forge, ForgeSubcommand},
 };
 use clap::{CommandFactory, Parser};
@@ -137,9 +137,7 @@ pub fn run_command(args: Forge) -> Result<()> {
             }
         }
         ForgeSubcommand::Selectors { command } => global.block_on(command.run()),
-        ForgeSubcommand::Generate(cmd) => match cmd.sub {
-            GenerateSubcommands::Test(cmd) => cmd.run(),
-        },
+        ForgeSubcommand::Generate(cmd) => cmd.run(),
         ForgeSubcommand::Compiler(cmd) => cmd.run(),
         ForgeSubcommand::Soldeer(cmd) => global.block_on(cmd.run()),
         ForgeSubcommand::Eip712(cmd) => cmd.run(),

crates/forge/src/cmd/generate/mod.rs

@@ -1,70 +1,15 @@
-use clap::{Parser, Subcommand};
+use clap::Parser;
 use eyre::Result;
-use foundry_common::fs;
-use std::path::Path;
-use yansi::Paint;
 
 /// CLI arguments for `forge generate`.
 #[derive(Debug, Parser)]
 pub struct GenerateArgs {
-    #[command(subcommand)]
-    pub sub: GenerateSubcommands,
+    args: Vec<String>,
 }
 
-#[derive(Debug, Subcommand)]
-pub enum GenerateSubcommands {
-    /// Scaffolds test file for given contract.
-    Test(GenerateTestArgs),
-}
-
-#[derive(Debug, Parser)]
-pub struct GenerateTestArgs {
-    /// Contract name for test generation.
-    #[arg(long, short, value_name = "CONTRACT_NAME")]
-    pub contract_name: String,
-}
-
-impl GenerateTestArgs {
+impl GenerateArgs {
     pub fn run(self) -> Result<()> {
-        let contract_name = format_identifier(&self.contract_name, true);
-        let instance_name = format_identifier(&self.contract_name, false);
-
-        // Create the test file content.
-        let test_content = include_str!("../../../assets/generated/TestTemplate.t.sol");
-        let test_content = test_content
-            .replace("{contract_name}", &contract_name)
-            .replace("{instance_name}", &instance_name);
-
-        // Create the test directory if it doesn't exist.
-        fs::create_dir_all("test")?;
-
-        // Define the test file path
-        let test_file_path = Path::new("test").join(format!("{contract_name}.t.sol"));
-
-        // Write the test content to the test file.
-        fs::write(&test_file_path, test_content)?;
-
-        sh_println!("{} test file: {}", "Generated".green(), test_file_path.to_str().unwrap())?;
+        sh_warn!("`forge generate` is deprecated and will be removed in a future version")?;
         Ok(())
     }
 }
-
-/// Utility function to convert an identifier to pascal or camel case.
-fn format_identifier(input: &str, is_pascal_case: bool) -> String {
-    let mut result = String::new();
-    let mut capitalize_next = is_pascal_case;
-
-    for word in input.split_whitespace() {
-        if !word.is_empty() {
-            let (first, rest) = word.split_at(1);
-            let formatted_word = if capitalize_next {
-                format!("{}{}", first.to_uppercase(), rest)
-            } else {
-                format!("{}{}", first.to_lowercase(), rest)
-            };
-            capitalize_next = true;
-            result.push_str(&formatted_word);
-        }
-    }
-    result
-}

crates/forge/src/opts.rs

@@ -160,6 +160,7 @@ pub enum ForgeSubcommand {
     },
 
     /// Generate scaffold files.
+    #[command(hide = true)]
     Generate(generate::GenerateArgs),
 
     /// Compiler utilities.