feat(forge): add --empty to forge init (#11554)

* add example control

* fix CI

* 'no_example' -> 'empty'

---------

Co-authored-by: 0xrusowsky <[email protected]>

Author: aganisgash

crates/forge/src/cmd/clone.rs

@@ -161,17 +161,11 @@ impl CloneArgs {
     /// * `enable_git` - whether to enable git for the project.
     /// * `quiet` - whether to print messages.
     pub(crate) fn init_an_empty_project(root: &Path, install: DependencyInstallOpts) -> Result<()> {
-        // let's try to init the project with default init args
-        let init_args = InitArgs { root: root.to_path_buf(), install, ..Default::default() };
+        // Initialize the project with empty set to true to avoid creating example contracts
+        let init_args =
+            InitArgs { root: root.to_path_buf(), install, empty: true, ..Default::default() };
         init_args.run().map_err(|e| eyre::eyre!("Project init error: {:?}", e))?;
 
-        // remove the unnecessary example contracts
-        // XXX (ZZ): this is a temporary solution until we have a proper way to remove contracts,
-        // e.g., add a field in the InitArgs to control the example contract generation
-        fs::remove_file(root.join("src/Counter.sol"))?;
-        fs::remove_file(root.join("test/Counter.t.sol"))?;
-        fs::remove_file(root.join("script/Counter.s.sol"))?;
-
         Ok(())
     }
 

crates/forge/src/cmd/init.rs

@@ -46,14 +46,28 @@ pub struct InitArgs {
     #[arg(long, conflicts_with = "template")]
     pub use_parent_git: bool,
 
+    /// Do not create example contracts (Counter.sol, Counter.t.sol, Counter.s.sol).
+    #[arg(long, conflicts_with = "template")]
+    pub empty: bool,
+
     #[command(flatten)]
     pub install: DependencyInstallOpts,
 }
 
 impl InitArgs {
     pub fn run(self) -> Result<()> {
-        let Self { root, template, branch, install, offline, force, vscode, use_parent_git, vyper } =
-            self;
+        let Self {
+            root,
+            template,
+            branch,
+            install,
+            offline,
+            force,
+            vscode,
+            use_parent_git,
+            vyper,
+            empty,
+        } = self;
         let DependencyInstallOpts { shallow, no_git, commit } = install;
 
         // create the root dir if it does not exist
@@ -128,41 +142,56 @@ impl InitArgs {
             let script = root.join("script");
             fs::create_dir_all(&script)?;
 
-            if vyper {
-                // write the contract file
-                let contract_path = src.join("Counter.vy");
-                fs::write(contract_path, include_str!("../../assets/vyper/CounterTemplate.vy"))?;
-                let interface_path = src.join("ICounter.sol");
-                fs::write(interface_path, include_str!("../../assets/vyper/ICounterTemplate.sol"))?;
-
-                // write the tests
-                let contract_path = test.join("Counter.t.sol");
-                fs::write(contract_path, include_str!("../../assets/vyper/CounterTemplate.t.sol"))?;
-
-                // write the script
-                let contract_path = script.join("Counter.s.sol");
-                fs::write(contract_path, include_str!("../../assets/vyper/CounterTemplate.s.sol"))?;
-            } else {
-                // write the contract file
-                let contract_path = src.join("Counter.sol");
-                fs::write(
-                    contract_path,
-                    include_str!("../../assets/solidity/CounterTemplate.sol"),
-                )?;
-
-                // write the tests
-                let contract_path = test.join("Counter.t.sol");
-                fs::write(
-                    contract_path,
-                    include_str!("../../assets/solidity/CounterTemplate.t.sol"),
-                )?;
-
-                // write the script
-                let contract_path = script.join("Counter.s.sol");
-                fs::write(
-                    contract_path,
-                    include_str!("../../assets/solidity/CounterTemplate.s.sol"),
-                )?;
+            // Only create example contracts if not disabled
+            if !empty {
+                if vyper {
+                    // write the contract file
+                    let contract_path = src.join("Counter.vy");
+                    fs::write(
+                        contract_path,
+                        include_str!("../../assets/vyper/CounterTemplate.vy"),
+                    )?;
+                    let interface_path = src.join("ICounter.sol");
+                    fs::write(
+                        interface_path,
+                        include_str!("../../assets/vyper/ICounterTemplate.sol"),
+                    )?;
+
+                    // write the tests
+                    let contract_path = test.join("Counter.t.sol");
+                    fs::write(
+                        contract_path,
+                        include_str!("../../assets/vyper/CounterTemplate.t.sol"),
+                    )?;
+
+                    // write the script
+                    let contract_path = script.join("Counter.s.sol");
+                    fs::write(
+                        contract_path,
+                        include_str!("../../assets/vyper/CounterTemplate.s.sol"),
+                    )?;
+                } else {
+                    // write the contract file
+                    let contract_path = src.join("Counter.sol");
+                    fs::write(
+                        contract_path,
+                        include_str!("../../assets/solidity/CounterTemplate.sol"),
+                    )?;
+
+                    // write the tests
+                    let contract_path = test.join("Counter.t.sol");
+                    fs::write(
+                        contract_path,
+                        include_str!("../../assets/solidity/CounterTemplate.t.sol"),
+                    )?;
+
+                    // write the script
+                    let contract_path = script.join("Counter.s.sol");
+                    fs::write(
+                        contract_path,
+                        include_str!("../../assets/solidity/CounterTemplate.s.sol"),
+                    )?;
+                }
             }
 
             // Write the default README file