Fix extra trailing whitespace when aligning multiline statements with blank lines (#220)

* align blank lines in multiline statement without leading whitespace

* update changelog

Author: bhirsz

CHANGES.md

@@ -2,6 +2,11 @@
 
 ## Unreleased
 
+### Fixes
+- Trailing whitespace is no longer added to blank lines in multiline statements when using align transformers ([#219](https://github.com/MarketSquare/robotframework-tidy/issues/219))
+
+## 1.6.0
+
 ### Transformers
 - New non default transformer `RenameTestCases`. It capitalizes first letter of the test case name, removes trailing dot and can replace provided regex pattern with substitute string ([#183](https://github.com/MarketSquare/robotframework-tidy/issues/183))
 - New non default transformer `RenameKeywords`. It applies Title Case to keyword name and replace underscores by spaces and can replace provided regex pattern with substitute string ([#183](https://github.com/MarketSquare/robotframework-tidy/issues/183))

robotidy/transformers/AlignSettingsSection.py

@@ -3,12 +3,7 @@
 from robot.api.parsing import ModelTransformer, Token
 from robot.parsing.model import Statement
 
-from robotidy.utils import (
-    node_outside_selection,
-    round_to_four,
-    tokens_by_lines,
-    left_align,
-)
+from robotidy.utils import node_outside_selection, round_to_four, tokens_by_lines, left_align, is_blank_multiline
 
 
 class AlignSettingsSection(ModelTransformer):
@@ -97,6 +92,10 @@ def align_rows(self, statements, look_up):
             keyword_statement = st[0][0].type in self.TOKENS_WITH_KEYWORDS
             aligned_statement = []
             for line in st:
+                if is_blank_multiline(line):
+                    line[-1].value = line[-1].value.lstrip(" \t")  # normalize eol from '  \n' to '\n'
+                    aligned_statement.extend(line)
+                    continue
                 keyword_arg = keyword_statement and line[0].type == Token.CONTINUATION
                 up_to = self.up_to_column if self.up_to_column != -1 else len(line) - 2
                 for index, token in enumerate(line[:-2]):

robotidy/transformers/AlignVariablesSection.py

@@ -3,12 +3,7 @@
 from robot.api.parsing import ModelTransformer, Token
 from robot.parsing.model import Statement
 
-from robotidy.utils import (
-    node_outside_selection,
-    round_to_four,
-    tokens_by_lines,
-    left_align,
-)
+from robotidy.utils import node_outside_selection, round_to_four, tokens_by_lines, left_align, is_blank_multiline
 
 
 class AlignVariablesSection(ModelTransformer):
@@ -73,6 +68,10 @@ def align_rows(self, statements, look_up):
                 continue
             aligned_statement = []
             for line in st:
+                if is_blank_multiline(line):
+                    line[-1].value = line[-1].value.lstrip(" \t")  # normalize eol from '  \n' to '\n'
+                    aligned_statement.extend(line)
+                    continue
                 up_to = self.up_to_column if self.up_to_column != -1 else len(line) - 2
                 for index, token in enumerate(line[:-2]):
                     aligned_statement.append(token)

robotidy/utils.py

@@ -276,3 +276,12 @@ def is_suite_templated(node):
     template_finder = TestTemplateFinder()
     template_finder.visit(node)
     return template_finder.templated
+
+
+def is_blank_multiline(statements):
+    return (
+        statements[0].type == Token.CONTINUATION
+        and len(statements) == 3
+        and statements[1].type == "ARGUMENT"
+        and not statements[1].value
+    )

tests/atest/transformers/AlignSettingsSection/expected/blank_line_and_whitespace.robot

@@ -0,0 +1,4 @@
+*** Settings ***
+Documentation       Documentation with extra
+...
+...                 spaces

tests/atest/transformers/AlignSettingsSection/expected/blank_line_doc.robot

@@ -0,0 +1,8 @@
+*** Settings ***
+Documentation       Description of what the file does
+...
+...                 Copyright 2021 by company I am paid by
+Test Template       test
+Force Tags          tag
+...
+...                 tag2

tests/atest/transformers/AlignSettingsSection/source/blank_line_and_whitespace.robot

@@ -0,0 +1,4 @@
+*** Settings ***
+Documentation    Documentation with extra
+...      
+...     spaces

tests/atest/transformers/AlignSettingsSection/source/blank_line_doc.robot

@@ -0,0 +1,8 @@
+*** Settings ***
+Documentation       Description of what the file does
+...
+...                 Copyright 2021 by company I am paid by
+Test Template    test
+Force Tags    tag
+...
+...    tag2

tests/atest/transformers/AlignSettingsSection/test_transformer.py

@@ -64,3 +64,9 @@ def test_continued_statement_style_all_columns_configure_indent(self, indent):
             expected=f'multiline_keywords_{indent}indent.robot',
             config=f':up_to_column=3:argument_indent={indent}'
         )
+
+    def test_multiline_with_blank_line(self):
+        run_tidy_and_compare(self.TRANSFORMER_NAME, source='blank_line_doc.robot')
+
+    def test_doc_multiline_and_whitespace(self):
+        run_tidy_and_compare(self.TRANSFORMER_NAME, source='blank_line_and_whitespace.robot')

tests/atest/transformers/AlignVariablesSection/expected/multiline_with_blank.robot

@@ -0,0 +1,6 @@
+*** Variables ***
+${VARIABLE}             1
+...                     2
+...
+...                     3
+${OTHER_AND_LONGER}     a