add configure option (#98)

Author: bhirsz

CHANGES.md

@@ -15,6 +15,7 @@
 - 
 
 ### Features
+- New option ``--configure`` or ``-c`` for configuring transformer parameters. It works the same way configuring through ``--transform`` works. The benefit of using ``--configure`` is that you can configure selected transformers and still run all transformers [#96](https://github.com/MarketSquare/robotframework-tidy/issues/96)
 - Transformers can now be disabled by default if you add ``ENABLED = False`` class attribute to your class. Those transformers will be only run when selected explictly with ``--transform`` option [#10](https://github.com/MarketSquare/robotframework-tidy/issues/10)
 - Support for ``pyproject.toml`` configuration files. Because of the required changes there are backward incompatible changes done to ``robotidy.toml`` syntax. See example from [README](https://github.com/MarketSquare/robotframework-tidy/blob/main/README.rst#configuration-file) [#66](https://github.com/MarketSquare/robotframework-tidy/issues/66)
 - ``--list-transformers`` output is now ordered. Also transformers themselves will always run in the same predefined order [#69](https://github.com/MarketSquare/robotframework-tidy/issues/69)

README.rst

@@ -43,9 +43,14 @@ You can run robotidy with selected transformers. Use ``--transform`` argument fo
 
     robotidy --transform ReplaceRunKeywordIf src
 
-Some transformers provide configurable parameters. You can modify them by adding `:` after transformer name::
+Some transformers provide configurable parameters. You can pass your own values using --config/-c TRANSFORMER_NAME:param=value syntax::
 
-    robotidy --transform DiscardEmptySections:allow_only_comments=True src
+    robotidy --configure DiscardEmptySections:allow_only_comments=True src
+
+It is also possible to supply parameters using ``--transform`` option. The main difference is that ``--transform`` works like
+include option in Robot Framework while ``--configure`` allows you to configure selected transformers and still run all of them::
+
+   robotidy --transform DiscardEmptySections:allow_only_comments=True src
 
 It is possible to develop your own transformers. You can use module name (if it is installed in your env) or path to
 file with class::
@@ -54,44 +59,7 @@ file with class::
 
 Command line options
 --------------------
-You can list available options by running ``robotidy --help``::
-
-   Usage: robotidy [OPTIONS] [PATH(S)]
-
-   Options:
-     --transform TRANSFORMER_NAME    Transform files from [PATH(S)] with given
-                                     transformer
-
-     --overwrite / --no-overwrite    Overwrite source files.
-     --diff                          Output diff of each processed file.
-     -s, --spacecount INTEGER        The number of spaces between cells in the
-                                     plain text format. Default is 4.
-
-     -l, --lineseparator [native|windows|unix]
-                                     Line separator to use in outputs. The
-                                     default is 'native'.
-                                     native:  use operating system's native line separators
-                                     windows: use Windows line separators (CRLF)
-                                     unix:    use Unix line separators (LF)
-
-     -p, --usepipes                  Use pipe ('|') as a column separator in the
-                                     plain text format.
-
-     -sl, --startline INTEGER        Limit robotidy only to selected area. If
-                                     --endline is not provided, format text only
-                                     at --startline. Line numbers start from 1.
-
-     -el, --endline INTEGER          Limit robotidy only to selected area. Line
-                                     numbers start from 1.
-
-     -v, --verbose
-     --config FILE                   Read configuration from FILE path.
-     --list-transformers             List available transformers and exit.
-     --describe-transformer TRANSFORMER_NAME
-                                     Show documentation for selected transformer.
-     --version                       Show the version and exit.
-     --help                          Show this message and exit.
-
+You can list available options by running ``robotidy --help``
 
 Configuration file
 -------------------
@@ -117,6 +85,9 @@ Example configuration file::
        "DiscardEmptySections:allow_only_comments=True",
        "ReplaceRunKeywordIf"
    ]
+   configure = [
+       "DiscardEmptySections:allow_only_comments=False"
+   ]
 
 .. Badges links
 

robotidy/app.py

@@ -1,4 +1,4 @@
-from typing import List, Tuple, Dict, Set
+from typing import List, Tuple, Dict, Set, Any
 from difflib import unified_diff
 
 import click
@@ -15,7 +15,8 @@
 
 class Robotidy:
     def __init__(self,
-                 transformers: List[Tuple[str, Dict]],
+                 transformers: List[Tuple[str, List]],
+                 transformers_config: Dict[str, List],
                  src: Set,
                  overwrite: bool,
                  show_diff: bool,
@@ -29,7 +30,7 @@ def __init__(self,
         self.check = check
         self.verbose = verbose
         self.formatting_config = formatting_config
-        self.transformers = load_transformers(transformers)
+        self.transformers = load_transformers(transformers, transformers_config)
 
     def transform_files(self):
         changed_files = 0

robotidy/cli.py

@@ -10,6 +10,7 @@
 from pathlib import Path
 import click
 import toml
+from collections import defaultdict
 
 from robotidy.version import __version__
 from robotidy.app import Robotidy
@@ -38,10 +39,10 @@
   $ robotidy dir_name
 
   # List available transformers:
-  $ robotidy --list-transformers
+  $ robotidy --list
   
   # Display transformer documentation
-  $ robotidy --describe-transformer <TRANSFORMER_NAME>
+  $ robotidy --desc <TRANSFORMER_NAME>
 
   # Format `src.robot` file using `SplitTooLongLine` transformer only
   $ robotidy --transform SplitTooLongLine src.robot
@@ -80,6 +81,13 @@ def convert(self, value, param, ctx):
         return name, args
 
 
+def convert_configure(configure: List[Tuple[str, List]]) -> Dict[str, List]:
+    config_map = defaultdict(list)
+    for transformer, args in configure:
+        config_map[transformer].extend(args)
+    return config_map
+
+
 def find_project_root(srcs: Iterable[str]) -> Path:
     """Return a directory containing .git, or robotidy.toml.
     That directory will be a common parent of all files and directories
@@ -205,6 +213,14 @@ def get_paths(src: Tuple[str, ...]):
     metavar='TRANSFORMER_NAME',
     help="Transform files from [PATH(S)] with given transformer"
 )
+@click.option(
+    '--configure',
+    '-c',
+    type=TransformType(),
+    multiple=True,
+    metavar='TRANSFORMER_NAME:PARAM=VALUE',
+    help='Configure transformers'
+)
 @click.argument(
     "src",
     nargs=-1,
@@ -310,7 +326,8 @@ def get_paths(src: Tuple[str, ...]):
 @click.pass_context
 def cli(
         ctx: click.Context,
-        transform: List[Tuple[str, Dict]],
+        transform: List[Tuple[str, List]],
+        configure: List[Tuple[str, List]],
         src: Tuple[str, ...],
         overwrite: bool,
         diff: bool,
@@ -325,13 +342,13 @@ def cli(
         describe_transformer: Optional[str]
 ):
     if list_transformers:
-        transformers = load_transformers(None)
+        transformers = load_transformers(None, {})
         click.echo('Run --desc <transformer_name> to get more details. Transformers:')
         for transformer in transformers:
             click.echo(transformer.__class__.__name__)
         ctx.exit(0)
     if describe_transformer is not None:
-        transformers = load_transformers(None)
+        transformers = load_transformers(None, {})
         transformer_by_names = {transformer.__class__.__name__: transformer for transformer in transformers}
         if describe_transformer in transformer_by_names:
             click.echo(f"Transformer {describe_transformer}:")
@@ -350,8 +367,10 @@ def cli(
         end_line=endline
     )
     sources = get_paths(src)
+    configure_transform = convert_configure(configure)
     tidy = Robotidy(
         transformers=transform,
+        transformers_config=configure_transform,
         src=sources,
         overwrite=overwrite,
         show_diff=diff,

robotidy/transformers/__init__.py

@@ -8,6 +8,7 @@
 If you don't want to run your transformer by default and only when calling robotidy with --transform YourTransformer
 then add ``ENABLED = False`` class attribute inside.
 """
+from itertools import chain
 from robot.utils.importer import Importer
 
 
@@ -28,20 +29,29 @@
 ]
 
 
-def load_transformers(allowed_transformers):
+def load_transformers(allowed_transformers, config):
     """ Dynamically load all classes from this file with attribute `name` defined in allowed_transformers """
     loaded_transformers = []
     if allowed_transformers:
-
         for name, args in allowed_transformers:
+            # if we are configure the same param from both --transform and --configure we need to overwrite it
+            # it is done by converting to dict and back to list in format of key=value
+            temp_args = {}
+            for arg in chain(args, config.get(name, ())):
+                param, value = arg.split('=', maxsplit=1)
+                temp_args[param] = value
+            args = [f'{key}={value}' for key, value in temp_args.items()]
             import_name = f'robotidy.transformers.{name}' if name in TRANSFORMERS else name
             loaded_transformers.append(Importer().import_class_or_module(
                 import_name,
                 instantiate_with_args=args
             ))
     else:
         for name in TRANSFORMERS:
-            imported_class = Importer().import_class_or_module(f'robotidy.transformers.{name}', instantiate_with_args=())
+            imported_class = Importer().import_class_or_module(
+                f'robotidy.transformers.{name}',
+                instantiate_with_args=config.get(name, ())
+            )
             if getattr(imported_class, 'ENABLED', True):
                 loaded_transformers.append(imported_class)
     return loaded_transformers

tests/utest/test_cli.py

@@ -52,8 +52,7 @@ def test_invalid_configurable_usage(self):
         assert expected_output in str(result.exception)
 
     def test_too_many_arguments_for_transform(self):
-        expected_output = "Importing 'robotidy.transformers.DiscardEmptySections' failed:  " \
-                          "'DiscardEmptySections' expected 0 to 1 arguments, got 2."
+        expected_output = "not enough values to unpack (expected 2, got 1)"
         args = '--transform DiscardEmptySections:allow_only_comments:False'.split()
         result = run_tidy(args, exit_code=1)
         assert expected_output == str(result.exception)
@@ -91,6 +90,9 @@ def test_read_pyproject_config(self):
             'transform': [
                 'DiscardEmptySections:allow_only_comments=True',
                 'SplitTooLongLine'
+            ],
+            'configure': [
+                'DiscardEmptySections:allow_only_comments=False'
             ]
         }
         config_path = str(Path(Path(__file__).parent, 'testdata', 'only_pyproject', 'pyproject.toml'))
@@ -105,6 +107,9 @@ def test_read_pyproject_config_e2e(self):
             'transform': [
                 'DiscardEmptySections:allow_only_comments=True',
                 'SplitTooLongLine'
+            ],
+            'configure': [
+                'DiscardEmptySections:allow_only_comments=False'
             ]
         }
         config_path = str(Path(Path(__file__).parent, 'testdata', 'only_pyproject'))
@@ -206,9 +211,27 @@ def test_diff(self):
         assert "*** Settings ***" in result.output
 
     def test_disabled_transformer(self):
-        transformers = load_transformers(None)
+        transformers = load_transformers(None, {})
         assert all(transformer.__class__.__name__ != 'SmartSortKeywords' for transformer in transformers)
 
     def test_enable_disable_transformer(self):
-        transformers = load_transformers([('SmartSortKeywords', [])])
+        transformers = load_transformers([('SmartSortKeywords', [])], {})
         assert transformers[0].__class__.__name__ == 'SmartSortKeywords'
+
+    def test_configure_transformer(self):
+        transformers = load_transformers(
+            None,
+            {'AlignVariablesSection': ['up_to_column=4']}
+        )
+        transformers_not_configured = load_transformers(None, {})
+        assert len(transformers) == len(transformers_not_configured)
+        for transformer in transformers:
+            if transformer.__class__.__name__ == 'AlignVariablesSection':
+                assert transformer.up_to_column + 1 == 4
+
+    def test_configure_transformer_overwrite(self):
+        transformers = load_transformers(
+            [('AlignVariablesSection', ['up_to_column=3'])],
+            {'AlignVariablesSection': ['up_to_column=4']}
+        )
+        assert transformers[0].up_to_column + 1 == 4

tests/utest/testdata/only_pyproject/pyproject.toml

@@ -5,4 +5,7 @@ startline = 10
 transform = [
    "DiscardEmptySections:allow_only_comments=True",
    "SplitTooLongLine"
+]
+configure = [
+    "DiscardEmptySections:allow_only_comments=False"
 ]