feat(hook): arg for more verbose output

Author: thekaveman

conventional_pre_commit/hook.py

@@ -27,6 +27,13 @@ def main(argv=[]):
         action="store_true",
         help="Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.",
     )
+    parser.add_argument(
+        "--verbose",
+        action="store_true",
+        dest="verbose",
+        default=False,
+        help="Print more verbose error output.",
+    )
 
     if len(argv) < 1:
         argv = sys.argv[1:]
@@ -53,8 +60,13 @@ def main(argv=[]):
 
     if format.is_conventional(commit_msg, args.types, args.optional_scope, scopes):
         return RESULT_SUCCESS
+
+    print(output.fail(commit_msg))
+
+    if not args.verbose:
+        print(output.verbose_arg())
     else:
-        print(output.fail(commit_msg))
+        print(output.fail_verbose(commit_msg, args.types, args.optional_scope, scopes))
 
     return RESULT_FAIL
 

conventional_pre_commit/output.py

@@ -13,6 +13,12 @@ def fail(commit_msg):
         f"{Colors.LRED}[Bad commit message] >>{Colors.RESTORE} {commit_msg}"
         f"{Colors.YELLOW}Your commit message does not follow Conventional Commits formatting{Colors.RESTORE}",
         f"{Colors.LBLUE}https://www.conventionalcommits.org/{Colors.RESTORE}",
+    ]
+    return os.linesep.join(lines)
+
+
+def verbose_arg():
+    lines = [
         "",
         f"{Colors.YELLOW}Use the {Colors.RESTORE}--verbose{Colors.YELLOW} arg for more information{Colors.RESTORE}",
     ]

tests/messages/bad_commit

@@ -1 +1 @@
-bad: message
+bad message

tests/test_hook.py

@@ -1,3 +1,4 @@
+import os
 import subprocess
 
 import pytest
@@ -94,6 +95,24 @@ def test_main_fail__conventional_commit_bad_multi_line(conventional_commit_bad_m
     assert result == RESULT_FAIL
 
 
+def test_main_fail__verbose(bad_commit_path, capsys):
+    result = main(["--verbose", "--force-scope", bad_commit_path])
+
+    assert result == RESULT_FAIL
+
+    captured = capsys.readouterr()
+    output = captured.out
+
+    assert "Conventional Commit messages follow a pattern like" in output
+    assert f"type(scope): subject{os.linesep}{os.linesep}    extended body" in output
+    assert "Expected value for 'type' but found none." in output
+    assert "Expected value for 'delim' but found none." in output
+    assert "Expected value for 'scope' but found none." in output
+    assert "Expected value for 'subject' but found none." in output
+    assert "git commit --edit --file=.git/COMMIT_EDITMSG" in output
+    assert "edit the commit message and retry the commit" in output
+
+
 def test_subprocess_fail__missing_args(cmd):
     result = subprocess.call(cmd)