Merge pull request #140 from docwhat/docwhat/trailing-spaces

add a rule to strip trailing whitespace

Author: NathanLovato

src/formatter.rs

@@ -137,6 +137,7 @@ impl Formatter {
         self.add_newlines_after_extends_statement()
             .fix_dangling_semicolons()
             .fix_dangling_commas()
+            .fix_trailing_spaces()
             .remove_trailing_commas_from_preload()
             .postprocess_tree_sitter()
     }
@@ -223,6 +224,17 @@ impl Formatter {
         self
     }
 
+    /// This function removes trailing spaces at the end of lines.
+    #[inline(always)]
+    fn fix_trailing_spaces(&mut self) -> &mut Self {
+        let re = RegexBuilder::new(r"[ \t]+$")
+            .multi_line(true)
+            .build()
+            .expect("trailing spaces regex should compile");
+        self.regex_replace_all_outside_strings(re, "");
+        self
+    }
+
     /// This function removes trailing commas from preload function calls.
     /// The GDScript parser doesn't support trailing commas in preload calls,
     /// but our formatter might add them for multi-line calls.

tests/expected/trailing_spaces.gd

@@ -0,0 +1,11 @@
+## This function is the best in the world.
+##
+## There are no mistakes in it.
+func best_function() -> String:
+	var new_string: String = """
+	This is a multi-line string with trailing spaces.  
+	"""
+
+	return new_string
+
+# EOF

tests/input/trailing_spaces.gd

@@ -0,0 +1,11 @@
+## This function is the best in the world.  
+##  
+## There are no mistakes in it.			
+func best_function() -> String:  
+	var new_string: String = """  
+	This is a multi-line string with trailing spaces.  
+	"""  
+	
+	return new_string	
+ 
+# EOF