Fix --custom-transformers not supported in the configuration file (#647)

Author: bhirsz

docs/releasenotes/4.0.0.rst

@@ -195,13 +195,13 @@ any other transformer not listed with ``--transform``. That's why if user would
     > robotidy --transform MyCustomClass.py test.robot
 
 It would disable all default transformers and only run MyCustomClass.
-This release introduces new option ``--load-transformer`` which imports custom transformers on top of the default ones::
+This release introduces new option ``--custom-transformers`` which imports custom transformers on top of the default ones::
 
-    > robotidy --load-transformer MyCustomClass.py test.robot
+    > robotidy --custom-transformers MyCustomClass.py test.robot
 
 It is also possible to pass transformer configuration either using this option or through ``--configure``::
 
-    > robotidy -c ExtClass1.py:param=value --load-transformer ExtClass2.py:param2=value test.robot
+    > robotidy -c ExtClass1.py:param=value --custom-transformers ExtClass2.py:param2=value test.robot
 
 Load custom transformers from the module
 -------------------------------------------
@@ -210,7 +210,7 @@ It is now possible to load transformers from the Python module. Importing transf
 to how custom libraries are imported in Robot Framework. If the file has the same name as transformer, it will
 be auto-imported. The following command::
 
-    > robotidy --load-transformer CustomClass.py
+    > robotidy --custom-transformers CustomClass.py
 
 will load ``class CustomClass`` from the ``CustomClass.py`` file. It's the old behaviour and it will not change.
 
@@ -357,7 +357,7 @@ Spaces in the transformer name or configuration
 Spaces are now allowed in the transformer path or configuration value. To provide such name or value
 enclose it with quotation marks::
 
-    > robotidy --load-transformer "C:\\My Transformers\\Transformer.py"
+    > robotidy --custom-transformers "C:\\My Transformers\\Transformer.py"
     > robotidy --configure CustomTransformer:value="param value"
 
 Bugs

docs/releasenotes/unreleased/fixes.5.rst

@@ -0,0 +1,8 @@
+load_transformers not supported in the configuration file (#576)
+-----------------------------------------------------------------
+
+``--load-transformers`` (and ``load_transformers`` in the toml configuration file) was renamed before to
+``--custom-transformers`` (``custom_transformers``). Old name remained due to backward compatibility. However it was
+not handled properly and Robotidy cli only supported ``--load-transformers`` while configuration file only
+``custom_transformers``. Now the approach should be unified and both cli and configuration file should support old
+and new option name.

docs/source/configuration/configuring_transformers.rst

@@ -3,18 +3,18 @@
 Configuring Transformers
 ========================
 
-Transformers can be configured through three different options: ``--transform`` (``-t``), ``--load-transformer`` and
+Transformers can be configured through three different options: ``--transform`` (``-t``), ``--custom-transformers`` and
 ``--configure`` (``-c``). They share the same syntax for parameter names and values.
 
 - ``--configure`` simply provides the configuration to the transformer,
 - ``--transform`` is used to include only transformers that have ``--transform`` option,
-- ``--load-transformer`` is used to load user transformers. Read more at :ref:`external-transformers`.
+- ``--custom-transformers`` is used to load user transformers. Read more at :ref:`external-transformers`.
 
 For example::
 
     robotidy --transform NormalizeNewLines:test_case_lines=2 src
     robotidy --configure NormalizeNewLines:test_case_lines=2 src
-    robotidy --configure NormalizeNewLines:test_case_lines=1 --load-transformer MyCustomTransformer.py:param=value src
+    robotidy --configure NormalizeNewLines:test_case_lines=1 --custom-transformers MyCustomTransformer.py:param=value src
 
 With first command robotidy will run only ``NormalizeNewLines`` transformer and it will configure it with ``test_case_lines = 2``.
 

docs/source/external_transformers.rst

@@ -7,12 +7,12 @@ file with class to run external transformers with *robotidy*::
 
     robotidy --transform MyTransformers.YourCustomTransformer src
     robotidy --transform C:\transformers\YourCustomTransformer2.py src
-    robotidy --load-transformer C:\transformers\YourCustomTransformer2.py src
+    robotidy --custom-transformers C:\transformers\YourCustomTransformer2.py src
 
 External transformers can be configured in the same way internal transformers are configured - see :ref:`configuring-transformers`.
 
-You can use both ``--transform`` and ``--load-transformer`` options to load custom user transformer. The main difference
-is that ``--transform`` works like include and will only run transformers listed with ``--transform``. While ``--load-transformer``
+You can use both ``--transform`` and ``--custom-transformers`` options to load custom user transformer. The main difference
+is that ``--transform`` works like include and will only run transformers listed with ``--transform``. While ``--custom-transformers``
 will run default transformers first and then user transformers.
 
 Importing whole modules
@@ -21,7 +21,7 @@ Importing whole modules
 Importing transformers from module works similarly to how custom libraries are imported in Robot Framework. If the the
 file has the same name as transformer it will be auto imported. For example following import::
 
-    robotidy --load-transformer CustomFormatter.py src
+    robotidy --custom-transformers CustomFormatter.py src
 
 will auto import class ``CustomFormatter`` from the file.
 

robotidy/cli.py

@@ -232,6 +232,7 @@ def generate_config(global_config: config_module.MainConfig):
 )
 @click.option(
     "--load-transformers",
+    "--custom-transformers",
     "custom_transformers",
     type=TransformConfigParameter(),
     multiple=True,

robotidy/config.py

@@ -186,6 +186,9 @@ def from_config_file(self, config: Dict, config_path: Path) -> "RawConfig":
         options_map = map_class_fields_with_their_types(self)
         parsed_config = {"defined_in_config": {"defined_in_config", "config_path"}, "config_path": config_path}
         for key, value in config.items():
+            # workaround to be able to use two option names for same action - backward compatibility change
+            if key == "load_transformers":
+                key = "custom_transformers"
             if key not in options_map:
                 raise exceptions.NoSuchOptionError(key, list(options_map.keys())) from None
             value_type = options_map[key]

tests/utest/test_cli.py

@@ -518,6 +518,18 @@ def test_skip_options(self, tmp_path):
                 option_names.append("empty")
         run_tidy([*option_names, str(tmp_path)])
 
+    @pytest.mark.parametrize("option_name", ["custom_transformers", "load_transformers"])
+    def test_load_custom_transformers_from_config(self, option_name):
+        config_path = TEST_DATA_DIR / "config_with_custom_transformers" / f"{option_name}.toml"
+        config_file = read_pyproject_config(config_path)
+        config = RawConfig().from_config_file(config_file, config_path)
+        assert config.custom_transformers[0].name == "CustomTransformer.py"
+
+    @pytest.mark.parametrize("option_name", ["--custom-transformers", "--load-transformers"])
+    def test_load_custom_transformers_from_cli(self, option_name, tmp_path):
+        custom_transformer = TEST_DATA_DIR / "config_with_custom_transformers" / "CustomTransformer.py"
+        run_tidy([option_name, str(custom_transformer), str(tmp_path)])
+
 
 class TestGenerateConfig:
     def validate_generated_default_configuration(

tests/utest/testdata/config_with_custom_transformers/CustomTransformer.py

@@ -0,0 +1,2 @@
+class CustomTransformer:
+    pass

tests/utest/testdata/config_with_custom_transformers/custom_transformers.toml

@@ -0,0 +1,2 @@
+[tool.robotidy]
+custom_transformers = ["CustomTransformer.py"]

tests/utest/testdata/config_with_custom_transformers/load_transformers.toml

@@ -0,0 +1,2 @@
+[tool.robotidy]
+load_transformers = ["CustomTransformer.py"]