Add snforge new command (#2770)

<!-- Reference any GitHub issues resolved by this PR -->

Closes #2645 

## Introduced changes

<!-- A brief description of the changes -->

- `snforge new` command, which allows specifying the name of the package
and the path where it should be created
- Deprecation warning to the `snforge init` command

Docs and changelog will be updated in a separate PR.

## Checklist

<!-- Make sure all of these are complete -->

- [X] Linked relevant issue
- [X] Updated relevant documentation
- [X] Added relevant tests
- [X] Performed self-review of the code
- [X] Added changes to `CHANGELOG.md`

---------

Co-authored-by: Artur Michałek <[email protected]>

Author: ddoktorski

CHANGELOG.md

@@ -13,6 +13,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - Requirements validation during `snforge` runtime
 - `snforge check-requirements` command
+- `snforge new` command
 
 #### Changed
 
@@ -24,6 +25,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 - `--fee-token` and `--version` flags are now optional, `strk` and `v3` will be used by default
 
+#### Deprecated
+
+- `snforge init` command has been deprecated
+
 ## [0.34.0] - 2024-11-26
 
 ### Forge

crates/forge/src/init.rs

@@ -1,223 +1,25 @@
-use crate::scarb::config::SCARB_MANIFEST_TEMPLATE_CONTENT;
-use crate::CAIRO_EDITION;
-use anyhow::{anyhow, bail, Context, Ok, Result};
-use include_dir::{include_dir, Dir};
-use indoc::formatdoc;
-use scarb_api::ScarbCommand;
-use semver::Version;
-use shared::consts::FREE_RPC_PROVIDER_URL;
-use std::env;
-use std::fs::{self, OpenOptions};
-use std::io::Write;
-use std::path::{Path, PathBuf};
-use toml_edit::{value, ArrayOfTables, DocumentMut, Item, Table};
+use crate::{new, NewArgs};
+use anyhow::{anyhow, Context, Result};
+use camino::Utf8PathBuf;
+use shared::print::print_as_warning;
 
-static TEMPLATE: Dir = include_dir!("starknet_forge_template");
-
-const DEFAULT_ASSERT_MACROS: Version = Version::new(0, 1, 0);
-const MINIMAL_SCARB_FOR_CORRESPONDING_ASSERT_MACROS: Version = Version::new(2, 8, 0);
-
-fn create_snfoundry_manifest(path: &PathBuf) -> Result<()> {
-    fs::write(
-        path,
-        formatdoc! {r#"
-        # Visit https://foundry-rs.github.io/starknet-foundry/appendix/snfoundry-toml.html
-        # and https://foundry-rs.github.io/starknet-foundry/projects/configuration.html for more information
-
-        # [sncast.default]                                         # Define a profile name
-        # url = "{default_rpc_url}" # Url of the RPC provider
-        # accounts-file = "../account-file"                        # Path to the file with the account data
-        # account = "mainuser"                                     # Account from `accounts_file` or default account file that will be used for the transactions
-        # keystore = "~/keystore"                                  # Path to the keystore file
-        # wait-params = {{ timeout = 300, retry-interval = 10 }}     # Wait for submitted transaction parameters
-        # block-explorer = "StarkScan"                             # Block explorer service used to display links to transaction details
-        # show-explorer-links = true                               # Print links pointing to pages with transaction details in the chosen block explorer
-        "#,
-            default_rpc_url = FREE_RPC_PROVIDER_URL,
-        },
-    )?;
-
-    Ok(())
-}
-
-fn add_template_to_scarb_manifest(path: &PathBuf) -> Result<()> {
-    if !path.exists() {
-        bail!("Scarb.toml not found");
-    }
-
-    let mut file = OpenOptions::new()
-        .append(true)
-        .open(path)
-        .context("Failed to open Scarb.toml")?;
-
-    file.write_all(SCARB_MANIFEST_TEMPLATE_CONTENT.as_bytes())
-        .context("Failed to write to Scarb.toml")?;
-    Ok(())
-}
-
-fn overwrite_files_from_scarb_template(
-    dir_to_overwrite: &str,
-    base_path: &Path,
-    project_name: &str,
-) -> Result<()> {
-    let copy_from_dir = TEMPLATE.get_dir(dir_to_overwrite).ok_or_else(|| {
-        anyhow!(
-            "Directory {} doesn't exist in the template.",
-            dir_to_overwrite
-        )
-    })?;
-
-    for file in copy_from_dir.files() {
-        fs::create_dir_all(base_path.join(Path::new(dir_to_overwrite)))?;
-        let path = base_path.join(file.path());
-        let contents = file.contents();
-        let contents = replace_project_name(contents, project_name)?;
-
-        fs::write(path, contents)?;
-    }
-
-    Ok(())
-}
-
-fn replace_project_name(contents: &[u8], project_name: &str) -> Result<Vec<u8>> {
-    let contents = std::str::from_utf8(contents).context("UTF-8 error")?;
-    let contents = contents.replace("{{ PROJECT_NAME }}", project_name);
-    Ok(contents.into_bytes())
-}
-
-fn update_config(config_path: &Path, scarb: &Version) -> Result<()> {
-    let config_file = fs::read_to_string(config_path)?;
-    let mut document = config_file
-        .parse::<DocumentMut>()
-        .context("invalid document")?;
-
-    add_target_to_toml(&mut document);
-    set_cairo_edition(&mut document, CAIRO_EDITION);
-    add_test_script(&mut document);
-    add_assert_macros(&mut document, scarb)?;
-
-    fs::write(config_path, document.to_string())?;
-
-    Ok(())
-}
-
-fn add_test_script(document: &mut DocumentMut) {
-    let mut test = Table::new();
-
-    test.insert("test", value("snforge test"));
-    document.insert("scripts", Item::Table(test));
-}
-
-fn add_target_to_toml(document: &mut DocumentMut) {
-    let mut array_of_tables = ArrayOfTables::new();
-    let mut sierra = Table::new();
-    let mut contract = Table::new();
-    contract.set_implicit(true);
-
-    sierra.insert("sierra", Item::Value(true.into()));
-    array_of_tables.push(sierra);
-    contract.insert("starknet-contract", Item::ArrayOfTables(array_of_tables));
-
-    document.insert("target", Item::Table(contract));
-}
-
-fn set_cairo_edition(document: &mut DocumentMut, cairo_edition: &str) {
-    document["package"]["edition"] = value(cairo_edition);
-}
-
-fn add_assert_macros(document: &mut DocumentMut, scarb: &Version) -> Result<()> {
-    let version = if scarb < &MINIMAL_SCARB_FOR_CORRESPONDING_ASSERT_MACROS {
-        &DEFAULT_ASSERT_MACROS
-    } else {
-        scarb
-    };
-
-    document
-        .get_mut("dev-dependencies")
-        .and_then(|dep| dep.as_table_mut())
-        .context("Failed to get dev-dependencies from Scarb.toml")?
-        .insert("assert_macros", value(version.to_string()));
-
-    Ok(())
-}
-
-fn extend_gitignore(path: &Path) -> Result<()> {
-    let mut file = OpenOptions::new()
-        .append(true)
-        .open(path.join(".gitignore"))?;
-    writeln!(file, ".snfoundry_cache/")?;
-
-    Ok(())
-}
-
-pub fn run(project_name: &str) -> Result<()> {
+pub fn init(project_name: &str) -> Result<()> {
     let current_dir = std::env::current_dir().context("Failed to get current directory")?;
-    let project_path = current_dir.join(project_name);
-    let scarb_manifest_path = project_path.join("Scarb.toml");
-    let snfoundry_manifest_path = project_path.join("snfoundry.toml");
-
-    // if there is no Scarb.toml run `scarb new`
-    if !scarb_manifest_path.is_file() {
-        ScarbCommand::new_with_stdio()
-            .current_dir(current_dir)
-            .arg("new")
-            .arg(&project_path)
-            .env("SCARB_INIT_TEST_RUNNER", "cairo-test")
-            .run()
-            .context("Failed to initialize a new project")?;
-
-        ScarbCommand::new_with_stdio()
-            .current_dir(&project_path)
-            .manifest_path(scarb_manifest_path.clone())
-            .offline()
-            .arg("remove")
-            .arg("--dev")
-            .arg("cairo_test")
-            .run()
-            .context("Failed to remove cairo_test")?;
-    }
-
-    add_template_to_scarb_manifest(&scarb_manifest_path)?;
-
-    if !snfoundry_manifest_path.is_file() {
-        create_snfoundry_manifest(&snfoundry_manifest_path)?;
+    let project_path = Utf8PathBuf::from_path_buf(current_dir)
+        .expect("Failed to create Utf8PathBuf for the current directory")
+        .join(project_name);
+
+    // To prevent printing this warning when running scarb init/new with an older version of Scarb
+    if !project_path.join("Scarb.toml").exists() {
+        print_as_warning(&anyhow!(
+            "Command `snforge init` is deprecated and will be removed in the future. Please use `snforge new` instead."
+        ));
     }
 
-    let version = env!("CARGO_PKG_VERSION");
-    let cairo_version = ScarbCommand::version().run()?.cairo;
-
-    if env::var("DEV_DISABLE_SNFORGE_STD_DEPENDENCY").is_err() {
-        ScarbCommand::new_with_stdio()
-            .current_dir(&project_path)
-            .manifest_path(scarb_manifest_path.clone())
-            .offline()
-            .arg("add")
-            .arg("--dev")
-            .arg(format!("snforge_std@{version}"))
-            .run()
-            .context("Failed to add snforge_std")?;
-    }
-
-    ScarbCommand::new_with_stdio()
-        .current_dir(&project_path)
-        .manifest_path(scarb_manifest_path.clone())
-        .offline()
-        .arg("add")
-        .arg(format!("starknet@{cairo_version}"))
-        .run()
-        .context("Failed to add starknet")?;
-
-    update_config(&project_path.join("Scarb.toml"), &cairo_version)?;
-    extend_gitignore(&project_path)?;
-    overwrite_files_from_scarb_template("src", &project_path, project_name)?;
-    overwrite_files_from_scarb_template("tests", &project_path, project_name)?;
-
-    // Fetch to create lock file.
-    ScarbCommand::new_with_stdio()
-        .manifest_path(scarb_manifest_path)
-        .arg("fetch")
-        .run()
-        .context("Failed to fetch created project")?;
-
-    Ok(())
+    new::new(NewArgs {
+        path: project_path,
+        name: Some(project_name.to_string()),
+        no_vcs: false,
+        overwrite: true,
+    })
 }

crates/forge/src/lib.rs

@@ -1,5 +1,6 @@
 use crate::compatibility_check::{create_version_parser, Requirement, RequirementsChecker};
 use anyhow::Result;
+use camino::Utf8PathBuf;
 use clap::{Parser, Subcommand, ValueEnum};
 use forge_runner::CACHE_DIR;
 use run_tests::workspace::run_for_workspace;
@@ -14,6 +15,7 @@ pub mod block_number_map;
 mod combine_configs;
 mod compatibility_check;
 mod init;
+mod new;
 pub mod pretty_printing;
 pub mod run_tests;
 pub mod scarb;
@@ -76,6 +78,11 @@ enum ForgeSubcommand {
         /// Name of a new project
         name: String,
     },
+    /// Create a new Forge project at <PATH>
+    New {
+        #[command(flatten)]
+        args: NewArgs,
+    },
     /// Clean Forge cache directory
     CleanCache {},
     /// Check if all `snforge` requirements are installed
@@ -160,6 +167,21 @@ pub struct TestArgs {
     additional_args: Vec<OsString>,
 }
 
+#[derive(Parser, Debug)]
+pub struct NewArgs {
+    /// Path to a location where the new project will be created
+    path: Utf8PathBuf,
+    /// Name of a new project, defaults to the directory name
+    #[arg(short, long)]
+    name: Option<String>,
+    /// Do not initialize a new Git repository
+    #[arg(long)]
+    no_vcs: bool,
+    /// Try to create the project even if the specified directory at <PATH> is not empty, which can result in overwriting existing files
+    #[arg(long)]
+    overwrite: bool,
+}
+
 pub enum ExitStatus {
     Success,
     Failure,
@@ -172,7 +194,11 @@ pub fn main_execution() -> Result<ExitStatus> {
 
     match cli.subcommand {
         ForgeSubcommand::Init { name } => {
-            init::run(name.as_str())?;
+            init::init(name.as_str())?;
+            Ok(ExitStatus::Success)
+        }
+        ForgeSubcommand::New { args } => {
+            new::new(args)?;
             Ok(ExitStatus::Success)
         }
         ForgeSubcommand::CleanCache {} => {