refactor(config): remove ini configuration support

BREAKING CHANGE: setup.cfg, .cz and .cz.cfg are no longer supported

Author: Lee-W

commitizen/commands/init.py

@@ -2,9 +2,9 @@
 from packaging.version import Version
 
 from commitizen import factory, out
-from commitizen.config import BaseConfig, IniConfig, TomlConfig
+from commitizen.config import BaseConfig, TomlConfig
 from commitizen.cz import registry
-from commitizen.defaults import long_term_support_config_files
+from commitizen.defaults import config_files
 from commitizen.exceptions import NoAnswersError
 from commitizen.git import get_latest_tag_name, get_tag_names
 
@@ -23,8 +23,6 @@ def __call__(self):
 
             if "toml" in config_path:
                 self.config = TomlConfig(data="", path=config_path)
-            else:
-                self.config = IniConfig(data="", path=config_path)
 
             self.config.init_empty_config_content()
 
@@ -43,7 +41,7 @@ def __call__(self):
     def _ask_config_path(self) -> str:
         name = questionary.select(
             "Please choose a supported config file: (default: pyproject.toml)",
-            choices=long_term_support_config_files,
+            choices=config_files,
             default="pyproject.toml",
             style=self.cz.style,
         ).ask()

commitizen/config/__init__.py

@@ -1,37 +1,11 @@
-import warnings
 from pathlib import Path
-from typing import Optional, Union
 
 from commitizen import defaults, git
 
 from .base_config import BaseConfig
-from .ini_config import IniConfig
 from .toml_config import TomlConfig
 
 
-def load_global_conf() -> Optional[IniConfig]:
-    home = Path.home()
-    global_cfg = home / Path(".cz")
-    if not global_cfg.exists():
-        return None
-
-    # global conf doesn't make sense with commitizen bump
-    # so I'm deprecating it and won't test it
-    message = (
-        "Global conf will be deprecated in next major version. "
-        "Use per project configuration. "
-        "Remove '~/.cz' file from your conf folder."
-    )
-    warnings.simplefilter("always", DeprecationWarning)
-    warnings.warn(message, category=DeprecationWarning)
-
-    with open(global_cfg, "r") as f:
-        data = f.read()
-
-    conf = IniConfig(data=data, path=global_cfg)
-    return conf
-
-
 def read_cfg() -> BaseConfig:
     conf = BaseConfig()
 
@@ -52,21 +26,14 @@ def read_cfg() -> BaseConfig:
         with open(filename, "r") as f:
             data: str = f.read()
 
-        _conf: Union[TomlConfig, IniConfig]
+        _conf: TomlConfig
         if "toml" in filename.suffix:
             _conf = TomlConfig(data=data, path=filename)
-        else:
-            _conf = IniConfig(data=data, path=filename)
 
         if _conf.is_empty_config:
             continue
         else:
             conf = _conf
             break
 
-    if not conf.path:
-        global_conf = load_global_conf()
-        if global_conf:
-            conf = global_conf
-
     return conf

commitizen/config/ini_config.py

@@ -1,11 +1,8 @@
 from collections import OrderedDict
-from typing import Any, Dict
+from typing import Any, Dict, List
 
 name: str = "cz_conventional_commits"
-# TODO: .cz, setup.cfg, .cz.cfg should be removed in 2.0
-long_term_support_config_files: list = ["pyproject.toml", ".cz.toml"]
-deprcated_config_files: list = [".cz", "setup.cfg", ".cz.cfg"]
-config_files: list = long_term_support_config_files + deprcated_config_files
+config_files: List[str] = ["pyproject.toml", ".cz.toml"]
 
 DEFAULT_SETTINGS: Dict[str, Any] = {
     "name": "cz_conventional_commits",

commitizen/defaults.py

@@ -131,7 +131,6 @@ However, it will still update `pyproject.toml` and `src/__version__.py`.
 To fix it, you'll first `git checkout .` to reset to the status before trying to bump and update
 the version in `setup.py` to `1.21.0`
 
-
 ## Configuration
 
 ### `tag_format`
@@ -155,13 +154,6 @@ In your `pyproject.toml` or `.cz.toml`
 tag_format = "v$minor.$major.$patch$prerelease"
 ```
 
-Or in your `.cz` (TO BE DEPRECATED)
-
-```ini
-[commitizen]
-tag_format = v$minor.$major.$patch$prerelease
-```
-
 The variables must be preceded by a `$` sign.
 
 Supported variables:
@@ -198,16 +190,6 @@ version_files = [
 ]
 ```
 
-`.cz` (TO BE DEPRECATED)
-
-```ini
-[commitizen]
-version_files = [
-    "src/__version__.py",
-    "setup.py:version"
-    ]
-```
-
 In the example above, we can see the reference `"setup.py:version"`.
 This means that it will find a file `setup.py` and will only make a change
 in a line containing the `version` substring.
@@ -234,13 +216,6 @@ Some examples
 bump_message = "release $current_version → $new_version [skip-ci]"
 ```
 
-`.cz` (TO BE DEPRECATED)
-
-```ini
-[commitizen]
-bump_message = release $current_version → $new_version [skip-ci]
-```
-
 ## Custom bump
 
 Read the [customizing section](./customization.md).

docs/bump.md

@@ -1,7 +1,5 @@
 # Configuration
 
-Commitizen has support for `toml` and `ini` files. It first looks up the configuration file in the current working directory and then the root directory of the git project.
-
 ## pyproject.toml or .cz.toml
 
 Add an entry to `pyproject.toml` or `.cz.toml`. Recommended for **python** projects.
@@ -28,38 +26,7 @@ style = [
 ]
 ```
 
-## INI files
-
-**INI files will not be supported in the next major version. Please use toml instead**
-
-Supported files: `.cz`, `.cz.cfg`, `setup.cfg`, and `$HOME/.cz`
-
-The format is slightly different to the `toml`, so pay attention.
-Recommended for **other languages** projects (js, go, etc).
-
-```ini
-[commitizen]
-name = cz_conventional_commits
-version = 0.1.0
-version_files = [
-    "src/__version__.py",
-    "pyproject.toml:version"
-    ]
-style = [
-    ["qmark", "fg:#ff9d00 bold"],
-    ["question", "bold"],
-    ["answer", "fg:#ff9d00 bold"],
-    ["pointer", "fg:#ff9d00 bold"],
-    ["highlighted", "fg:#ff9d00 bold"],
-    ["selected", "fg:#cc5454"],
-    ["separator", "fg:#cc5454"],
-    ["instruction", ""],
-    ["text", ""],
-    ["disabled", "fg:#858585 italic"]
-    ]
-```
-
-The extra tab before the square brackets (`]`) at the end is required.
+`.cz.toml` is recommended for **other languages** projects (js, go, etc).
 
 ## Settings
 

docs/config.md

@@ -3,7 +3,6 @@
 import pytest
 
 from commitizen import cli
-from commitizen.__version__ import __version__
 from commitizen.exceptions import ExpectedExit, NoCommandFoundError, NotAGitProjectError
 
 

tests/test_cli.py

@@ -23,19 +23,6 @@
 target-version = ['py36', 'py37', 'py38']
 """
 
-RAW_CONFIG = """
-[commitizen]
-name = cz_jira
-version = 1.0.0
-version_files = [
-    "commitizen/__version__.py",
-    "pyproject.toml"
-    ]
-style = [
-    ["pointer", "reverse"],
-    ["question", "underline"]
-    ]
-"""
 
 _settings = {
     "name": "cz_jira",
@@ -83,33 +70,17 @@ def config_files_manager(request):
     with open(filepath, "w") as f:
         if "toml" in filename:
             f.write(PYPROJECT)
-        else:
-            f.write(RAW_CONFIG)
     yield
     os.remove(filepath)
 
 
 @pytest.fixture
 def empty_pyproject_ok_cz():
     pyproject = "tests/pyproject.toml"
-    cz = "tests/.cz"
     with open(pyproject, "w") as f:
         f.write("")
-    with open(cz, "w") as f:
-        f.write(RAW_CONFIG)
     yield
     os.remove(pyproject)
-    os.remove(cz)
-
-
-def test_load_global_conf(mocker, tmpdir):
-    with tmpdir.as_cwd():
-        config_file = tmpdir.join(".cz")
-        config_file.write(RAW_CONFIG)
-
-        mocked_path = mocker.patch("commitizen.config.Path", return_value=Path(".cz"))
-        mocked_path.home.return_value = Path(tmpdir)
-        print(config.load_global_conf())
 
 
 @pytest.mark.parametrize(
@@ -120,13 +91,6 @@ def test_load_conf(config_files_manager, configure_supported_files):
     assert cfg.settings == _settings
 
 
-def test_conf_is_loaded_with_empty_pyproject_but_ok_cz(
-    empty_pyproject_ok_cz, configure_supported_files
-):
-    cfg = config.read_cfg()
-    assert cfg.settings == _settings
-
-
 def test_conf_returns_default_when_no_files(configure_supported_files):
     cfg = config.read_cfg()
     assert cfg.settings == defaults.DEFAULT_SETTINGS
@@ -149,13 +113,6 @@ def test_find_git_project_root(tmpdir):
         assert git.find_git_project_root() is None
 
 
-class TestInilConfig:
-    def test_read_setup_cfg_without_commitizen_config(self, tmpdir):
-        path = tmpdir.mkdir("commitizen").join("setup.cfg")
-        ini_config = config.IniConfig(data="", path=path)
-        assert ini_config.is_empty_config
-
-
 class TestTomlConfig:
     def test_init_empty_config_content(self, tmpdir):
         path = tmpdir.mkdir("commitizen").join(".cz.toml")