feat(format): added scopes argument to specify valid scopes

Closes: #101

Author: mjspeck

conventional_pre_commit/format.py

@@ -1,4 +1,5 @@
 import re
+from typing import List, Optional
 
 CONVENTIONAL_TYPES = ["feat", "fix"]
 DEFAULT_TYPES = [
@@ -26,11 +27,23 @@ def r_types(types):
     return "|".join(types)
 
 
-def r_scope(optional=True):
+def r_scope(optional=True, scopes: Optional[List[str]] = None):
     """Regex str for an optional (scope)."""
+
     if optional:
+        if scopes:
+            scopes_str = r_types(scopes)
+            # delims_str = r_types([":", ",", "-"])
+            escaped_delimiters = list(map(re.escape, [":", ","]))  # type: ignore
+            delimiters_pattern = r_types(escaped_delimiters)
+            return rf"\(\s*(?:{scopes_str})(?:\s*(?:{delimiters_pattern})\s*(?:{scopes_str}))*\s*\)"
         return r"(\([\w \/:,-]+\))?"
     else:
+        if scopes:
+            scopes_str = r_types(scopes)
+            escaped_delimiters = list(map(re.escape, [":", ","]))  # type: ignore
+            delimiters_pattern = r_types(escaped_delimiters)
+            return rf"\(\s*(?:{scopes_str})(?:\s*(?:{delimiters_pattern})\s*(?:{scopes_str}))*\s*\)"
         return r"(\([\w \/:,-]+\))"
 
 
@@ -79,7 +92,7 @@ def conventional_types(types=[]):
     return types
 
 
-def is_conventional(input, types=DEFAULT_TYPES, optional_scope=True):
+def is_conventional(input, types=DEFAULT_TYPES, optional_scope=True, scopes: Optional[list[str]] = None):
     """
     Returns True if input matches Conventional Commits formatting
     https://www.conventionalcommits.org
@@ -89,7 +102,7 @@ def is_conventional(input, types=DEFAULT_TYPES, optional_scope=True):
     input = strip_verbose_diff(input)
     input = strip_comments(input)
     types = conventional_types(types)
-    pattern = f"^({r_types(types)}){r_scope(optional_scope)}{r_delim()}{r_subject()}{r_body()}"
+    pattern = f"^({r_types(types)}){r_scope(optional_scope, scopes=scopes)}{r_delim()}{r_subject()}{r_body()}"
     regex = re.compile(pattern, re.MULTILINE)
 
     result = regex.match(input)

conventional_pre_commit/hook.py

@@ -28,6 +28,7 @@ def main(argv=[]):
         action="store_true",
         help="Force commit to strictly follow Conventional Commits formatting. Disallows fixup! style commits.",
     )
+    parser.add_argument("scopes", type=str, nargs="*", default=None, help="Optional list of scopes to support")
 
     if len(argv) < 1:
         argv = sys.argv[1:]
@@ -56,7 +57,7 @@ def main(argv=[]):
         if format.has_autosquash_prefix(message):
             return RESULT_SUCCESS
 
-    if format.is_conventional(message, args.types, args.optional_scope):
+    if format.is_conventional(message, args.types, args.optional_scope, args.scopes):
         return RESULT_SUCCESS
     else:
         print(

tests/test_format.py

@@ -64,6 +64,18 @@ def test_r_scope__special_chars():
     assert regex.match("(some,thing)")
 
 
+def test_r_scope__scopes():
+    scopes_input = ["api", "client"]
+    result = format.r_scope(scopes=scopes_input)
+    regex = re.compile(result)
+    assert regex.match("(api)")
+    assert regex.match("(client)")
+    assert regex.match("(api, client)")
+    assert regex.match("(api: client)")
+    assert not regex.match("(test)")
+    assert not regex.match("(api; client)")
+
+
 def test_r_delim():
     result = format.r_delim()
     regex = re.compile(result)