feat(cli): add cz --version back and add cz --report to separate them from cz version

Author: bearomorphism

commitizen/cli.py

@@ -2,6 +2,7 @@
 
 import argparse
 import logging
+import platform
 import sys
 from copy import deepcopy
 from functools import partial
@@ -13,6 +14,7 @@
 from decli import cli
 
 from commitizen import commands, config, out, version_schemes
+from commitizen.__version__ import __version__
 from commitizen.defaults import DEFAULT_SETTINGS
 from commitizen.exceptions import (
     CommitizenException,
@@ -104,6 +106,16 @@ def __call__(
             "required": False,
             "help": "Comma-separated error codes that won't raise error, e.g., cz -nr 1,2,3 bump. See codes at https://commitizen-tools.github.io/commitizen/exit_codes/",
         },
+        {
+            "name": ["-v", "--version"],
+            "action": "store_true",
+            "help": "Show the version of the installed commitizen",
+        },
+        {
+            "name": ["--report"],
+            "action": "store_true",
+            "help": "Show system information for reporting bugs",
+        },
     ],
     "subcommands": {
         "title": "commands",
@@ -677,6 +689,18 @@ def main() -> None:
         parser.print_help(sys.stderr)
         raise ExpectedExit()
 
+    # TODO(bearomorphism): mark `cz version --commitizen` as deprecated after `cz version` feature is stable
+    if "--version" in sys.argv:
+        out.write(__version__)
+        raise ExpectedExit()
+
+    # TODO(bearomorphism): mark `cz version --report` as deprecated after `cz version` feature is stable
+    if "--report" in sys.argv:
+        out.write(f"Commitizen Version: {__version__}")
+        out.write(f"Python Version: {sys.version}")
+        out.write(f"Operating System: {platform.system()}")
+        raise ExpectedExit()
+
     # This is for the command required constraint in 2.0
     try:
         args, unknown_args = parser.parse_known_args()

tests/test_cli.py

@@ -8,6 +8,7 @@
 from pytest_mock import MockFixture
 
 from commitizen import cli
+from commitizen.__version__ import __version__
 from commitizen.exceptions import (
     ConfigFileNotFound,
     ExpectedExit,
@@ -55,6 +56,24 @@ def test_cz_with_arg_but_without_command(util: UtilFixture):
     assert "Command is required" in str(excinfo.value)
 
 
+def test_cz_with_version_arg(util: UtilFixture, capsys):
+    """Test that cz shows the version when --version is used."""
+    with pytest.raises(ExpectedExit):
+        util.run_cli("--version")
+    out, _ = capsys.readouterr()
+    assert __version__ in out
+
+
+def test_cz_with_report_arg(util: UtilFixture, capsys):
+    """Test that cz shows the report when --report is used."""
+    with pytest.raises(ExpectedExit):
+        util.run_cli("--report")
+    out, _ = capsys.readouterr()
+    assert "Commitizen Version:" in out
+    assert "Python Version:" in out
+    assert "Operating System:" in out
+
+
 def test_name(util: UtilFixture, capsys):
     util.run_cli("-n", "cz_jira", "example")
     out, _ = capsys.readouterr()

tests/test_cli/test_invalid_command_py_3_10___invalid_arg_.txt

@@ -1,4 +1,5 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
           ...
 cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}

tests/test_cli/test_invalid_command_py_3_10_invalidCommand_.txt

@@ -1,4 +1,5 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
           ...
 cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from 'init', 'commit', 'c', 'ls', 'example', 'info', 'schema', 'bump', 'changelog', 'ch', 'check', 'version')

tests/test_cli/test_invalid_command_py_3_11___invalid_arg_.txt

@@ -1,4 +1,5 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
           ...
 cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}

tests/test_cli/test_invalid_command_py_3_11_invalidCommand_.txt

@@ -1,4 +1,5 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
           ...
 cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from 'init', 'commit', 'c', 'ls', 'example', 'info', 'schema', 'bump', 'changelog', 'ch', 'check', 'version')

tests/test_cli/test_invalid_command_py_3_12___invalid_arg_.txt

@@ -1,4 +1,5 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
           ...
 cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}

tests/test_cli/test_invalid_command_py_3_12_invalidCommand_.txt

@@ -1,4 +1,5 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}
           ...
 cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from init, commit, c, ls, example, info, schema, bump, changelog, ch, check, version)

tests/test_cli/test_invalid_command_py_3_13___invalid_arg_.txt

@@ -1,3 +1,4 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
 cz: error: the following arguments are required: {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}

tests/test_cli/test_invalid_command_py_3_13_invalidCommand_.txt

@@ -1,3 +1,4 @@
-usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE]
+usage: cz [-h] [--config CONFIG] [--debug] [-n NAME] [-nr NO_RAISE] [-v]
+          [--report]
           {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version} ...
 cz: error: argument {init,commit,c,ls,example,info,schema,bump,changelog,ch,check,version}: invalid choice: 'invalidCommand' (choose from init, commit, c, ls, example, info, schema, bump, changelog, ch, check, version)