feat(bump): it is now possible to specify a pattern in the files attr to replace the version

Author: woile

commitizen/bump.py

@@ -119,17 +119,27 @@ def update_version_in_files(current_version: str, new_version: str, files: list)
     So for example, your tag could look like `v1.0.0` while your version in
     the package like `1.0.0`.
     """
-    for filepath in files:
-        # Read in the file
-        with open(filepath, "r") as file:
-            filedata = file.read()
+    for location in files:
+        filepath, *regex = location.split(":", maxsplit=1)
+        if len(regex) > 0:
+            regex = regex[0]
 
-        # Replace the target string
-        filedata = filedata.replace(current_version, new_version)
+        # Read in the file
+        filedata = []
+        with open(filepath, "r") as f:
+            for line in f:
+                if regex:
+                    is_match = re.search(regex, line)
+                    if not is_match:
+                        filedata.append(line)
+                        continue
+
+                # Replace the target string
+                filedata.append(line.replace(current_version, new_version))
 
         # Write the file out again
         with open(filepath, "w") as file:
-            file.write(filedata)
+            file.write("".join(filedata))
 
 
 def create_tag(version: Union[Version, str], tag_format: Optional[str] = None):

commitizen/commands/bump.py

@@ -33,6 +33,24 @@ def __init__(self, config: dict, arguments: dict):
         }
         self.cz = factory.commiter_factory(self.config)
 
+    def is_initial_tag(self, current_tag_version: str, is_yes: bool = False) -> bool:
+        """Check if reading the whole git tree up to HEAD is needed."""
+        is_initial = False
+        if not git.tag_exist(current_tag_version):
+            if is_yes:
+                is_initial = True
+            else:
+                out.info(f"Tag {current_tag_version} could not be found. ")
+                out.info(
+                    (
+                        "Possible causes:\n"
+                        "- version in configuration is not the current version\n"
+                        "- tag_format is missing, check them using 'git tag --list'\n"
+                    )
+                )
+                is_initial = questionary.confirm("Is this the first tag created?").ask()
+        return is_initial
+
     def __call__(self):
         """Steps executed to bump."""
         try:
@@ -56,23 +74,8 @@ def __call__(self):
         is_yes: bool = self.arguments["yes"]
         prerelease: str = self.arguments["prerelease"]
         increment: Optional[str] = self.arguments["increment"]
-        is_initial: bool = False
-
-        # Check if reading the whole git tree up to HEAD is needed.
-        if not git.tag_exist(current_tag_version):
-            if is_yes:
-                is_initial = True
-            else:
-                out.info(f"Tag {current_tag_version} could not be found. ")
-                out.info(
-                    (
-                        "Possible causes:\n"
-                        "- version in configuration is not the current version\n"
-                        "- tag_format is missing, check them using 'git tag --list'\n"
-                    )
-                )
-                is_initial = questionary.confirm("Is this the first tag created?").ask()
 
+        is_initial = self.is_initial_tag(current_tag_version, is_yes)
         commits = git.get_commits(current_tag_version, from_beginning=is_initial)
 
         # No commits, there is no need to create an empty tag.

tests/test_bump_update_version_in_files.py

@@ -15,7 +15,21 @@
 __version__ = '1.2.3'
 """
 
-files_with_content = (("pyproject.toml", PYPROJECT), ("__version__.py", VERSION_PY))
+REPEATED_VERSION_NUMBER = """
+{
+  "name": "magictool",
+  "version": "1.2.3",
+  "dependencies": {
+      "lodash": "1.2.3"
+  }
+}
+"""
+
+files_with_content = (
+    ("pyproject.toml", PYPROJECT),
+    ("__version__.py", VERSION_PY),
+    ("package.json", REPEATED_VERSION_NUMBER),
+)
 
 
 @pytest.fixture
@@ -40,3 +54,17 @@ def test_update_version_in_files(create_files):
         with open(filepath, "r") as f:
             data = f.read()
         assert new_version in data
+
+
+def test_partial_update_of_file(create_files):
+    old_version = "1.2.3"
+    new_version = "2.0.0"
+    filepath = "tests/package.json"
+    regex = "version"
+    location = f"{filepath}:{regex}"
+
+    bump.update_version_in_files(old_version, new_version, [location])
+    with open(filepath, "r") as f:
+        data = f.read()
+        assert new_version in data
+        assert old_version in data