feat: console script entrypoint for hook

usage: conventional-pre-commit [-h] [types ...] input

Author: thekaveman

conventional_pre_commit/hook.py

@@ -14,11 +14,20 @@ class Colors:
     YELLOW = "\033[00;33m"
 
 
-def main(argv):
-    parser = argparse.ArgumentParser()
-    parser.add_argument("types", nargs="*", default=format.DEFAULT_TYPES)
-    parser.add_argument("input")
-    args = parser.parse_args(argv)
+def main(argv=[]):
+    parser = argparse.ArgumentParser(
+        prog="conventional-pre-commit", description="Check a git commit message for Conventional Commits formatting."
+    )
+    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")
+
+    if len(argv) < 1:
+        argv = sys.argv[1:]
+
+    try:
+        args = parser.parse_args(argv)
+    except SystemExit:
+        return RESULT_FAIL
 
     with open(args.input) as f:
         message = f.read()
@@ -53,5 +62,4 @@ def main(argv):
 
 
 if __name__ == "__main__":
-    argv = sys.argv[1:]
-    raise SystemExit(main(argv))
+    raise SystemExit(main())

setup.cfg

@@ -17,6 +17,10 @@ classifiers =
 packages = find:
 python_requires = >=3.7
 
+[options.entry_points]
+console_scripts =
+    conventional-pre-commit = conventional_pre_commit.hook:main
+
 [options.packages.find]
 exclude =
     tests*

tests/test_hook.py

@@ -1,6 +1,15 @@
+import subprocess
+
+import pytest
+
 from conventional_pre_commit.hook import RESULT_SUCCESS, RESULT_FAIL, main
 
 
+@pytest.fixture
+def cmd():
+    return "conventional-pre-commit"
+
+
 def test_main_fail__missing_args():
     result = main()
 
@@ -35,3 +44,39 @@ def test_main_success__custom_conventional(conventional_commit_path):
     result = main(["custom", conventional_commit_path])
 
     assert result == RESULT_SUCCESS
+
+
+def test_subprocess_fail__missing_args(cmd):
+    result = subprocess.call(cmd)
+
+    assert result == RESULT_FAIL
+
+
+def test_subprocess_fail__bad(cmd, bad_commit_path):
+    result = subprocess.call((cmd, bad_commit_path))
+
+    assert result == RESULT_FAIL
+
+
+def test_subprocess_fail__custom(cmd, bad_commit_path):
+    result = subprocess.call((cmd, "custom", bad_commit_path))
+
+    assert result == RESULT_FAIL
+
+
+def test_subprocess_success__conventional(cmd, conventional_commit_path):
+    result = subprocess.call((cmd, conventional_commit_path))
+
+    assert result == RESULT_SUCCESS
+
+
+def test_subprocess_success__custom(cmd, custom_commit_path):
+    result = subprocess.call((cmd, "custom", custom_commit_path))
+
+    assert result == RESULT_SUCCESS
+
+
+def test_subprocess_success__custom_conventional(cmd, conventional_commit_path):
+    result = subprocess.call((cmd, "custom", conventional_commit_path))
+
+    assert result == RESULT_SUCCESS