fix: ensure that configuration files are loaded in the order (robocop.toml > robot.toml > pyproject.toml) (#1729)

Author: bhirsz

docs/configuration/index.md

@@ -25,11 +25,11 @@ Robocop uses a configuration file closest to the source, which allows multiple c
 that apply to the entire execution (such as ``--exit-zero`` or report settings) are exclusively read from the top-level
 configuration file.
 
-When looking for the configuration file, Robocop searches either for:
+When looking for the configuration file, Robocop searches in the following order:
 
+- ``robocop.toml``
+- ``robot.toml``
 - ``pyproject.toml``
-- or ``robocop.toml``
-- or ``robot.toml``
 
 It will visit parent directories until it finds root of the project determined by existence of ``.git`` directory.
 This behaviour can be disabled with ``--ignore-git-dir``.

src/robocop/config/manager.py

@@ -16,7 +16,7 @@
 if TYPE_CHECKING:
     from collections.abc import Generator, Sequence
 
-CONFIG_NAMES = frozenset(("robocop.toml", "pyproject.toml", "robot.toml"))
+CONFIG_NAMES = ("robocop.toml", "robot.toml", "pyproject.toml")
 
 
 class GitIgnoreResolver:

tests/config/test_config_manager.py

@@ -572,6 +572,28 @@ def test_extend_select_formatter(self, tmp_path, overwrite_config):
         # Assert
         assert "IndentNestedKeywords" in resolved_config.formatters
 
+    def test_config_order(self, tmp_path):
+        # Single file
+        config_file = tmp_path / "pyproject.toml"
+        config_file.write_text("[tool.robocop]\nverbose = true\n", encoding="utf-8")
+        with working_directory(tmp_path):
+            config_manager = ConfigManager()
+        assert config_manager.default_config.config_source.endswith("pyproject.toml")
+
+        # Two files
+        config_file = tmp_path / "robot.toml"
+        config_file.write_text("[tool.robocop]\nverbose = true\n", encoding="utf-8")
+        with working_directory(tmp_path):
+            config_manager = ConfigManager()
+        assert config_manager.default_config.config_source.endswith("robot.toml")
+
+        # Three files
+        config_file = tmp_path / "robocop.toml"
+        config_file.write_text("[tool.robocop]\nverbose = true\n", encoding="utf-8")
+        with working_directory(tmp_path):
+            config_manager = ConfigManager()
+        assert config_manager.default_config.config_source.endswith("robocop.toml")
+
 
 class TestCacheConfigOverride:
     """Test that CLI cache options properly override config file cache settings."""

tests/config/test_data/multiple_configs_one_dir/pyproject.toml

@@ -0,0 +1,2 @@
+[tool.robocop]
+verbose = false

tests/config/test_data/multiple_configs_one_dir/robocop.toml

@@ -0,0 +1,2 @@
+[tool.robocop]
+verbose = true

tests/config/test_data/multiple_configs_one_dir/robot.toml

@@ -0,0 +1,2 @@
+[tool.robot.format]
+diff = true