Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Sign up
Appearance settings

Commit b5a72e0

Browse files
noirbizarrewoile
authored andcommitted
feat(providers): add support for some JSON-based version providers (NPM, Composer)
1 parent d9fe2fd commit b5a72e0

File tree

4 files changed

+106
-1
lines changed

4 files changed

+106
-1
lines changed

‎commitizen/providers.py‎

Lines changed: 42 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
from __future__ import annotations
22

3+
import json
34
from abc import ABC, abstractmethod
45
from pathlib import Path
5-
from typing import ClassVar, cast
6+
from typing import Any, ClassVar, cast
67

78
import importlib_metadata as metadata
89
import tomlkit
@@ -122,6 +123,46 @@ def set(self, document: tomlkit.TOMLDocument, version: str):
122123
document["package"]["version"] = version # type: ignore
123124

124125

126+
class JsonProvider(FileProvider):
127+
"""
128+
Base class for JSON-based version providers
129+
"""
130+
131+
indent: ClassVar[int] = 2
132+
133+
def get_version(self) -> str:
134+
document = json.loads(self.file.read_text())
135+
return self.get(document)
136+
137+
def set_version(self, version: str):
138+
document = json.loads(self.file.read_text())
139+
self.set(document, version)
140+
self.file.write_text(json.dumps(document, indent=self.indent) + "\n")
141+
142+
def get(self, document: dict[str, Any]) -> str:
143+
return document["version"] # type: ignore
144+
145+
def set(self, document: dict[str, Any], version: str):
146+
document["version"] = version
147+
148+
149+
class NpmProvider(JsonProvider):
150+
"""
151+
npm package.json version management
152+
"""
153+
154+
filename = "package.json"
155+
156+
157+
class ComposerProvider(JsonProvider):
158+
"""
159+
Composer version management
160+
"""
161+
162+
filename = "composer.json"
163+
indent = 4
164+
165+
125166
def get_provider(config: BaseConfig) -> VersionProvider:
126167
"""
127168
Get the version provider as defined in the configuration

‎docs/config.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -127,6 +127,8 @@ Commitizen provides some version providers for some well known formats:
127127
| `pep621` | Get and set version from `pyproject.toml` `project.version` field |
128128
| `poetry` | Get and set version from `pyproject.toml` `tool.poetry.version` field |
129129
| `cargo` | Get and set version from `Cargo.toml` `project.version` field |
130+
| `npm` | Get and set version from `package.json` `project.version` field |
131+
| `composer` | Get and set version from `composer.json` `project.version` field |
130132

131133
### Custom version provider
132134

‎pyproject.toml‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -106,6 +106,8 @@ cz_customize = "commitizen.cz.customize:CustomizeCommitsCz"
106106
[tool.poetry.plugins."commitizen.provider"]
107107
cargo = "commitizen.providers:CargoProvider"
108108
commitizen = "commitizen.providers:CommitizenProvider"
109+
composer = "commitizen.providers:ComposerProvider"
110+
npm = "commitizen.providers:NpmProvider"
109111
pep621 = "commitizen.providers:Pep621Provider"
110112
poetry = "commitizen.providers:PoetryProvider"
111113

‎tests/test_version_providers.py‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212
from commitizen.providers import (
1313
CargoProvider,
1414
CommitizenProvider,
15+
ComposerProvider,
16+
NpmProvider,
1517
Pep621Provider,
1618
PoetryProvider,
1719
get_provider,
@@ -125,3 +127,61 @@ def test_cargo_provider(config: BaseConfig, chdir: Path):
125127
version = "43.1"
126128
"""
127129
)
130+
131+
132+
def test_npm_provider(config: BaseConfig, chdir: Path):
133+
package_json = chdir / "package.json"
134+
package_json.write_text(
135+
dedent(
136+
"""\
137+
{
138+
"name": "whatever",
139+
"version": "0.1.0"
140+
}
141+
"""
142+
)
143+
)
144+
config.settings["version_provider"] = "npm"
145+
146+
provider = get_provider(config)
147+
assert isinstance(provider, NpmProvider)
148+
assert provider.get_version() == "0.1.0"
149+
150+
provider.set_version("43.1")
151+
assert package_json.read_text() == dedent(
152+
"""\
153+
{
154+
"name": "whatever",
155+
"version": "43.1"
156+
}
157+
"""
158+
)
159+
160+
161+
def test_composer_provider(config: BaseConfig, chdir: Path):
162+
composer_json = chdir / "composer.json"
163+
composer_json.write_text(
164+
dedent(
165+
"""\
166+
{
167+
"name": "whatever",
168+
"version": "0.1.0"
169+
}
170+
"""
171+
)
172+
)
173+
config.settings["version_provider"] = "composer"
174+
175+
provider = get_provider(config)
176+
assert isinstance(provider, ComposerProvider)
177+
assert provider.get_version() == "0.1.0"
178+
179+
provider.set_version("43.1")
180+
assert composer_json.read_text() == dedent(
181+
"""\
182+
{
183+
"name": "whatever",
184+
"version": "43.1"
185+
}
186+
"""
187+
)

0 commit comments

Comments
(0)

AltStyle によって変換されたページ (->オリジナル) /