Address review feedback.

Author: tritao

docs/book/src/reference/attributes.md

@@ -25,7 +25,7 @@ compatibility at the contract ABI level.
 
 > **Note**: At the moment, only enum and struct types support the attribute.
 
-In the example that follows, we originally had `MyStruct` and `MyEnum` types, which we, later on, renamed to `MyStruct` and `MyEnum` in code. To keep the backward compatibility of the ABI, we annotate the types with the `#[abi_name]` attribute and give them the original names:
+In the example that follows, we originally had `MyStruct` and `MyEnum` types, which we, later on, renamed to `RenamedMyStruct` and `RenamedMyEnum` in code. To keep the backward compatibility of the ABI, we annotate the types with the `#[abi_name]` attribute and give them the original names:
 
 ```sway
 contract;

sway-core/src/abi_generation/fuel_abi.rs

@@ -29,8 +29,7 @@ pub enum AbiNameDiagnosticSpan {
 impl AbiNameDiagnosticSpan {
     pub fn span(self) -> Span {
         match self {
-            Self::Attribute(span) => span,
-            Self::Type(span) => span,
+            Self::Attribute(span) | Self::Type(span) => span,
         }
     }
 }
@@ -56,7 +55,7 @@ impl AbiContext<'_> {
 
 pub fn extract_abi_name_inner(span: &Span) -> Option<Span> {
     let text = &span.src().text;
-    let full_attr: &str = &text[span.start()..span.end()];
+    let full_attr = span.as_str();
 
     // Find the "name" key.
     let name_key_pos = full_attr.find("name")?;
@@ -155,14 +154,10 @@ impl TypeId {
         );
 
         if should_check_name {
-            let mut has_abi_name_attribute = false;
-            let (name, attribute_span) =
+            let (has_abi_name_attribute, name, attribute_span) =
                 match Self::get_abi_name_and_span_from_type_id(engines, resolved_type_id)? {
-                    Some(res) => {
-                        has_abi_name_attribute = true;
-                        res
-                    }
-                    None => (String::new(), Span::dummy()),
+                    Some(res) => (true, res.0, res.1),
+                    None => (false, String::new(), Span::dummy()),
                 };
 
             let attribute_name_span =

sway-error/src/error.rs

@@ -3123,7 +3123,7 @@ impl ToDiagnostic for CompileError {
                 },
             },
             ABIDuplicateName { span, other_span: other, is_attribute } => Diagnostic {
-                reason: Some(Reason::new(code(1), "Duplicated name found for renamed ABI type.".into())),
+                reason: Some(Reason::new(code(1), "Duplicated name found for renamed ABI type".into())),
                 issue: Issue::error(
                     source_engine,
                     span.clone(),
@@ -3133,7 +3133,7 @@ impl ToDiagnostic for CompileError {
                     Hint::help(
                         source_engine,
                         other.clone(),
-                        format!("This is the existing {} with conflicting name", if *is_attribute { "attribute" } else { "type" }),
+                        format!("This is the existing {} with conflicting name.", if *is_attribute { "attribute" } else { "type" }),
                     )
                 ],
                 help: vec![],
@@ -3146,7 +3146,7 @@ impl ToDiagnostic for CompileError {
                     String::new()
                 ),
                 hints: vec![],
-                help: vec![format!("The name must be a valid Sway identifier{}", if name.is_empty() { " and cannot be empty" } else { "" })],
+                help: vec![format!("The name must be a valid Sway identifier{}.", if name.is_empty() { " and cannot be empty" } else { "" })],
             },
             _ => Diagnostic {
                     // TODO: Temporarily we use `self` here to achieve backward compatibility.

test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/Forc.toml

@@ -1,6 +1,6 @@
 [project]
 authors = ["Fuel Labs <contact@fuel.sh>"]
-entry = "lib.sw"
+entry = "main.sw"
 license = "Apache-2.0"
 name = "attributes_invalid_abi_names"
 

test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw renamed to test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw

@@ -7,8 +7,8 @@ output:
     Building test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names
    Compiling library std (sway-lib-std)
    Compiling contract attributes_invalid_abi_names (test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names)
-error: Duplicated name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:37:19
+error: Duplicated name found for renamed ABI type
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:37:19
    |
 ...
 37 | #[abi_name(name = "OtherEnum")]
@@ -18,40 +18,40 @@ error: Duplicated name found for renamed ABI type.
    |
 ...
  7 | pub enum OtherEnum {
-   |          --------- help: This is the existing type with conflicting name
+   |          --------- help: This is the existing type with conflicting name.
    |
 ____
 
-error: Duplicated name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:10:19
+error: Duplicated name found for renamed ABI type
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:10:19
    |
 ...
  8 | struct MyStruct {}
-   |        -------- help: This is the existing type with conflicting name
+   |        -------- help: This is the existing type with conflicting name.
  9 | 
 10 | #[abi_name(name = "MyStruct")]
    |                   ^^^^^^^^^^
    |
 ____
 
-error: Duplicated name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:13:19
+error: Duplicated name found for renamed ABI type
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:13:19
    |
 ...
  7 | #[abi_name(name = "SameName")]
-   | ------------------------------ help: This is the existing attribute with conflicting name
+   | ------------------------------ help: This is the existing attribute with conflicting name.
 ...
 13 | #[abi_name(name = "SameName")]
    |                   ^^^^^^^^^^
    |
 ____
 
-error: Duplicated name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:16:19
+error: Duplicated name found for renamed ABI type
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:16:19
    |
 ...
  7 | #[abi_name(name = "SameName")]
-   | ------------------------------ help: This is the existing attribute with conflicting name
+   | ------------------------------ help: This is the existing attribute with conflicting name.
  8 | struct MyStruct {}
  9 | 
 10 | #[abi_name(name = "MyStruct")]
@@ -64,27 +64,27 @@ error: Duplicated name found for renamed ABI type.
 ____
 
 error: Invalid name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:19:19
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:19:19
    |
 ...
 19 | #[abi_name(name = "")]
    |                   ^^
    |
-   = help: The name must be a valid Sway identifier and cannot be empty
+   = help: The name must be a valid Sway identifier and cannot be empty.
 ____
 
 error: Invalid name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:22:19
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:22:19
    |
 ...
 22 | #[abi_name(name = "this !s n0t an identif1er")]
    |                   ^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
-   = help: The name must be a valid Sway identifier
+   = help: The name must be a valid Sway identifier.
 ____
 
-error: Duplicated name found for renamed ABI type.
-  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/lib.sw:28:19
+error: Duplicated name found for renamed ABI type
+  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/src/main.sw:28:19
    |
 ...
 28 | #[abi_name(name = "OtherStruct")]
@@ -94,7 +94,7 @@ error: Duplicated name found for renamed ABI type.
    |
 ...
  3 | pub struct OtherStruct {
-   |            ----------- help: This is the existing type with conflicting name
+   |            ----------- help: This is the existing type with conflicting name.
    |
 ____
 

test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_abi_names/stdout.snap

@@ -1,4 +1,4 @@
 library;
 
 #[abi_name(name = true)]
-pub fn not_ok() {}
+pub struct NotOk {}

test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_args_values_types/src/abi_name_attr.sw

@@ -45,16 +45,6 @@ error: Attribute argument value has a wrong type
   |
 ____
 
-error: Attribute cannot annotate item
- --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_args_values_types/src/abi_name_attr.sw:3:3
-  |
-...
-3 | #[abi_name(name = true)]
-  |   ^^^^^^^^ "abi_name" attribute cannot annotate a function declaration.
-  |
-  = help: "abi_name" attribute can only annotate structs and enums.
-____
-
 error: Attribute argument value has a wrong type
  --> test/src/e2e_vm_tests/test_programs/should_fail/attributes_invalid_args_values_types/src/error_attr.sw:6:17
   |
@@ -75,5 +65,5 @@ error: Attribute argument value has a wrong type
   |
 ____
 
-  Aborting due to 6 errors.
+  Aborting due to 5 errors.
 error: Failed to compile attributes_invalid_args_values_types