feat(hook): arg to turn off color in output

Author: thekaveman

conventional_pre_commit/hook.py

@@ -13,6 +13,7 @@ def main(argv=[]):
     )
     parser.add_argument("types", type=str, nargs="*", default=format.DEFAULT_TYPES, help="Optional list of types to support")
     parser.add_argument("input", type=str, help="A file containing a git commit message")
+    parser.add_argument("--no-color", action="store_false", default=True, dest="color", help="Disable color in output.")
     parser.add_argument(
         "--force-scope", action="store_false", default=True, dest="optional_scope", help="Force commit to have scope defined."
     )
@@ -47,7 +48,7 @@ def main(argv=[]):
         with open(args.input, encoding="utf-8") as f:
             commit_msg = f.read()
     except UnicodeDecodeError:
-        print(output.unicode_decode_error())
+        print(output.unicode_decode_error(args.color))
         return RESULT_FAIL
     if args.scopes:
         scopes = args.scopes.split(",")
@@ -61,12 +62,16 @@ def main(argv=[]):
     if format.is_conventional(commit_msg, args.types, args.optional_scope, scopes):
         return RESULT_SUCCESS
 
-    print(output.fail(commit_msg))
+    print(output.fail(commit_msg, use_color=args.color))
 
     if not args.verbose:
-        print(output.verbose_arg())
+        print(output.verbose_arg(use_color=args.color))
     else:
-        print(output.fail_verbose(commit_msg, args.types, args.optional_scope, scopes))
+        print(
+            output.fail_verbose(
+                commit_msg, types=args.types, optional_scope=args.optional_scope, scopes=scopes, use_color=args.color
+            )
+        )
 
     return RESULT_FAIL
 

tests/test_hook.py

@@ -4,6 +4,7 @@
 import pytest
 
 from conventional_pre_commit.hook import RESULT_FAIL, RESULT_SUCCESS, main
+from conventional_pre_commit.output import Colors
 
 
 @pytest.fixture
@@ -103,16 +104,30 @@ def test_main_fail__verbose(bad_commit_path, capsys):
     captured = capsys.readouterr()
     output = captured.out
 
+    assert Colors.LBLUE in output
+    assert Colors.LRED in output
+    assert Colors.RESTORE in output
+    assert Colors.YELLOW in output
     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_main_fail__no_color(bad_commit_path, capsys):
+    result = main(["--verbose", "--no-color", bad_commit_path])
+
+    assert result == RESULT_FAIL
+
+    captured = capsys.readouterr()
+    output = captured.out
+
+    assert Colors.LBLUE not in output
+    assert Colors.LRED not in output
+    assert Colors.RESTORE not in output
+    assert Colors.YELLOW not in output
+
+
 def test_subprocess_fail__missing_args(cmd):
     result = subprocess.call(cmd)