refactor(config): set "files" to alias of "version_files"

Lee-W · Lee-W · commit 38d3296dc34f · 2019-12-27T23:58:56.000+08:00
"files" will be deprecated in 2.0
"verion_files" is not used internally
But, user can still use "files" to achieve the same functionality
diff --git a/commitizen/config/base_config.py b/commitizen/config/base_config.py
@@ -1,3 +1,4 @@
+import warnings
 from typing import Optional
 
 from commitizen.defaults import DEFAULT_SETTINGS
@@ -32,3 +33,16 @@ def add_path(self, path: str):
 
     def _parse_setting(self, data: str) -> dict:
         raise NotImplementedError()
+
+    # TODO: remove "files" supported in 2.0
+    @classmethod
+    def _show_files_column_deprecated_warning(cls):
+        warnings.simplefilter("always", DeprecationWarning)
+        warnings.warn(
+            (
+                '"files" is renamed as "version_files" '
+                "and will be deprecated in next major version\n"
+                'Please repalce "files" with "version_files"'
+            ),
+            category=DeprecationWarning,
+        )
diff --git a/commitizen/config/ini_config.py b/commitizen/config/ini_config.py
@@ -56,13 +56,14 @@ def _parse_setting(self, data: str):
         try:
             _data: dict = dict(config["commitizen"])
             if "files" in _data:
-                files = _data["files"]
-                _f = json.loads(files)
-                _data.update({"files": _f})
+                IniConfig._show_files_column_deprecated_warning()
+                _data.update({"version_files": json.loads(_data["files"])})
+
+            if "version_files" in _data:
+                _data.update({"version_files": json.loads(_data["version_files"])})
+
             if "style" in _data:
-                style = _data["style"]
-                _s = json.loads(style)
-                _data.update({"style": _s})
+                _data.update({"style": json.loads(_data["style"])})
 
             self._settings.update(_data)
         except KeyError:
diff --git a/commitizen/config/toml_config.py b/commitizen/config/toml_config.py
@@ -37,3 +37,7 @@ def _parse_setting(self, data: str):
             self.settings.update(doc["tool"]["commitizen"])
         except exceptions.NonExistentKey:
             self.is_empty_config = True
+
+        if "files" in self.settings:
+            self.settings["version_files"] = self.settings["files"]
+            TomlConfig._show_files_column_deprecated_warning
