change Forc.toml to take an array of authors (FuelLabs#822)

* change Forc.toml to take an array of authors * author and authors are optional. added deprecation notice to author * removed duplicate entry fields
ahocom55 · Feb 28, 2022 · 2c14dc6 · 2c14dc6
1 parent ee72f72
commit 2c14dc6
Show file tree

Hide file tree

Showing 119 changed files with 128 additions and 126 deletions.
diff --git a/docs/src/sway-on-chain/libraries.md b/docs/src/sway-on-chain/libraries.md
@@ -40,7 +40,7 @@ Libraries are composed of just a `Forc.toml` file and a `src` folder, unlike usu
 
 ```toml=
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 entry = "lib.sw"
 license = "Apache-2.0"
 name = "lib-std"

diff --git a/examples/fizzbuzz/Forc.toml b/examples/fizzbuzz/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
 name = "fizzbuzz"

diff --git a/examples/hello_world/Forc.toml b/examples/hello_world/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
 name = "hello_world"

diff --git a/examples/subcurrency/Forc.toml b/examples/subcurrency/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
 name = "subcurrency"

diff --git a/examples/wallet_smart_contract/Forc.toml b/examples/wallet_smart_contract/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
 name = "wallet_smart_contract"

diff --git a/forc/src/ops/forc_fmt.rs b/forc/src/ops/forc_fmt.rs
@@ -176,7 +176,7 @@ mod tests {
     fn test_forc_indentation() {
         let correct_forc_manifest = r#"
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "Fuel example project"
 
@@ -193,7 +193,7 @@ std = { git = "http://github.com/FuelLabs/sway-lib-std", version = "v0.0.1" }
         assert_eq!(formatted_content, correct_forc_manifest);
         let indented_forc_manifest = r#"
         [project]
-    author = "Fuel Labs <[email protected]>"
+    authors = ["Fuel Labs <[email protected]>"]
                     license = "Apache-2.0"
     name = "Fuel example project"
 
@@ -207,7 +207,7 @@ std = { git = "http://github.com/FuelLabs/sway-lib-std", version = "v0.0.1" }
         assert_eq!(formatted_content, correct_forc_manifest);
         let whitespace_forc_manifest = r#"
 [project]
- author="Fuel Labs <[email protected]>"
+ authors=["Fuel Labs <[email protected]>"]
 license   =                                   "Apache-2.0"
 name = "Fuel example project"
 
@@ -224,7 +224,7 @@ std         =     {   git     =  "http://github.com/FuelLabs/sway-lib-std"  , ve
     fn test_forc_alphabetization() {
         let correct_forc_manifest = r#"
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "Fuel example project"
 
@@ -243,7 +243,7 @@ std = { git = "http://github.com/FuelLabs/sway-lib-std", version = "v0.0.1" }
 [project]
 name = "Fuel example project"
 license = "Apache-2.0"
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 
 
 [dependencies]

diff --git a/forc/src/utils/defaults.rs b/forc/src/utils/defaults.rs
@@ -5,7 +5,7 @@ pub(crate) fn default_manifest(project_name: &str) -> String {
 
     format!(
         r#"[project]
-author = "{real_name}"
+authors = ["{real_name}"]
 entry = "main.sw"
 license = "Apache-2.0"
 name = "{project_name}"

diff --git a/forc/src/utils/manifest.rs b/forc/src/utils/manifest.rs
@@ -20,7 +20,9 @@ impl Manifest {}
 #[derive(Serialize, Deserialize, Debug)]
 #[serde(rename_all = "kebab-case")]
 pub struct Project {
-    pub author: String,
+    #[deprecated = "use the authors field instead, the author field will be removed soon."]
+    pub author: Option<String>,
+    pub authors: Option<Vec<String>>,
     pub name: String,
     pub organization: Option<String>,
     pub license: String,

diff --git a/test/src/e2e_vm_tests/test_programs/address_test/Forc.toml b/test/src/e2e_vm_tests/test_programs/address_test/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 entry = "main.sw"
 license = "Apache-2.0"
 name = "address_test"

diff --git a/test/src/e2e_vm_tests/test_programs/aliased_imports/Forc.toml b/test/src/e2e_vm_tests/test_programs/aliased_imports/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "aliased_imports"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/array_bad_index/Forc.toml b/test/src/e2e_vm_tests/test_programs/array_bad_index/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "array_bad_index"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/array_basics/Forc.toml b/test/src/e2e_vm_tests/test_programs/array_basics/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "array_basics"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/array_dynamic_oob/Forc.toml b/test/src/e2e_vm_tests/test_programs/array_dynamic_oob/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "array_dynamic_oob"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/array_generics/Forc.toml b/test/src/e2e_vm_tests/test_programs/array_generics/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "array_generics"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/array_oob/Forc.toml b/test/src/e2e_vm_tests/test_programs/array_oob/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "array_oob"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/asm_expr_basic/Forc.toml b/test/src/e2e_vm_tests/test_programs/asm_expr_basic/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "asm_expr_basic"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/asm_missing_return/Forc.toml b/test/src/e2e_vm_tests/test_programs/asm_missing_return/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "asm_missing_return"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/asm_should_not_have_return/Forc.toml b/test/src/e2e_vm_tests/test_programs/asm_should_not_have_return/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "asm_should_not_have_return"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/asm_without_return/Forc.toml b/test/src/e2e_vm_tests/test_programs/asm_without_return/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "asm_without_return"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/assert_test/Forc.toml b/test/src/e2e_vm_tests/test_programs/assert_test/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "assert_test"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/auth_testing_abi/Forc.toml b/test/src/e2e_vm_tests/test_programs/auth_testing_abi/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "auth_testing_abi"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/auth_testing_contract/Forc.toml b/test/src/e2e_vm_tests/test_programs/auth_testing_contract/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "auth_testing_contract"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/b256_bad_jumps/Forc.toml b/test/src/e2e_vm_tests/test_programs/b256_bad_jumps/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "b256_bad_jumps"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/b256_ops/Forc.toml b/test/src/e2e_vm_tests/test_programs/b256_ops/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "b256_ops"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/b512_struct_alignment/Forc.toml b/test/src/e2e_vm_tests/test_programs/b512_struct_alignment/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "b512_panic_test"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/b512_test/Forc.toml b/test/src/e2e_vm_tests/test_programs/b512_test/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "b512_test"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/bad_generic_annotation/Forc.toml b/test/src/e2e_vm_tests/test_programs/bad_generic_annotation/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "bad_generic_annotation"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/bad_generic_var_annotation/Forc.toml b/test/src/e2e_vm_tests/test_programs/bad_generic_var_annotation/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "bad_generic_var_annotation"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/bal_opcode/Forc.toml b/test/src/e2e_vm_tests/test_programs/bal_opcode/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "bal_opcode"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/balance_test_abi/Forc.toml b/test/src/e2e_vm_tests/test_programs/balance_test_abi/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "balance_test_abi"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/balance_test_contract/Forc.toml b/test/src/e2e_vm_tests/test_programs/balance_test_contract/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "balance_test_contract"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/basic_func_decl/Forc.toml b/test/src/e2e_vm_tests/test_programs/basic_func_decl/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "basic_func_decl"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/basic_storage/Forc.toml b/test/src/e2e_vm_tests/test_programs/basic_storage/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "basic_storage"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/basic_storage_abi/Forc.toml b/test/src/e2e_vm_tests/test_programs/basic_storage_abi/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "basic_storage_abi"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/block_height/Forc.toml b/test/src/e2e_vm_tests/test_programs/block_height/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "block_height"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/bool_and_or/Forc.toml b/test/src/e2e_vm_tests/test_programs/bool_and_or/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "bool_and_or"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/call_basic_storage/Forc.toml b/test/src/e2e_vm_tests/test_programs/call_basic_storage/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "call_basic_storage"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/call_increment_contract/Forc.toml b/test/src/e2e_vm_tests/test_programs/call_increment_contract/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "call_increment_contract"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/caller_auth_test/Forc.toml b/test/src/e2e_vm_tests/test_programs/caller_auth_test/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "caller_auth_test"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/caller_context_test/Forc.toml b/test/src/e2e_vm_tests/test_programs/caller_context_test/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "caller_context_test"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/const_decl/Forc.toml b/test/src/e2e_vm_tests/test_programs/const_decl/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "const_decl"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/const_decl_in_library/Forc.toml b/test/src/e2e_vm_tests/test_programs/const_decl_in_library/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "const_decl_in_library"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/context_testing_abi/Forc.toml b/test/src/e2e_vm_tests/test_programs/context_testing_abi/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "context_testing_abi"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/context_testing_contract/Forc.toml b/test/src/e2e_vm_tests/test_programs/context_testing_contract/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "context_testing_contract"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/contract_abi_impl/Forc.toml b/test/src/e2e_vm_tests/test_programs/contract_abi_impl/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "contract_abi_impl"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/contract_call/Forc.toml b/test/src/e2e_vm_tests/test_programs/contract_call/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "contract_call"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/contract_id_test/Forc.toml b/test/src/e2e_vm_tests/test_programs/contract_id_test/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "contract_id_test"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/contract_pure_calls_impure/Forc.toml b/test/src/e2e_vm_tests/test_programs/contract_pure_calls_impure/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "valid_impurity"
 entry = "main.sw"
diff --git a/test/src/e2e_vm_tests/test_programs/dependencies/Forc.toml b/test/src/e2e_vm_tests/test_programs/dependencies/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "dependencies"
 entry = "main.sw"

diff --git a/test/src/e2e_vm_tests/test_programs/dependency_parsing_error/Forc.toml b/test/src/e2e_vm_tests/test_programs/dependency_parsing_error/Forc.toml
@@ -1,5 +1,5 @@
 [project]
-author = "Fuel Labs <[email protected]>"
+authors = ["Fuel Labs <[email protected]>"]
 license = "Apache-2.0"
 name = "dependencies_parsing_error"
 entry = "main.sw"