chore!: Require package names in Nargo.toml files (#2056)

* chore!: Require package names in `Nargo.toml` files

* feat: add a helpful error message for missing names in Nargo.toml

---------

Co-authored-by: TomAFrench <tom@tomfren.ch>

crates/nargo/src/manifest/mod.rs

@@ -64,8 +64,9 @@ pub struct WorkspaceConfig {
 #[allow(dead_code)]
 #[derive(Default, Debug, Deserialize, Clone)]
 pub struct PackageMetadata {
-    pub name: Option<String>,
-    // Note: a package name is not needed unless there is a registry
+    #[serde(default = "panic_missing_name")]
+    pub name: String,
+    description: Option<String>,
     authors: Vec<String>,
     // If not compiler version is supplied, the latest is used
     // For now, we state that all packages must be compiled under the same
@@ -77,6 +78,26 @@ pub struct PackageMetadata {
     license: Option<String>,
 }
 
+// TODO: Remove this after a couple of breaking releases (added in 0.10.0)
+fn panic_missing_name() -> String {
+    panic!(
+        r#"
+
+Failed to parse `Nargo.toml`.
+    
+`Nargo.toml` now requires a "name" field for Noir packages.
+
+```toml
+[package]
+name = "package_name"
+```
+
+Modify your `Nargo.toml` similarly to above and rerun the command.
+
+"#
+    )
+}
+
 #[derive(Debug, Deserialize, Clone)]
 #[serde(untagged)]
 /// Enum representing the different types of ways to
@@ -91,6 +112,7 @@ fn parse_standard_toml() {
     let src = r#"
 
         [package]
+        name = "test"
         authors = ["kev", "foo"]
         compiler_version = "0.1"
 

crates/nargo_cli/src/cli/init_cmd.rs

@@ -7,21 +7,12 @@ use super::fs::{create_named_dir, write_to_file};
 use super::{NargoConfig, CARGO_PKG_VERSION};
 use acvm::Backend;
 use clap::Args;
-use const_format::formatcp;
 use std::path::PathBuf;
 
 /// Create a Noir project in the current directory.
 #[derive(Debug, Clone, Args)]
 pub(crate) struct InitCommand;
 
-const SETTINGS: &str = formatcp!(
-    r#"[package]
-authors = [""]
-compiler_version = "{CARGO_PKG_VERSION}"
-
-[dependencies]"#,
-);
-
 const EXAMPLE: &str = r#"fn main(x : Field, y : pub Field) {
     assert(x != y);
 }
@@ -47,10 +38,21 @@ pub(crate) fn run<B: Backend>(
 
 /// Initializes a new Noir project in `package_dir`.
 pub(crate) fn initialize_project(package_dir: PathBuf) {
+    // TODO: Should this reject if we have non-Unicode filepaths?
+    let package_name = package_dir.file_name().expect("Expected a filename").to_string_lossy();
     let src_dir = package_dir.join(SRC_DIR);
     create_named_dir(&src_dir, "src");
 
-    write_to_file(SETTINGS.as_bytes(), &package_dir.join(PKG_FILE));
+    let toml_contents = format!(
+        r#"[package]
+name = "{package_name}"
+authors = [""]
+compiler_version = "{CARGO_PKG_VERSION}"
+
+[dependencies]"#
+    );
+
+    write_to_file(toml_contents.as_bytes(), &package_dir.join(PKG_FILE));
     write_to_file(EXAMPLE.as_bytes(), &src_dir.join("main.nr"));
     println!("Project successfully created! Binary located at {}", package_dir.display());
 }

crates/nargo_cli/src/resolver.rs

@@ -162,10 +162,6 @@ fn resolve_package_manifest(
     Ok(())
 }
 
-fn crate_name(name: Option<CrateName>) -> String {
-    name.map(|name| name.into()).unwrap_or_else(|| "[unnamed]".to_string())
-}
-
 fn resolve_workspace_manifest(
     context: &mut Context,
     mut local_package: Option<String>,
@@ -187,20 +183,18 @@ fn resolve_workspace_manifest(
 
         match member_manifest {
             Manifest::Package(inner) => {
-                let name = inner
+                let name: CrateName = inner
                     .package
                     .name
-                    .map(|name| {
-                        name.parse().map_err(|_name| DependencyResolutionError::InvalidPackageName)
-                    })
-                    .transpose()?;
+                    .parse()
+                    .map_err(|_name| DependencyResolutionError::InvalidPackageName)?;
 
                 if packages.insert(name.clone(), member_path).is_some() {
-                    return Err(DependencyResolutionError::PackageCollision(crate_name(name)));
+                    return Err(DependencyResolutionError::PackageCollision(name.into()));
                 }
 
                 if local_package.is_none() && workspace.default_member.as_ref() == Some(member) {
-                    local_package = name.map(Into::into);
+                    local_package = Some(name.into());
                 }
             }
             Manifest::Workspace(_) => {
@@ -213,16 +207,15 @@ fn resolve_workspace_manifest(
     }
 
     let local_package = match local_package {
-        Some(local_package) => local_package
-            .parse::<CrateName>()
-            .map_err(|_| DependencyResolutionError::InvalidPackageName)?
-            .into(),
+        Some(local_package) => {
+            local_package.parse().map_err(|_| DependencyResolutionError::InvalidPackageName)?
+        }
         None => packages.keys().last().expect("non-empty packages").clone(),
     };
 
     let local_crate = packages
         .remove(&local_package)
-        .ok_or_else(|| DependencyResolutionError::PackageNotFound(crate_name(local_package)))?;
+        .ok_or_else(|| DependencyResolutionError::PackageNotFound(local_package.into()))?;
 
     let (entry_path, _crate_type) = super::lib_or_bin(local_crate)?;
     let crate_id = create_local_crate(context, &entry_path, CrateType::Workspace);

crates/nargo_cli/tests/target_tests_data/fail/basic/Nargo.toml

@@ -1,4 +1,5 @@
 [package]
+name = "fail_basic"
 authors = [""]
 compiler_version = "0.1"
 

crates/nargo_cli/tests/target_tests_data/fail/dup_func/Nargo.toml

@@ -1,4 +1,5 @@
 [package]
+name = "fail_dup_func"
 authors = [""]
 compiler_version = "0.1"
 

crates/nargo_cli/tests/target_tests_data/pass/basic/Nargo.toml

@@ -1,4 +1,5 @@
 [package]
+name = "pass_basic"
 authors = [""]
 compiler_version = "0.1"
 

crates/nargo_cli/tests/target_tests_data/pass/import/Nargo.toml

@@ -1,4 +1,5 @@
 [package]
+name = "pass_import"
 authors = [""]
 compiler_version = "0.1"
 

crates/nargo_cli/tests/target_tests_data/pass_dev_mode/unused/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "pass_dev_mode_unused"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/1327_concrete_in_generic/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "1327_concrete_in_generic"
 authors = [""]
 compiler_version = "0.6.0"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/1_mul/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "1_mul"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/2_div/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "2_div"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/3_add/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "3_add"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/4_sub/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "4_sub"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/5_over/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "5_over"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/6/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "6"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/6_array/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "6_array"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/7/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "7"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/7_function/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "7_function"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/8_integration/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "8_integration"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/9_conditional/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "9_conditional"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/arithmetic_binary_operations/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "arithmetic_binary_operations"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/array_dynamic/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "array_dynamic"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/array_len/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "array_len"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/array_neq/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "array_neq"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/array_sort/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "array_sort"
 authors = [""]
 compiler_version = "0.6.0"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/assert/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "assert"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/assert_statement/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "assert_statement"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/assign_ex/Nargo.toml

@@ -1,7 +1,6 @@
+[package]
+name = "assign_ex"
+authors = [""]
+compiler_version = "0.1"
 
-        [package]
-        authors = [""]
-        compiler_version = "0.1"
-
-        [dependencies]
-
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/bit_and/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "bit_and"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/bit_shifts_comptime/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "bit_shifts_comptime"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]

crates/nargo_cli/tests/test_data_ssa_refactor/blackbox_func_simple_call/Nargo.toml

@@ -1,5 +1,6 @@
 [package]
+name = "blackbox_func_simple_call"
 authors = [""]
 compiler_version = "0.1"
 
-[dependencies]
+[dependencies]