fix(cli/commands): add description for subcommands

Author: marcosdotme

commitizen/cli.py

@@ -114,11 +114,13 @@ def __call__(
         "commands": [
             {
                 "name": ["init"],
+                "description": "init commitizen configuration",
                 "help": "init commitizen configuration",
                 "func": commands.Init,
             },
             {
                 "name": ["commit", "c"],
+                "description": "create new commit",
                 "help": "create new commit",
                 "func": commands.Commit,
                 "arguments": [
@@ -164,22 +166,31 @@ def __call__(
             },
             {
                 "name": "ls",
+                "description": "show available commitizens",
                 "help": "show available commitizens",
                 "func": commands.ListCz,
             },
             {
                 "name": "example",
+                "description": "show commit example",
                 "help": "show commit example",
                 "func": commands.Example,
             },
             {
                 "name": "info",
+                "description": "show information about the cz",
                 "help": "show information about the cz",
                 "func": commands.Info,
             },
-            {"name": "schema", "help": "show commit schema", "func": commands.Schema},
+            {
+                "name": "schema",
+                "description": "show commit schema",
+                "help": "show commit schema",
+                "func": commands.Schema,
+            },
             {
                 "name": "bump",
+                "description": "bump semantic version based on the git log",
                 "help": "bump semantic version based on the git log",
                 "func": commands.Bump,
                 "arguments": [
@@ -346,6 +357,9 @@ def __call__(
             },
             {
                 "name": ["changelog", "ch"],
+                "description": (
+                    "generate changelog (note that it will overwrite existing file)"
+                ),
                 "help": (
                     "generate changelog (note that it will overwrite existing file)"
                 ),
@@ -416,6 +430,7 @@ def __call__(
             },
             {
                 "name": ["check"],
+                "description": "validates that a commit message matches the commitizen schema",
                 "help": "validates that a commit message matches the commitizen schema",
                 "func": commands.Check,
                 "arguments": [
@@ -455,6 +470,10 @@ def __call__(
             },
             {
                 "name": ["version"],
+                "description": (
+                    "get the version of the installed commitizen or the current project"
+                    " (default: installed commitizen)"
+                ),
                 "help": (
                     "get the version of the installed commitizen or the current project"
                     " (default: installed commitizen)"

tests/commands/test_bump_command.py

@@ -1449,3 +1449,15 @@ def test_bump_changelog_contains_increment_only(mocker, tmp_commitizen_project,
 
     assert "3.0.0" in out
     assert "2.0.0" not in out
+
+
+def test_bump_command_shows_description_when_use_help_option(
+    mocker: MockFixture, capsys
+):
+    testargs = ["cz", "bump", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "bump semantic version based on the git log" in str(out).replace("\n", " ")

tests/commands/test_changelog_command.py

@@ -1637,3 +1637,17 @@ def test_export_changelog_template_from_plugin(
 
     assert target.exists()
     assert target.read_text() == tpl
+
+
+def test_changelog_command_shows_description_when_use_help_option(
+    mocker: MockFixture, capsys
+):
+    testargs = ["cz", "changelog", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert ("generate changelog (note that it will overwrite existing file)") in str(
+        out
+    ).replace("\n", " ")

tests/commands/test_check_command.py

@@ -414,3 +414,17 @@ def test_check_conventional_commit_succeed_with_git_diff(mocker, capsys):
     cli.main()
     out, _ = capsys.readouterr()
     assert "Commit validation: successful!" in out
+
+
+def test_check_command_shows_description_when_use_help_option(
+    mocker: MockFixture, capsys
+):
+    testargs = ["cz", "check", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "validates that a commit message matches the commitizen schema" in str(
+        out
+    ).replace("\n", " ")

tests/commands/test_commit_command.py

@@ -1,10 +1,11 @@
 import os
+import sys
 
 import pytest
 from pytest_mock import MockFixture
 from unittest.mock import ANY
 
-from commitizen import cmd, commands
+from commitizen import cli, cmd, commands
 from commitizen.cz.exceptions import CzException
 from commitizen.cz.utils import get_backup_file_path
 from commitizen.exceptions import (
@@ -406,3 +407,15 @@ def test_commit_command_with_message_length_limit(config, mocker: MockFixture):
 
     with pytest.raises(CommitMessageLengthExceededError):
         commands.Commit(config, {"message_length_limit": message_length - 1})()
+
+
+def test_commit_command_shows_description_when_use_help_option(
+    mocker: MockFixture, capsys
+):
+    testargs = ["cz", "commit", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "create new commit" in str(out).replace("\n", " ")

tests/commands/test_example_command.py

@@ -0,0 +1,17 @@
+import pytest
+import sys
+from commitizen import cli
+
+from pytest_mock import MockerFixture
+
+
+def test_example_command_shows_description_when_use_help_option(
+    mocker: MockerFixture, capsys
+):
+    testargs = ["cz", "example", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "show commit example" in str(out).replace("\n", " ")

tests/commands/test_info_command.py

@@ -0,0 +1,17 @@
+import pytest
+import sys
+from commitizen import cli
+
+from pytest_mock import MockerFixture
+
+
+def test_info_command_shows_description_when_use_help_option(
+    mocker: MockerFixture, capsys
+):
+    testargs = ["cz", "info", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "show information about the cz" in str(out).replace("\n", " ")

tests/commands/test_init_command.py

@@ -2,13 +2,14 @@
 
 import json
 import os
+import sys
 from typing import Any
 
 import pytest
 import yaml
 from pytest_mock import MockFixture
 
-from commitizen import commands
+from commitizen import cli, commands
 from commitizen.__version__ import __version__
 from commitizen.exceptions import InitFailedError, NoAnswersError
 
@@ -251,3 +252,15 @@ def test_pre_commit_exec_failed(
         with tmpdir.as_cwd():
             with pytest.raises(InitFailedError):
                 commands.Init(config)()
+
+
+def test_init_command_shows_description_when_use_help_option(
+    mocker: MockFixture, capsys
+):
+    testargs = ["cz", "init", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "init commitizen configuration" in str(out).replace("\n", " ")

tests/commands/test_ls_command.py

@@ -0,0 +1,17 @@
+import pytest
+import sys
+from commitizen import cli
+
+from pytest_mock import MockerFixture
+
+
+def test_ls_command_shows_description_when_use_help_option(
+    mocker: MockerFixture, capsys
+):
+    testargs = ["cz", "ls", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "show available commitizens" in str(out).replace("\n", " ")

tests/commands/test_schema_command.py

@@ -0,0 +1,17 @@
+import pytest
+import sys
+from commitizen import cli
+
+from pytest_mock import MockerFixture
+
+
+def test_schema_command_shows_description_when_use_help_option(
+    mocker: MockerFixture, capsys
+):
+    testargs = ["cz", "schema", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert "show commit schema" in str(out).replace("\n", " ")

tests/commands/test_version_command.py

@@ -4,7 +4,7 @@
 import pytest
 from pytest_mock import MockerFixture
 
-from commitizen import commands
+from commitizen import cli, commands
 from commitizen.__version__ import __version__
 from commitizen.config.base_config import BaseConfig
 
@@ -106,3 +106,18 @@ def test_version_use_version_provider(
     get_provider.assert_called_once()
     mock.get_version.assert_called_once()
     mock.set_version.assert_not_called()
+
+
+def test_version_command_shows_description_when_use_help_option(
+    mocker: MockerFixture, capsys
+):
+    testargs = ["cz", "version", "--help"]
+    mocker.patch.object(sys, "argv", testargs)
+    with pytest.raises(SystemExit):
+        cli.main()
+
+    out, _ = capsys.readouterr()
+    assert (
+        "get the version of the installed commitizen or the current project"
+        " (default: installed commitizen)"
+    ) in str(out).replace("\n", " ")