refactor(defaults): add Settings typeddict

Author: Lee-W

commitizen/config/base_config.py

@@ -1,16 +1,16 @@
 from pathlib import Path
-from typing import Any, Dict, Optional, Union
+from typing import Optional, Union
 
-from commitizen.defaults import DEFAULT_SETTINGS
+from commitizen.defaults import DEFAULT_SETTINGS, Settings
 
 
 class BaseConfig:
     def __init__(self):
-        self._settings: Dict[str, Any] = DEFAULT_SETTINGS.copy()
+        self._settings: Settings = DEFAULT_SETTINGS.copy()
         self._path: Optional[Path] = None
 
     @property
-    def settings(self) -> Dict[str, Any]:
+    def settings(self) -> Settings:
         return self._settings
 
     @property
@@ -25,7 +25,7 @@ def set_key(self, key, value):
         """
         raise NotImplementedError()
 
-    def update(self, data: dict) -> None:
+    def update(self, data: Settings) -> None:
         self._settings.update(data)
 
     def add_path(self, path: Union[str, Path]) -> None:

commitizen/defaults.py

@@ -1,9 +1,9 @@
 from collections import OrderedDict
-from typing import List, Optional, TypedDict
+from typing import Any, List, Optional, Tuple, TypedDict
 
 
 # Type
-class Settings(TypedDict):
+class Settings(TypedDict, total=False):
     name: str
     version: Optional[str]
     version_files: List[str]
@@ -14,6 +14,8 @@ class Settings(TypedDict):
     changelog_start_rev: Optional[str]
     update_changelog_on_bump: bool
     use_shortcuts: bool
+    style: Optional[List[Tuple[str, str]]]
+    customize: Any
 
 
 name: str = "cz_conventional_commits"