add TrimSpaces & tests

Author: xxchan

Cargo.toml

@@ -63,7 +63,6 @@ unicode-width = "0.1"
 unicode_categories = "0.1"
 
 # Rustc dependencies are loaded from the sysroot, Cargo doesn't know about them.
-
 [package.metadata.rust-analyzer]
 # This package uses #[feature(rustc_private)]
 rustc_private = true

src/formatting/cargo_toml.rs

@@ -26,6 +26,7 @@ pub(crate) fn format_cargo_toml_inner(content: &str, config: &Config) -> Result<
             long_tables: vec![],
             current_section: String::new(),
         },
+        &mut TrimSpaces,
     ];
     for rule in rules.into_iter() {
         rule.visit_document_mut(&mut doc);
@@ -75,6 +76,11 @@ struct BlankLine {
     trimming: bool,
 }
 
+/// Trim unnecessary spaces.
+///
+/// Note: this is not included in the Style Guide.
+struct TrimSpaces;
+
 /// Don't use quotes around any standard key names; use bare keys. Only use quoted
 /// keys for non-standard keys whose names require them, and avoid introducing such
 /// key names when possible.
@@ -349,3 +355,96 @@ impl VisitMut for FormatInlineTable {
         });
     }
 }
+
+impl TrimSpaces {
+    fn trim_block(s: &str) -> String {
+        let s = s.trim();
+        if s.is_empty() {
+            return String::new();
+        }
+
+        let s: String = s
+            .lines()
+            .into_iter()
+            .filter_map(|line| {
+                let trimmed = line.trim();
+                if trimmed.is_empty() {
+                    None
+                } else {
+                    Some(format!("{trimmed}"))
+                }
+            })
+            .join("\n");
+
+        format!("{}\n", s)
+    }
+
+    fn trim_suffix(s: &str) -> String {
+        let s = s.trim();
+        if s.is_empty() {
+            String::new()
+        } else {
+            format!(" {}", s)
+        }
+    }
+}
+
+impl VisitMut for TrimSpaces {
+    fn visit_document_mut(&mut self, node: &mut Document) {
+        self.visit_table_mut(node);
+
+        let set_prefix = |decor: &mut Decor, i: usize| {
+            let prefix = format!(
+                "{}{}",
+                if i == 0 { "" } else { "\n" },
+                Self::trim_block(decor.prefix().unwrap_or_default())
+            );
+            decor.set_prefix(prefix);
+        };
+        let table = node.as_table_mut();
+        for (i, (_, item)) in table.iter_mut().enumerate() {
+            if let Some(table) = item.as_table_mut() {
+                set_prefix(table.decor_mut(), i);
+            } else if let Some(arr) = item.as_array_of_tables_mut() {
+                for table in arr.iter_mut() {
+                    set_prefix(table.decor_mut(), i);
+                }
+            }
+        }
+
+        if !node.trailing().trim().is_empty() {
+            let trailing: String = Self::trim_block(node.trailing());
+            node.set_trailing(&format!("\n{trailing}"));
+        } else {
+            node.set_trailing("");
+        }
+    }
+
+    fn visit_table_mut(&mut self, node: &mut Table) {
+        let decor = node.decor_mut();
+        if let Some(prefix) = decor.prefix() {
+            decor.set_prefix(format!("\n{}", Self::trim_block(prefix)));
+        }
+        if let Some(suffix) = decor.suffix() {
+            decor.set_suffix(Self::trim_suffix(suffix));
+        }
+
+        self.visit_table_like_mut(node);
+    }
+
+    fn visit_table_like_kv_mut(&mut self, mut key: KeyMut<'_>, value: &mut Item) {
+        let decor = key.decor_mut();
+        if let Some(prefix) = decor.prefix() {
+            decor.set_prefix(format!("{}", Self::trim_block(prefix)));
+        }
+
+        if let Some(value) = value.as_value_mut() {
+            let decor = value.decor_mut();
+            if let Some(suffix) = decor.suffix() {
+                decor.set_suffix(Self::trim_suffix(suffix));
+            }
+        }
+
+        self.visit_item_mut(value);
+    }
+}

tests/source/cargo-toml/1/Cargo.toml renamed to tests/source/cargo-toml/basic/Cargo.toml

@@ -1,27 +1,49 @@
 
 
-[[bin]]
-        "aa" = 1
-        'bb' = 2
+  # comment before [[bin]], not necessarily at the beginning
+
+
+    [[bin]]    # comment  after [[bin]]
+        "aa" = 1     # comment for "aa"    
+        'bb' = 2 
         "啊"=1
+
+         # comment before package  
+
 [package]
     version = 1
     description = "a\nb\nhaha"
     name = 3
 
-# comment 1
-
+   # comment 1  for arr1 line1
+   
+# comment 1 for arr1 line 2
     arr1 = [1,
-        2,3]
+        2,3]  
 
-# comment 2
+# comment 2   for arr2   
 
     arr2 = ["11111111111111111111111111111111111111111111111111111111111111111111111111111111","1111111111111111111111111111111111111111111111111111111111111111111111111111111"]
 
+   # comment before [[dependencies]], not after [package]  
+
+
 [dependencies]
         extremely_long_crate_name_goes_here = {path = "extremely_long_path_name_goes_right_here",version = "4.5.6"}
+
+        
         crate1 = {            path = "crate1",version = "1.2.3"                   }
+   
+# comment before the second [[bin]]
 
 [[bin]]
         d = "git-rustfmt"
-        c = "src/git-rustfmt/main.rs"
+        c = "src/git-rustfmt/main.rs"
+
+
+
+
+    #   comment at the end of the file   
+
+
+    

tests/source/cargo-toml/virtual-manifest/Cargo.toml

@@ -0,0 +1,39 @@
+
+
+   # Works correctly for Cargo.toml without [package]
+
+
+[workspace]
+
+
+members = ["xtask/", "lib/*", "crates/*"]
+exclude = ["crates/proc-macro-test/imp"]
+
+
+[profile.dev]
+
+# Disabling debug info speeds up builds a bunch,
+# and we don't rely on it for debugging that much.
+
+debug1 = 0
+   
+   
+[profile.dev.package]
+
+# These speed up local tests.
+rowan.opt-level = 3
+rustc-hash.opt-level = 3
+smol_str.opt-level = 3
+text-size.opt-level = 3
+# This speeds up `cargo xtask dist`.
+miniz_oxide.opt-level = 3
+
+
+[profile.release]
+
+incremental = true
+# Set this to 1 or 2 to get more useful backtraces in debugger.
+debug2 = 0
+
+   
+   

tests/target/cargo-toml/1/Cargo.toml renamed to tests/target/cargo-toml/basic/Cargo.toml

@@ -1,9 +1,11 @@
+# comment before package
 [package]
 name = 3
 version = 1
-# comment 1
+# comment 1  for arr1 line1
+# comment 1 for arr1 line 2
 arr1 = [1, 2, 3]
-# comment 2
+# comment 2   for arr2
 arr2 = [
     "11111111111111111111111111111111111111111111111111111111111111111111111111111111",
     "1111111111111111111111111111111111111111111111111111111111111111111111111111111"
@@ -13,18 +15,23 @@ a
 b
 haha"""
 
-[[bin]]
-aa = 1
+# comment before [[bin]], not necessarily at the beginning
+[[bin]] # comment  after [[bin]]
+aa = 1 # comment for "aa"
 bb = 2
 "啊" = 1
 
+# comment before the second [[bin]]
 [[bin]]
 c = "src/git-rustfmt/main.rs"
 d = "git-rustfmt"
 
+# comment before [[dependencies]], not after [package]
 [dependencies]
 crate1 = { path = "crate1", version = "1.2.3" }
 
 [dependencies.extremely_long_crate_name_goes_here]
 path = "extremely_long_path_name_goes_right_here"
 version = "4.5.6"
+
+#   comment at the end of the file

tests/target/cargo-toml/virtual-manifest/Cargo.toml

@@ -0,0 +1,23 @@
+# Works correctly for Cargo.toml without [package]
+[workspace]
+exclude = ["crates/proc-macro-test/imp"]
+members = ["xtask/", "lib/*", "crates/*"]
+
+[profile.dev]
+# Disabling debug info speeds up builds a bunch,
+# and we don't rely on it for debugging that much.
+debug1 = 0
+
+[profile.dev.package]
+# These speed up local tests.
+rowan.opt-level = 3
+rustc-hash.opt-level = 3
+smol_str.opt-level = 3
+text-size.opt-level = 3
+# This speeds up `cargo xtask dist`.
+miniz_oxide.opt-level = 3
+
+[profile.release]
+incremental = true
+# Set this to 1 or 2 to get more useful backtraces in debugger.
+debug2 = 0