Updated documentation and added better debugging for v0.1.0 release

Author: dtaivpp

.pylintrc

@@ -1,5 +1,5 @@
-[pre-commit-hook]
-limit=8.0
+[MASTER]
+ignore=test
 
 [FORMAT]
 indent-string='  '

README.md

@@ -1,26 +1,49 @@
 # commit-msg-regex-hook
 
-Before the readme, big shoutout to @dimaka-wix who's repo [commit-msg-hook](https://github.com/dimaka-wix/commit-msg-hook) was the basis for this repository. Go check out his repo for more information. 
-
 This hook is designed to be used with the [pre-commit](https://pre-commit.com/) hook framework. It will check your commit string against the provided regex. 
 
-### Utilizing
 
-First you will need to setup [pre-commit](https://pre-commit.com/) using their documentation. Then you will be able to add this repository under it with the following:
+### Using the commit-msg-regex-hook
+
+First you will need to setup [pre-commit](https://pre-commit.com/) using their documentation. 
+
+Next you will need to enable commit message hooks: 
+`pre-commit install --hook-type commit-msg`
+
+Finally you can add this to your .pre-commit-config.yaml:
 
 ```
-- repo: https://github.com/dimaka-wix/commit-msg-hook.git
-  rev: v0.3.1
+- repo: https://github.com/dtaivpp/commit-msg-regex-hook
+  rev: v0.1.0
   hooks:
     - id: commit-msg-hook
       args: ["--pattern='[A-Z]{3,4}-[0-9]{3,6} \\| [\\w\\s]* \\| .+'"]
       stages: [commit-msg]
 ```
 
-**note the backslashes need to be escaped
+**note: the backslashes in regex need to be escaped need to be escaped
+**double note: if you are having issues you can run with the --debug argument as well for additional logging.  
 
-### To enable commit-msg hook with pre-commit run:
-`pre-commit install --hook-type commit-msg`
 
-### Update to the latest release (optional)
-`pre-commit autoupdate --repo https://github.com/dtaivpp/commit-msg-regex-hook.git`
+### Developing this project
+
+If you would like to contribute to this project I am happy to accept contributions. Small note I use two spaces for indents and am not looking to swap. 
+
+Here is how you can contribute: 
+
+1. Fork the repo
+2. Create a virtual envrionment `python -m venv venv`
+3. Activate the virtual environment:
+  - Windows: `venv\Scripts\activate`
+  - Mac/Linux: `source venv/bin/activate`
+4. Install the reqirements `python -m pip install -r requirements.txt`
+5. Install our hooks:
+  - `pre-commit install`
+
+And you are off to the races!
+
+Before committing I would reccomend checking your build against unittest and the linter. If it doesn't pass it wont pass! 
+- `python -m unittest test`
+- `python -m pylint commit_msg_regex_hook`
+
+Make sure if you add a check to add a test case!

commit_msg_regex_hook/commit_msg_regex_hook.py

@@ -7,8 +7,19 @@
 import sys
 import argparse
 import re
+import logging
 from typing import Pattern
 
+
+logger = logging.getLogger("__main__")
+logger.setLevel(logging.ERROR)
+consoleHandle = logging.StreamHandler()
+consoleHandle.setLevel(logging.DEBUG)
+formatter = logging.Formatter('%(asctime)s - %(levelname)s - %(message)s')
+consoleHandle.setFormatter(formatter)
+logger.addHandler(consoleHandle)
+
+
 # Default commit message path
 COMMIT_EDITMSG = ".git/COMMIT_EDITMSG"
 PASS=True
@@ -23,45 +34,56 @@ def __init__(self, message, result):
     self.result = result
 
   def is_passing(self):
+    """Whether the result is a passing or failing result
+    """
     return self.result
 
 
 def main():
-    """Perform validations of the commit message.
-    Parse passed in regex and verify message matches
-    """
-    parser = argparse.ArgumentParser()
-    parser.add_argument("message", nargs="?", type=process_file, default=COMMIT_EDITMSG,
-                        help="File path for commit message")
-    parser.add_argument("--pattern", type=process_pattern)
-    parser.add_argument(
-      '--debug',
-      action='store_true', 
-      help='print debug messages to stdout'
-    )
+  """Perform validations of the commit message.
+  Parse passed in regex and verify message matches
+  """
+  parser = argparse.ArgumentParser()
+  parser.add_argument("message", nargs="?", type=process_file, default=COMMIT_EDITMSG,
+                      help="File path for commit message")
+  parser.add_argument("--pattern", type=process_pattern)
+  parser.add_argument(
+    '--debug',
+    action='store_true',
+    help='print debug messages to stdout'
+  )
+
+  args = parser.parse_args()
 
-    args = parser.parse_args()
+  if args.debug:
+    logger.setLevel(logging.DEBUG)
 
-    checks = [
-      message_not_empty(args.message),
-      message_pattern_match(args.message, args.pattern)
-    ]
+  checks = [
+    message_not_empty(args.message),
+    message_pattern_match(args.message, args.pattern)
+  ]
 
-    for check in checks:
-      result = check()
-      
-      if not result.is_passing():
-        print(f"Check Failed:\n {result.message}")
-        sys.exit(1)
+  run_checks(checks)
 
-      if args.debug:
-        print(result.message)
 
-    sys.exit(0)
+def run_checks(checks: list):
+  """Processs the checks and in the event of a failure
+  kill the commit
+  """
+  for check in checks:
+    result = check()
+
+    if not result.is_passing():
+      logger.error("Check Failed:\n {failure}", failure=result.message)
+      sys.exit(1)
+
+    logger.debug(result.message)
+
+  sys.exit(0)
 
 
 def process_file(path: str) -> str:
-  """Extract commit message.  
+  """Extract commit message.
 
   Args:
       path (str): The path of the file with commit message
@@ -71,8 +93,8 @@ def process_file(path: str) -> str:
   try:
     with open(path, "r", encoding="utf-8") as file:
       msg = file.read()
-  except FileNotFoundError:
-    raise argparse.ArgumentError(f"File does not exist: \n\t{path}")
+  except FileNotFoundError as file_not_found:
+    raise argparse.ArgumentTypeError(f"File does not exist: \n\t{path}") from file_not_found
 
   return msg
 
@@ -87,9 +109,9 @@ def process_pattern(str_pattern: str) -> Pattern:
   """
   try:
     pattern = re.compile(str_pattern[1:-1])
-  except Exception as e:
+  except Exception as err:
     raise argparse.ArgumentTypeError(
-      f"'{str_pattern}' is not a valid regex pattern\n {e}"
+      f"'{str_pattern}' is not a valid regex pattern\n {err}"
     )
 
   return pattern
@@ -99,22 +121,26 @@ def message_not_empty(message: str) -> Result:
   """Verify the commit message is not empty
   """
   def check():
+    logger.debug("Current Message: {message}", message=message)
+
     if len(message.strip()) == 0:
-      return Result(f"ֿError: commit message cannot be empty", FAIL)
-    
-    return Result(f"The commit message is not empty", PASS)
+      return Result("ֿError: commit message cannot be empty", FAIL)
+
+    return Result("The commit message is not empty", PASS)
   return check
 
 
-def message_pattern_match(msg: str, pattern: Pattern) -> Result:
+def message_pattern_match(message: str, pattern: Pattern) -> Result:
   """Verify the commit message matches the pattern
   """
   def check():
-    if not pattern.match(msg):
+    logger.debug("Pattern: {regex}\nMessage: {message}", regex=pattern, message=message)
+
+    if not pattern.match(message):
       # Fail the commit message
-      return Result(f"Commit Message does not match pattern\n\t{pattern}\n\t{msg}", FAIL)
-    
-    return Result(f"The commit message matches the regex", PASS)
+      return Result(f"Commit Message does not match pattern\n\t{pattern}\n\t{message}", FAIL)
+
+    return Result("The commit message matches the regex", PASS)
   return check
 
 

test/test.py

@@ -1,6 +1,9 @@
+"""Test suite for the project
+"""
+
 import re
 import unittest
-from src import commit_msg_regex_hook
+from commit_msg_regex_hook import commit_msg_regex_hook
 
 
 class TestMessageEmpty(unittest.TestCase):