fix(version): fix the behavior of cz version --major

Author: bearomorphism

commitizen/cli.py

@@ -543,13 +543,13 @@ def __call__(
                     },
                     {
                         "name": ["--major"],
-                        "help": "get just the major version",
+                        "help": "get just the major version. Need to be used with --project or --verbose.",
                         "action": "store_true",
                         "exclusive_group": "group2",
                     },
                     {
                         "name": ["--minor"],
-                        "help": "get just the minor version",
+                        "help": "get just the minor version. Need to be used with --project or --verbose.",
                         "action": "store_true",
                         "exclusive_group": "group2",
                     },

commitizen/commands/version.py

@@ -11,6 +11,7 @@
 
 
 class VersionArgs(TypedDict, total=False):
+    commitizen: bool
     report: bool
     project: bool
     verbose: bool
@@ -19,46 +20,53 @@ class VersionArgs(TypedDict, total=False):
 
 
 class Version:
-    """Get the version of the installed commitizen or the current project."""
+    """Get the version of the installed commitizen or the current project.
+    Precedence:
+    1. report
+    2. commitizen
+    3. verbose, project
+    """
 
     def __init__(self, config: BaseConfig, arguments: VersionArgs) -> None:
         self.config: BaseConfig = config
         self.parameter = arguments
-        self.operating_system = platform.system()
-        self.python_version = sys.version
 
     def __call__(self) -> None:
         if self.parameter.get("report"):
             out.write(f"Commitizen Version: {__version__}")
-            out.write(f"Python Version: {self.python_version}")
-            out.write(f"Operating System: {self.operating_system}")
+            out.write(f"Python Version: {sys.version}")
+            out.write(f"Operating System: {platform.system()}")
             return
 
-        if (verbose := self.parameter.get("verbose")) or self.parameter.get("project"):
-            if verbose:
-                out.write(f"Installed Commitizen Version: {__version__}")
-
-            try:
-                version = get_provider(self.config).get_version()
-            except NoVersionSpecifiedError:
-                out.error("No project information in this project.")
-                return
-
-            try:
-                version_scheme = get_version_scheme(self.config.settings)
-            except VersionSchemeUnknown:
-                out.error("Unknown version scheme.")
+        if self.parameter.get("commitizen") or not (
+            self.parameter.get("project") or self.parameter.get("verbose")
+        ):
+            if self.parameter.get("major") or self.parameter.get("minor"):
+                out.error("Major or minor version can only be used with --project.")
                 return
 
-            _version = version_scheme(version)
+            out.write(__version__)
+            return
 
-            if self.parameter.get("major"):
-                version = f"{_version.major}"
-            elif self.parameter.get("minor"):
-                version = f"{_version.minor}"
+        if self.parameter.get("verbose"):
+            out.write(f"Installed Commitizen Version: {__version__}")
 
-            out.write(f"Project Version: {version}" if verbose else version)
+        try:
+            version = get_provider(self.config).get_version()
+        except NoVersionSpecifiedError:
+            out.error("No project information in this project.")
+            return
+        try:
+            version_scheme = get_version_scheme(self.config.settings)(version)
+        except VersionSchemeUnknown:
+            out.error("Unknown version scheme.")
             return
 
-        # if no argument is given, show installed commitizen version
-        out.write(f"{__version__}")
+        if self.parameter.get("major"):
+            version = f"{version_scheme.major}"
+        elif self.parameter.get("minor"):
+            version = f"{version_scheme.minor}"
+
+        out.write(
+            f"Project Version: {version}" if self.parameter.get("verbose") else version
+        )

tests/commands/test_version_command.py

@@ -11,36 +11,31 @@
 from tests.utils import skip_below_py_3_10
 
 
-def test_version_for_showing_project_version(config, capsys):
-    # No version exist
+def test_version_for_showing_project_version_error(config, capsys):
+    # No version specified in config
     commands.Version(
         config,
-        {"report": False, "project": True, "commitizen": False, "verbose": False},
+        {"project": True},
     )()
     captured = capsys.readouterr()
     assert "No project information in this project." in captured.err
 
+
+def test_version_for_showing_project_version(config, capsys):
     config.settings["version"] = "v0.0.1"
     commands.Version(
         config,
-        {"report": False, "project": True, "commitizen": False, "verbose": False},
+        {"project": True},
     )()
     captured = capsys.readouterr()
     assert "v0.0.1" in captured.out
 
 
-def test_version_for_showing_commitizen_version(config, capsys):
-    commands.Version(
-        config,
-        {"report": False, "project": False, "commitizen": True, "verbose": False},
-    )()
-    captured = capsys.readouterr()
-    assert f"{__version__}" in captured.out
-
-    # default showing commitizen version
+@pytest.mark.parametrize("project", (True, False))
+def test_version_for_showing_commitizen_version(config, capsys, project: bool):
     commands.Version(
         config,
-        {"report": False, "project": False, "commitizen": False, "verbose": False},
+        {"project": project, "commitizen": True},
     )()
     captured = capsys.readouterr()
     assert f"{__version__}" in captured.out
@@ -49,7 +44,7 @@ def test_version_for_showing_commitizen_version(config, capsys):
 def test_version_for_showing_both_versions(config, capsys):
     commands.Version(
         config,
-        {"report": False, "project": False, "commitizen": False, "verbose": True},
+        {"verbose": True},
     )()
     captured = capsys.readouterr()
     assert f"Installed Commitizen Version: {__version__}" in captured.out
@@ -58,7 +53,7 @@ def test_version_for_showing_both_versions(config, capsys):
     config.settings["version"] = "v0.0.1"
     commands.Version(
         config,
-        {"report": False, "project": False, "commitizen": False, "verbose": True},
+        {"verbose": True},
     )()
     captured = capsys.readouterr()
     expected_out = (
@@ -70,7 +65,7 @@ def test_version_for_showing_both_versions(config, capsys):
 def test_version_for_showing_commitizen_system_info(config, capsys):
     commands.Version(
         config,
-        {"report": True, "project": False, "commitizen": False, "verbose": False},
+        {"report": True},
     )()
     captured = capsys.readouterr()
     assert f"Commitizen Version: {__version__}" in captured.out
@@ -96,7 +91,6 @@ def test_version_use_version_provider(
     commands.Version(
         config,
         {
-            "report": False,
             "project": project,
             "verbose": not project,
         },
@@ -135,16 +129,20 @@ def test_version_command_shows_description_when_use_help_option(
 
 
 @pytest.mark.parametrize(
-    "version, expected_version", (("1.0.0", "1\n"), ("2.1.3", "2\n"), ("0.0.1", "0\n"))
+    "version, expected_version",
+    [
+        ("1.0.0", "1\n"),
+        ("2.1.3", "2\n"),
+        ("0.0.1", "0\n"),
+        ("0.1.0", "0\n"),
+    ],
 )
 def test_version_just_major(config, capsys, version: str, expected_version: str):
     config.settings["version"] = version
     commands.Version(
         config,
         {
-            "report": False,
             "project": True,
-            "verbose": False,
             "major": True,
         },
     )()
@@ -154,16 +152,19 @@ def test_version_just_major(config, capsys, version: str, expected_version: str)
 
 @pytest.mark.parametrize(
     "version, expected_version",
-    (("1.0.0", "0\n"), ("2.1.3", "1\n"), ("0.0.1", "0\n"), ("0.1.0", "1\n")),
+    [
+        ("1.0.0", "0\n"),
+        ("2.1.3", "1\n"),
+        ("0.0.1", "0\n"),
+        ("0.1.0", "1\n"),
+    ],
 )
 def test_version_just_minor(config, capsys, version: str, expected_version: str):
     config.settings["version"] = version
     commands.Version(
         config,
         {
-            "report": False,
             "project": True,
-            "verbose": False,
             "minor": True,
         },
     )()

tests/commands/test_version_command/test_version_command_shows_description_when_use_help_option.txt

@@ -10,5 +10,7 @@ options:
   -c, --commitizen  get the version of the installed commitizen
   -v, --verbose     get the version of both the installed commitizen and the
                     current project
-  --major           get just the major version
-  --minor           get just the minor version
+  --major           get just the major version. Need to be used with --project
+                    or --verbose.
+  --minor           get just the minor version. Need to be used with --project
+                    or --verbose.