Fix optional scope not respected when using --scopes flag (#113)

Author: thekaveman

conventional_pre_commit/format.py

@@ -39,7 +39,10 @@ def r_scope(optional=True, scopes: Optional[List[str]] = None):
 
     if scopes:
         scopes_pattern = _get_scope_pattern(scopes)
-        return scopes_pattern
+        if optional:
+            return f"(?:{scopes_pattern})?"
+        else:
+            return scopes_pattern
 
     if optional:
         return r"(\([\w \/:,-]+\))?"

tests/test_format.py

@@ -66,7 +66,7 @@ def test_r_scope__special_chars():
 
 def test_r_scope__scopes():
     scopes_input = ["api", "client"]
-    result = format.r_scope(scopes=scopes_input)
+    result = format.r_scope(scopes=scopes_input, optional=False)
     regex = re.compile(result)
     assert regex.match("(api)")
     assert regex.match("(client)")

tests/test_hook.py

@@ -152,6 +152,36 @@ def test_subprocess_fail__conventional_with_multiple_scopes(cmd, conventional_co
     assert result == RESULT_FAIL
 
 
+def test_main_success__custom_scopes_optional_scope(conventional_commit_path):
+    result = main(["--scopes", "api,client", conventional_commit_path])
+    assert result == RESULT_SUCCESS
+
+
+def test_main_success__custom_scopes_with_allowed_scope(conventional_commit_with_multiple_scopes_path):
+    result = main(["--scopes", "chore,api,client", conventional_commit_with_multiple_scopes_path])
+    assert result == RESULT_SUCCESS
+
+
+def test_main_fail__custom_scopes_with_disallowed_scope(conventional_commit_with_scope_path):
+    result = main(["--scopes", "api,client", conventional_commit_with_scope_path])
+    assert result == RESULT_FAIL
+
+
+def test_main_fail__custom_scopes_require_scope_no_scope(conventional_commit_path):
+    result = main(["--scopes", "chore,feat,fix,custom", "--force-scope", conventional_commit_path])
+    assert result == RESULT_FAIL
+
+
+def test_main_success__custom_scopes_require_scope_with_allowed_scope(conventional_commit_with_scope_path):
+    result = main(["--scopes", "api,client,scope", "--force-scope", conventional_commit_with_scope_path])
+    assert result == RESULT_SUCCESS
+
+
+def test_main_fail__custom_scopes_require_scope_with_disallowed_scope(conventional_commit_with_scope_path):
+    result = main(["--scopes", "api,client", "--force-scope", conventional_commit_with_scope_path])
+    assert result == RESULT_FAIL
+
+
 def test_subprocess_success__fixup_commit(cmd, fixup_commit_path):
     result = subprocess.call((cmd, fixup_commit_path))