feat(providers): add support for some JSON-based version providers (NPM, Composer)

Author: noirbizarre

commitizen/providers.py

@@ -1,8 +1,9 @@
 from __future__ import annotations
 
+import json
 from abc import ABC, abstractmethod
 from pathlib import Path
-from typing import ClassVar, cast
+from typing import Any, ClassVar, cast
 
 import importlib_metadata as metadata
 import tomlkit
@@ -122,6 +123,46 @@ def set(self, document: tomlkit.TOMLDocument, version: str):
         document["package"]["version"] = version  # type: ignore
 
 
+class JsonProvider(FileProvider):
+    """
+    Base class for JSON-based version providers
+    """
+
+    indent: ClassVar[int] = 2
+
+    def get_version(self) -> str:
+        document = json.loads(self.file.read_text())
+        return self.get(document)
+
+    def set_version(self, version: str):
+        document = json.loads(self.file.read_text())
+        self.set(document, version)
+        self.file.write_text(json.dumps(document, indent=self.indent) + "\n")
+
+    def get(self, document: dict[str, Any]) -> str:
+        return document["version"]  # type: ignore
+
+    def set(self, document: dict[str, Any], version: str):
+        document["version"] = version
+
+
+class NpmProvider(JsonProvider):
+    """
+    npm package.json version management
+    """
+
+    filename = "package.json"
+
+
+class ComposerProvider(JsonProvider):
+    """
+    Composer version management
+    """
+
+    filename = "composer.json"
+    indent = 4
+
+
 def get_provider(config: BaseConfig) -> VersionProvider:
     """
     Get the version provider as defined in the configuration

docs/config.md

@@ -127,6 +127,8 @@ Commitizen provides some version providers for some well known formats:
 | `pep621` | Get and set version from `pyproject.toml` `project.version` field |
 | `poetry` | Get and set version from `pyproject.toml` `tool.poetry.version` field |
 | `cargo` | Get and set version from `Cargo.toml` `project.version` field |
+| `npm` | Get and set version from `package.json` `project.version` field |
+| `composer` | Get and set version from `composer.json` `project.version` field |
 
 ### Custom version provider
 

pyproject.toml

@@ -106,6 +106,8 @@ cz_customize = "commitizen.cz.customize:CustomizeCommitsCz"
 [tool.poetry.plugins."commitizen.provider"]
 cargo = "commitizen.providers:CargoProvider"
 commitizen = "commitizen.providers:CommitizenProvider"
+composer = "commitizen.providers:ComposerProvider"
+npm = "commitizen.providers:NpmProvider"
 pep621 = "commitizen.providers:Pep621Provider"
 poetry = "commitizen.providers:PoetryProvider"
 

tests/test_version_providers.py

@@ -12,6 +12,8 @@
 from commitizen.providers import (
     CargoProvider,
     CommitizenProvider,
+    ComposerProvider,
+    NpmProvider,
     Pep621Provider,
     PoetryProvider,
     get_provider,
@@ -125,3 +127,61 @@ def test_cargo_provider(config: BaseConfig, chdir: Path):
         version = "43.1"
         """
     )
+
+
+def test_npm_provider(config: BaseConfig, chdir: Path):
+    package_json = chdir / "package.json"
+    package_json.write_text(
+        dedent(
+            """\
+            {
+              "name": "whatever",
+              "version": "0.1.0"
+            }
+            """
+        )
+    )
+    config.settings["version_provider"] = "npm"
+
+    provider = get_provider(config)
+    assert isinstance(provider, NpmProvider)
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("43.1")
+    assert package_json.read_text() == dedent(
+        """\
+        {
+          "name": "whatever",
+          "version": "43.1"
+        }
+        """
+    )
+
+
+def test_composer_provider(config: BaseConfig, chdir: Path):
+    composer_json = chdir / "composer.json"
+    composer_json.write_text(
+        dedent(
+            """\
+            {
+                "name": "whatever",
+                "version": "0.1.0"
+            }
+            """
+        )
+    )
+    config.settings["version_provider"] = "composer"
+
+    provider = get_provider(config)
+    assert isinstance(provider, ComposerProvider)
+    assert provider.get_version() == "0.1.0"
+
+    provider.set_version("43.1")
+    assert composer_json.read_text() == dedent(
+        """\
+        {
+            "name": "whatever",
+            "version": "43.1"
+        }
+        """
+    )