fix(config): include pyproject.toml in multi config file warning

Author: bearomorphism

commitizen/config/__init__.py

@@ -44,21 +44,16 @@ def read_cfg(filepath: str | None = None) -> BaseConfig:
             raise ConfigFileIsEmpty()
         return conf
 
-    config_candidate_paths = _resolve_config_paths()
-
-    # Check for multiple config files and warn the user
-    config_candidates_exclude_pyproject = [
-        path for path in config_candidate_paths if path.name != "pyproject.toml"
+    config_candidates = [
+        (conf, path)
+        for path in _resolve_config_paths()
+        if not (conf := _create_config_from_path(path)).is_empty_config
     ]
 
-    for config_candidate_path in config_candidate_paths:
-        conf = _create_config_from_path(config_candidate_path)
-        if not conf.is_empty_config:
-            if len(config_candidates_exclude_pyproject) > 1:
-                out.warn(
-                    f"Multiple config files detected: {', '.join(map(str, config_candidates_exclude_pyproject))}. "
-                    f"Using config file: '{config_candidate_path}'."
-                )
-            return conf
+    if len(config_candidates) > 1:
+        out.warn(
+            f"Multiple config files detected: {', '.join(str(path) for _, path in config_candidates)}. "
+            f"Using config file: '{config_candidates[0][1]}'."
+        )
 
-    return BaseConfig()
+    return config_candidates[0][0] if config_candidates else BaseConfig()

tests/test_conf.py

@@ -240,27 +240,25 @@ def test_load_empty_pyproject_toml_from_config_argument(_, tmpdir):
 
 class TestWarnMultipleConfigFiles:
     @pytest.mark.parametrize(
-        "files,expected_path,should_warn",
+        "files,expected_path",
         [
             # Same directory, different file types
-            ([(".cz.toml", PYPROJECT), (".cz.json", JSON_STR)], ".cz.toml", True),
-            ([(".cz.json", JSON_STR), (".cz.yaml", YAML_STR)], ".cz.json", True),
-            ([(".cz.toml", PYPROJECT), (".cz.yaml", YAML_STR)], ".cz.toml", True),
-            # With pyproject.toml (excluded from warning)
+            ([(".cz.toml", PYPROJECT), (".cz.json", JSON_STR)], ".cz.toml"),
+            ([(".cz.json", JSON_STR), (".cz.yaml", YAML_STR)], ".cz.json"),
+            ([(".cz.toml", PYPROJECT), (".cz.yaml", YAML_STR)], ".cz.toml"),
+            # With pyproject.toml
             (
                 [("pyproject.toml", PYPROJECT), (".cz.json", JSON_STR)],
                 ".cz.json",
-                False,
             ),
             (
                 [("pyproject.toml", PYPROJECT), (".cz.toml", PYPROJECT)],
                 ".cz.toml",
-                False,
             ),
         ],
     )
     def test_warn_multiple_config_files_same_dir(
-        _, tmpdir, capsys, files, expected_path, should_warn
+        _, tmpdir, capsys, files, expected_path
     ):
         """Test warning when multiple config files exist in same directory."""
         with tmpdir.as_cwd():
@@ -270,19 +268,12 @@ def test_warn_multiple_config_files_same_dir(
             cfg = config.read_cfg()
             captured = capsys.readouterr()
 
-            if should_warn:
-                assert "Multiple config files detected" in captured.err
-                assert "Using" in captured.err
-                for filename, _ in files:
-                    if filename != "pyproject.toml":
-                        assert filename in captured.err
-            else:
-                assert "Multiple config files detected" not in captured.err
+            assert "Multiple config files detected" in captured.err
+            for filename, _ in files:
+                assert filename in captured.err
+            assert f"Using config file: '{expected_path}'" in captured.err
 
             assert cfg.path == Path(expected_path)
-            # Verify config loaded correctly (name and version match expected)
-            assert cfg.settings["name"] == "cz_jira"
-            assert cfg.settings["version"] == "1.0.0"
 
     @pytest.mark.parametrize(
         "config_file,content",