Annotate ItemStorage fields (FuelLabs#2588)

Co-authored-by: JC <[email protected]>

sway-ast/src/item/item_storage.rs

@@ -3,7 +3,7 @@ use crate::priv_prelude::*;
 #[derive(Clone, Debug)]
 pub struct ItemStorage {
     pub storage_token: StorageToken,
-    pub fields: Braces<Punctuated<StorageField, CommaToken>>,
+    pub fields: Braces<Punctuated<Annotated<StorageField>, CommaToken>>,
 }
 
 impl Spanned for ItemStorage {

sway-core/src/convert_parse_tree.rs

@@ -815,7 +815,7 @@ fn item_storage_to_storage_declaration(
         .fields
         .into_inner()
         .into_iter()
-        .map(|storage_field| storage_field_to_storage_field(ec, storage_field))
+        .map(|storage_field| storage_field_to_storage_field(ec, storage_field.value))
         .collect::<Result<_, _>>()?;
 
     // Make sure each storage field is declared once

sway-fmt-v2/src/items/item_storage.rs

@@ -32,7 +32,12 @@ impl Format for ItemStorage {
         match formatter.config.structures.field_alignment {
             FieldAlignment::AlignFields(storage_field_align_threshold) => {
                 writeln!(formatted_code)?;
-                let value_pairs = &fields.value_separator_pairs;
+                let value_pairs = &fields
+                    .value_separator_pairs
+                    .iter()
+                    // TODO: Handle annotations instead of stripping them
+                    .map(|pair| (&pair.0.value, &pair.1))
+                    .collect::<Vec<_>>();
                 // In first iteration we are going to be collecting the lengths of the struct fields.
                 let field_length: Vec<usize> = value_pairs
                     .iter()

test/src/e2e_vm_tests/test_programs/should_pass/language/doc_comments/Forc.lock

@@ -0,0 +1,14 @@
+[[package]]
+name = 'core'
+source = 'path+from-root-68219769D077ACAE'
+dependencies = []
+
+[[package]]
+name = 'doc_comments'
+source = 'root'
+dependencies = ['std']
+
+[[package]]
+name = 'std'
+source = 'path+from-root-68219769D077ACAE'
+dependencies = ['core']

test/src/e2e_vm_tests/test_programs/should_pass/language/doc_comments/Forc.toml

@@ -0,0 +1,8 @@
+[project]
+authors = ["Fuel Labs <[email protected]>"]
+entry = "main.sw"
+license = "Apache-2.0"
+name = "doc_comments"
+
+[dependencies]
+std = { path = "../../../../../../../sway-lib-std" }

test/src/e2e_vm_tests/test_programs/should_pass/language/doc_comments/src/main.sw

@@ -0,0 +1,52 @@
+contract;
+
+/// Enum representing either a number or a string
+///
+/// # Examples
+///
+/// `NumberOrString::Number(42)`
+/// `NumberOrString::String("foo")`
+enum NumberOrString {
+    /// The `Number` variant in `NumberOrString`
+    Number: u64,
+    /// The `String` variant in `NumberOrString`
+    String: str[4],
+}
+
+/// Struct holding:
+///
+/// 1. A `value` of type `NumberOrString`
+/// 2. An `address` of type `u64`
+struct Data {
+    /// The `value` field in `Data`
+    value: NumberOrString,
+    /// The `address` field in `Data`
+    address: u64,
+}
+
+/// This is the `FooABI` abi
+abi FooABI {
+    /// This is the `main` method on the `FooABI` abi
+    fn main() -> u64;
+}
+
+/// Storage fields for the contract
+storage {
+    /// A `u64` field
+    field_a: u64 = 0,
+    /// An `str` field
+    field_b: str[4] = "aaaa",
+}
+
+/// The implementation of the `FooABI` abi
+impl FooABI for Contract {
+    /// The main function that does all the things!
+    fn main() -> u64 {
+        let mut data = Data {
+            value: NumberOrString::Number(20),
+            address: 1337,
+        };
+
+        return 20;
+    }
+}

test/src/e2e_vm_tests/test_programs/should_pass/language/doc_comments/test.toml

@@ -0,0 +1,2 @@
+category = "compile"
+validate_abi = false