Adds Generics handling to sway-fmt-v2

sway-fmt-v2/src/fmt.rs

@@ -231,14 +231,14 @@ enum Color {
         let sway_code_to_format = r#"contract;
 
 abi StorageMapExample {
-    #[storage(write,)]fn insert_into_map1(key: u64, value: u64);
+    #[storage(write, read,)]fn insert_into_map1(key: u64, value: u64);
 
 fn hello(key: u64, value: u64);
 }"#;
         let correct_sway_code = r#"contract;
 
 abi StorageMapExample {
-    #[storage(write)]
+    #[storage(write, read)]
     fn insert_into_map1(key: u64, value: u64);
 
     fn hello(key: u64, value: u64);

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

@@ -1,10 +1,7 @@
 use crate::{
     config::items::ItemBraceStyle,
     fmt::{Format, FormattedCode, Formatter},
-    utils::{
-        bracket::{AngleBracket, CurlyBrace},
-        item_len::ItemLen,
-    },
+    utils::{bracket::CurlyBrace, item_len::ItemLen},
 };
 use sway_parse::ItemStruct;
 use sway_types::Spanned;
@@ -74,20 +71,9 @@ fn format_struct(
     // Add struct name
     formatted_code.push_str(item_struct.name.as_str());
 
-    // Check if there is generic provided
+    // Format `GenericParams`, if any
     if let Some(generics) = &item_struct.generics {
-        // Push angle brace
-        ItemStruct::open_angle_bracket(formatted_code, formatter);
-        // Get generics fields
-        let generics = generics.parameters.inner.value_separator_pairs.clone();
-        for (index, generic) in generics.iter().enumerate() {
-            // Push ident
-            formatted_code.push_str(generic.0.as_str());
-            if index != generics.len() - 1 {
-                // Push `, ` if this is not the last generic
-                formatted_code.push_str(", ");
-            }
-        }
+        formatted_code.push_str(&generics.format(formatter))
     }
 
     // Handle openning brace
@@ -198,13 +184,3 @@ impl CurlyBrace for ItemStruct {
             .unwrap_or_default();
     }
 }
-
-impl AngleBracket for ItemStruct {
-    fn open_angle_bracket(line: &mut String, _formatter: &mut Formatter) {
-        line.push('<');
-    }
-
-    fn close_angle_bracket(line: &mut String, _formatter: &mut Formatter) {
-        line.push('>');
-    }
-}

sway-fmt-v2/src/utils.rs

@@ -1,7 +1,9 @@
-pub mod attribute;
-pub mod bracket;
-pub mod indent_style;
-pub mod item;
-pub mod item_len;
-pub mod newline_style;
-pub mod program_type;
+pub(crate) mod attribute;
+pub(crate) mod bracket;
+pub(crate) mod generics;
+pub(crate) mod indent_style;
+pub(crate) mod item;
+pub(crate) mod item_len;
+pub(crate) mod newline_style;
+pub(crate) mod program_type;
+pub(crate) mod punctuated;

sway-fmt-v2/src/utils/attribute.rs

@@ -42,20 +42,8 @@ impl FormatDecl for AttributeDecl {
         Self::open_parenthesis(line, formatter);
         // format and add args `read, write`
         if let Some(args) = attr.args {
-            let args = args.into_inner().value_separator_pairs;
-            let mut buf = args
-                .iter()
-                .map(|arg| format!("{}{}", arg.0.as_str(), arg.1.span().as_str()))
-                .collect::<Vec<String>>()
-                .join(" ");
-            if args.len() == 1 {
-                buf.pop(); // pop the ending comma
-                line.push_str(&buf);
-            } else {
-                buf.pop(); // pop the ending space
-                buf.pop(); // pop the ending comma
-                line.push_str(&buf);
-            }
+            let args = args.into_inner();
+            line.push_str(&args.format(formatter));
         }
         // ')'
         Self::close_parenthesis(line, formatter);

sway-fmt-v2/src/utils/bracket.rs

@@ -3,7 +3,7 @@
 //! contained to each item's file.
 use crate::Formatter;
 
-pub trait CurlyBrace {
+pub(crate) trait CurlyBrace {
     /// Handles brace open scenerio. Checks the config for the placement of the brace.
     /// Modifies the current shape of the formatter.
     fn open_curly_brace(line: &mut String, formatter: &mut Formatter);
@@ -13,13 +13,13 @@ pub trait CurlyBrace {
     fn close_curly_brace(line: &mut String, formatter: &mut Formatter);
 }
 
-pub trait SquareBracket {
+pub(crate) trait SquareBracket {
     fn open_square_bracket(line: &mut String, formatter: &mut Formatter);
 
     fn close_square_bracket(line: &mut String, formatter: &mut Formatter);
 }
 
-pub trait Parenthesis {
+pub(crate) trait Parenthesis {
     /// Handles open parenthesis scenarios, checking the config for placement
     /// and modifying the shape of the formatter where necessary.
     fn open_parenthesis(line: &mut String, formatter: &mut Formatter);
@@ -28,8 +28,8 @@ pub trait Parenthesis {
     fn close_parenthesis(line: &mut String, formatter: &mut Formatter);
 }
 
-pub trait AngleBracket {
-    fn open_angle_bracket(line: &mut String, formatter: &mut Formatter);
+pub(crate) trait AngleBracket {
+    fn open_angle_bracket(self, line: &mut String, formatter: &mut Formatter);
 
-    fn close_angle_bracket(line: &mut String, formatter: &mut Formatter);
+    fn close_angle_bracket(self, line: &mut String, formatter: &mut Formatter);
 }

sway-fmt-v2/src/utils/generics.rs

@@ -0,0 +1,35 @@
+use crate::{
+    fmt::{Format, FormattedCode, Formatter},
+    utils::bracket::AngleBracket,
+};
+use sway_parse::GenericParams;
+use sway_types::Spanned;
+
+// In the future we will need to determine whether the generic arguments
+// are better suited as a `where` clause. At present they will be
+// formatted in line.
+//
+impl Format for GenericParams {
+    fn format(&self, formatter: &mut Formatter) -> FormattedCode {
+        let mut formatted_code = String::new();
+        let params = self.parameters.clone().into_inner();
+
+        // `<`
+        Self::open_angle_bracket(self.clone(), &mut formatted_code, formatter);
+        // format and add parameters
+        formatted_code.push_str(&params.format(formatter));
+        // `>`
+        Self::close_angle_bracket(self.clone(), &mut formatted_code, formatter);
+
+        formatted_code
+    }
+}
+
+impl AngleBracket for GenericParams {
+    fn open_angle_bracket(self, line: &mut String, _formatter: &mut Formatter) {
+        line.push_str(self.parameters.open_angle_bracket_token.span().as_str())
+    }
+    fn close_angle_bracket(self, line: &mut String, _formatter: &mut Formatter) {
+        line.push_str(self.parameters.close_angle_bracket_token.span().as_str())
+    }
+}

sway-fmt-v2/src/utils/punctuated.rs

@@ -0,0 +1,30 @@
+use crate::fmt::{Format, FormattedCode, Formatter};
+use sway_parse::punctuated::Punctuated;
+use sway_types::Spanned;
+
+impl<T, P> Format for Punctuated<T, P>
+where
+    T: Spanned,
+    P: Spanned,
+{
+    fn format(&self, _formatter: &mut Formatter) -> FormattedCode {
+        let mut formatted_code = FormattedCode::new();
+
+        // format and add Type & Punct
+        let mut buf = self
+            .value_separator_pairs
+            .iter()
+            .map(|pair| format!("{}{}", pair.0.span().as_str(), pair.1.span().as_str()))
+            .collect::<Vec<String>>()
+            .join(" ");
+        buf.pop(); // pop the ending comma
+        formatted_code.push_str(&buf);
+
+        // add boxed type
+        if let Some(final_value) = &self.final_value_opt {
+            formatted_code.push_str(final_value.span().as_str());
+        }
+
+        formatted_code
+    }
+}