Class JsonConfig

commitizen/config/json_config.py:22–70

class JsonConfig(BaseConfig):
    def __init__(self, *, data: bytes | str, path: Path) -> None:
        super().__init__()
        self.path = path
        self._parse_setting(data)

    def contains_commitizen_section(self) -> bool:
        with self.path.open("rb") as json_file:
            try:
                config_doc = json.load(json_file)
            except json.JSONDecodeError:
                return False
        return config_doc.get("commitizen") is not None

    def init_empty_config_content(self) -> None:
        with smart_open(
            self.path, "a", encoding=self._settings["encoding"]
        ) as json_file:
            json.dump({"commitizen": {}}, json_file)

    def set_key(self, key: str, value: object) -> Self:
        with self.path.open("rb") as f:
            config_doc = json.load(f)

        config_doc["commitizen"][key] = value
        with smart_open(self.path, "w", encoding=self._settings["encoding"]) as f:
            json.dump(config_doc, f, indent=2)
        return self

    def _parse_setting(self, data: bytes | str) -> None:
        """We expect to have a section in .cz.json looking like

        ```
        {
            "commitizen": {
                "name": "cz_conventional_commits"
            }
        }
        ```
        """
        try:
            doc = json.loads(data)
        except json.JSONDecodeError as e:
            raise InvalidConfigurationError(f"Failed to parse {self.path}: {e}")

        try:
            self.settings.update(doc["commitizen"])
        except KeyError:
            pass