Merge branch 'main' of https://github.com/MarketSquare/robotframework-tidy into fix/extra_new_line

Author: bhirsz

robotidy/cli.py

@@ -18,6 +18,48 @@
 
 
 INCLUDE_EXT = ('.robot', '.resource')
+HELP_MSG = f"""
+Version: {__version__}
+
+Robotidy is a tool for formatting Robot Framework source code.
+See examples at the end of this help message too see how you can use Robotidy.
+For more documentation check README section at https://github.com/MarketSquare/robotframework-tidy
+"""
+EPILOG = """
+Examples:
+  # Format `path/to/src.robot` file
+  $ robotidy path/to/src.robot
+
+  # Format every Robot Framework file inside `dir_name` directory
+  $ robotidy dir_name
+
+  # List available transformers:
+  $ robotidy --list-transformers
+  
+  # Display transformer documentation
+  $ robotidy --describe-transformer <TRANSFORMER_NAME>
+
+  # Format `src.robot` file using `SplitTooLongLine` transformer only
+  $ robotidy --transform SplitTooLongLine src.robot
+
+  # Format `src.robot` file using `SplitTooLongLine` transformer only and configured line length 140
+  $ robotidy --transform SplitTooLongLine:line_length=140 src.robot
+
+"""
+
+
+class RawHelp(click.Command):
+    def format_help_text(self, ctx, formatter):
+        if self.help:
+            formatter.write_paragraph()
+            for line in self.help.split('\n'):
+                formatter.write_text(line)
+
+    def format_epilog(self, ctx, formatter):
+        if self.epilog:
+            formatter.write_paragraph()
+            for line in self.epilog.split('\n'):
+                formatter.write_text(line)
 
 
 class TransformType(click.ParamType):
@@ -142,7 +184,7 @@ def get_paths(src: Tuple[str, ...]):
     return sources
 
 
-@click.command()
+@click.command(cls=RawHelp, help=HELP_MSG, epilog=EPILOG)
 @click.option(
     '--transform',
     type=TransformType(),

robotidy/transformers/SplitTooLongLine.py

@@ -2,18 +2,41 @@
     ModelTransformer,
     Token
 )
+from robotidy.decorators import check_start_end_line
 
 
 EOL = Token(Token.EOL)
 CONTINUATION = Token(Token.CONTINUATION)
 
 
 class SplitTooLongLine(ModelTransformer):
+    """
+    Split too long lines.
+    If any line in keyword call exceeds given length limit (configurable using ``line_length``, 120 by default) it will be
+    split::
+
+        Keyword With Longer Name    ${arg1}    ${arg2}    ${arg3}  # let's assume that arg2 is at 120 char
+
+    To::
+
+        Keyword With Longer Name    ${arg1}
+        ...    ${arg2}    ${arg3}
+
+    Using ``split_on_every_arg`` flag (``False`` by default), you can force the formatter to put every argument in a new line::
+
+        Keyword With Longer Name
+        ...    ${arg1}
+        ...    ${arg2}
+        ...    ${arg3}
+
+    Supports global formatting params: ``space_count``, ``--startline`` and ``--endline``.
+    """
     def __init__(self, line_length: int = 120, split_on_every_arg: bool = False):
         super().__init__()
         self.line_length = line_length
         self.split_on_every_arg = split_on_every_arg
 
+    @check_start_end_line
     def visit_KeywordCall(self, node):  # noqa
         if all(line[-1].end_col_offset < self.line_length for line in node.lines):
             return node

robotidy/version.py

@@ -1 +1 @@
-__version__ = '0.0.1'
+__version__ = '1.0.0'