Skip to content

Commit 38d3296

Browse files
committed
refactor(config): set "files" to alias of "version_files"
"files" will be deprecated in 2.0 "verion_files" is not used internally But, user can still use "files" to achieve the same functionality
1 parent d9f675a commit 38d3296

File tree

3 files changed

+25
-6
lines changed

3 files changed

+25
-6
lines changed

commitizen/config/base_config.py

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
import warnings
12
from typing import Optional
23

34
from commitizen.defaults import DEFAULT_SETTINGS
@@ -32,3 +33,16 @@ def add_path(self, path: str):
3233

3334
def _parse_setting(self, data: str) -> dict:
3435
raise NotImplementedError()
36+
37+
# TODO: remove "files" supported in 2.0
38+
@classmethod
39+
def _show_files_column_deprecated_warning(cls):
40+
warnings.simplefilter("always", DeprecationWarning)
41+
warnings.warn(
42+
(
43+
'"files" is renamed as "version_files" '
44+
"and will be deprecated in next major version\n"
45+
'Please repalce "files" with "version_files"'
46+
),
47+
category=DeprecationWarning,
48+
)

commitizen/config/ini_config.py

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,14 @@ def _parse_setting(self, data: str):
5656
try:
5757
_data: dict = dict(config["commitizen"])
5858
if "files" in _data:
59-
files = _data["files"]
60-
_f = json.loads(files)
61-
_data.update({"files": _f})
59+
IniConfig._show_files_column_deprecated_warning()
60+
_data.update({"version_files": json.loads(_data["files"])})
61+
62+
if "version_files" in _data:
63+
_data.update({"version_files": json.loads(_data["version_files"])})
64+
6265
if "style" in _data:
63-
style = _data["style"]
64-
_s = json.loads(style)
65-
_data.update({"style": _s})
66+
_data.update({"style": json.loads(_data["style"])})
6667

6768
self._settings.update(_data)
6869
except KeyError:

commitizen/config/toml_config.py

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,3 +37,7 @@ def _parse_setting(self, data: str):
3737
self.settings.update(doc["tool"]["commitizen"])
3838
except exceptions.NonExistentKey:
3939
self.is_empty_config = True
40+
41+
if "files" in self.settings:
42+
self.settings["version_files"] = self.settings["files"]
43+
TomlConfig._show_files_column_deprecated_warning

0 commit comments

Comments
 (0)