Allow spaces in pyproject.toml config file (#149)

* allow spaces in toml config file

* update docs

Author: bhirsz

CHANGES.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+### Features
+- Allow to use spaces in pyproject.toml configuration file [#148](https://github.com/MarketSquare/robotframework-tidy/issues/148)
+
 ## 1.3.0
 
 ### Transformers

docs/source/configuration/config_file.rst

@@ -21,6 +21,7 @@ Flag-like options like ``--diff``, ``--overwrite/no-overwrite``, ``--check`` req
 ``--transform`` and ``--configure`` require defining list of strings.
 
 See example:
+
   .. code-block:: toml
 
     [tool.robotidy]
@@ -34,4 +35,25 @@ See example:
     ]
     configure = [
         "SplitTooLongLine:split_on_every_arg=False"
-    ]
+    ]
+
+Transformers with multiple parameters can be configured in one line (each param delimited by `:`) or in multi lines:
+
+  .. code-block:: toml
+
+    [tool.robotidy]
+    configure = [
+        "OrderSettings:keyword_before=documentation,tags,timeout,arguments:keyword_after=return"
+        "OrderSettingsSection:group_order=documentation,imports,settings,tags",
+        "OrderSettingsSection:imports_order=library,resource,variables"
+    ]
+
+Transformer configuration can contain spaces for better readability:
+
+  .. code-block:: toml
+
+    [tool.robotidy]
+    configure = [
+        "OrderSettingsSection: group_order = documentation,imports,settings,tags",
+        "OrderSettingsSection: imports_order = library, resource, variables"
+    ]

robotidy/cli.py

@@ -73,7 +73,7 @@ class TransformType(click.ParamType):
     def convert(self, value, param, ctx):
         name = ''
         try:
-            name, args = split_args_from_name_or_path(value)
+            name, args = split_args_from_name_or_path(value.replace(' ', ''))
         except ValueError:
             exc = f'Invalid {name} transformer configuration. ' \
                   f'Parameters should be provided in format name=value, delimited by :'

robotidy/utils.py

@@ -162,6 +162,8 @@ def find_similar(self, name, candidates):
         if not matches:
             return ''
         matches = self.get_original_candidates(matches, norm_cand)
+        if len(matches) == 1 and matches[0] == name:
+            return ''
         suggestion = ' Did you mean:\n'
         suggestion += '\n'.join(f'    {match}' for match in matches)
         return suggestion

tests/utest/test_cli.py

@@ -116,7 +116,8 @@ def test_read_pyproject_config(self):
                 'SplitTooLongLine'
             ],
             'configure': [
-                'DiscardEmptySections:allow_only_comments=False'
+                'DiscardEmptySections:allow_only_comments=False',
+                'OrderSettings: keyword_before = documentation,tags,timeout,arguments'
             ]
         }
         config_path = str(Path(Path(__file__).parent, 'testdata', 'only_pyproject', 'pyproject.toml'))
@@ -134,7 +135,8 @@ def test_read_pyproject_config_e2e(self):
                 'SplitTooLongLine'
             ],
             'configure': [
-                'DiscardEmptySections:allow_only_comments=False'
+                'DiscardEmptySections:allow_only_comments=False',
+                'OrderSettings: keyword_before = documentation,tags,timeout,arguments'
             ]
         }
         config_path = str(Path(Path(__file__).parent, 'testdata', 'only_pyproject'))

tests/utest/testdata/only_pyproject/pyproject.toml

@@ -8,5 +8,6 @@ transform = [
    "SplitTooLongLine"
 ]
 configure = [
-    "DiscardEmptySections:allow_only_comments=False"
+    "DiscardEmptySections:allow_only_comments=False",
+    "OrderSettings: keyword_before = documentation,tags,timeout,arguments"
 ]