chore: Add DEFAULT_COMMIT_TYPE env variable

Author: brtkwr

git_hooks/prepare_commit_msg.py

@@ -1,6 +1,7 @@
 """This hook prepares a commit message containing a reference to a Linear issue as well as a conventional commit type.
 It uses the branch name to determine the issue number and the commit message title as well as the conventional commit type.
 If LINEAR_API_KEY is set, it fetches the issue title and description from Linear and populates the commit message with it.
+If DEFAULT_COMMIT_TYPE is set, it uses that as the default commit type when none is detected (defaults to "feat").
 See https://www.conventionalcommits.org for examples of conventional commit types.
 """
 
@@ -16,6 +17,7 @@
 EDITOR_TEXT = "# Please enter the commit message for your changes."
 
 LINEAR_API_KEY = os.environ.get("LINEAR_API_KEY")
+DEFAULT_COMMIT_TYPE = os.environ.get("DEFAULT_COMMIT_TYPE", "feat")
 
 
 # Convert branch name to commit message
@@ -27,7 +29,7 @@ def branch_to_commit_msg(branch: str) -> str:
 def prefix_to_commit_type(prefix: str) -> str:
     if prefix_match := re.match(common.prefix_regex, prefix):
         return prefix_match.group(1)
-    return "fix"
+    return DEFAULT_COMMIT_TYPE
 
 
 def get_branch_name() -> str | None:
@@ -166,7 +168,7 @@ def prepare_commit_msg(raw_commit_msg: str, branch: str) -> str:
     commit_msg_title_data = extract_commit_msg_title_data(
         linear_data.get("commit_msg_title") or raw_commit_msg_title
     )
-    commit_type = commit_msg_title_data["commit_type"] or branch_data["commit_type"]
+    commit_type = commit_msg_title_data["commit_type"] or branch_data["commit_type"] or DEFAULT_COMMIT_TYPE
     commit_msg_title = (
         commit_msg_title_data["commit_msg_title"] or branch_data["commit_msg_title"]
     )

git_hooks/test_prepare_commit_msg.py

@@ -5,6 +5,8 @@
 from prepare_commit_msg import extract_commit_msg_title_data
 from prepare_commit_msg import get_branch_name
 from prepare_commit_msg import retrieve_linear_issue
+from prepare_commit_msg import prepare_commit_msg
+from prepare_commit_msg import prefix_to_commit_type
 from prepare_commit_msg import main
 
 from prepare_commit_msg import EDITOR_TEXT
@@ -98,6 +100,38 @@ def test_retrieve_linear_issue(mock_linear_client):
                 "commit_msg_title": "Branch title",
             },
         ),
+        (
+            "dae-75-design-spec-for-configurable-oidc-provider-for-merchants",
+            {
+                "issue": "DAE-75",
+                "commit_type": "",
+                "commit_msg_title": "Design spec for configurable oidc provider for merchants",
+            },
+        ),
+        (
+            "feat/dae-75-design-spec-for-configurable-oidc-provider-for-merchants",
+            {
+                "issue": "DAE-75",
+                "commit_type": "feat",
+                "commit_msg_title": "Design spec for configurable oidc provider for merchants",
+            },
+        ),
+        (
+            "fix/abc-123-very-long-branch-name-with-many-hyphens-and-words",
+            {
+                "issue": "ABC-123",
+                "commit_type": "fix",
+                "commit_msg_title": "Very long branch name with many hyphens and words",
+            },
+        ),
+        (
+            "hotfix/xyz-456-update-critical-security-vulnerability-in-auth-module",
+            {
+                "issue": "XYZ-456",
+                "commit_type": "hotfix",
+                "commit_msg_title": "Update critical security vulnerability in auth module",
+            },
+        ),
     ],
 )
 def test_extract_branch_data(branch, expected):
@@ -143,3 +177,93 @@ def test_extract_branch_data(branch, expected):
 )
 def test_extract_commit_msg_title_data(commit_msg_title, expected):
     assert extract_commit_msg_title_data(commit_msg_title) == expected
+
+
+@mock.patch("prepare_commit_msg.LINEAR_API_KEY", None)
+@pytest.mark.parametrize(
+    "raw_commit_msg, branch, expected_commit_msg",
+    [
+        (
+            "",
+            "dae-75-design-spec-for-configurable-oidc-provider-for-merchants",
+            "DAE-75/feat: Design spec for configurable oidc provider for merchants",
+        ),
+        (
+            "",
+            "feat/dae-75-design-spec-for-configurable-oidc-provider-for-merchants",
+            "DAE-75/feat: Design spec for configurable oidc provider for merchants",
+        ),
+        (
+            "",
+            "fix/abc-123-very-long-branch-name-with-many-hyphens-and-words",
+            "ABC-123/fix: Very long branch name with many hyphens and words",
+        ),
+        (
+            "",
+            "branch-without-issue",
+            "feat: Branch without issue",
+        ),
+    ],
+)
+def test_prepare_commit_msg_with_default_commit_type(raw_commit_msg, branch, expected_commit_msg):
+    result = prepare_commit_msg(raw_commit_msg, branch)
+    assert result == expected_commit_msg
+
+
+@mock.patch("prepare_commit_msg.LINEAR_API_KEY", None)
+@mock.patch("prepare_commit_msg.DEFAULT_COMMIT_TYPE", "fix")
+@pytest.mark.parametrize(
+    "raw_commit_msg, branch, expected_commit_msg",
+    [
+        (
+            "",
+            "dae-75-design-spec-for-configurable-oidc-provider-for-merchants",
+            "DAE-75/fix: Design spec for configurable oidc provider for merchants",
+        ),
+        (
+            "",
+            "abc-123-branch-without-prefix",
+            "ABC-123/fix: Branch without prefix",
+        ),
+        (
+            "",
+            "branch-without-issue",
+            "fix: Branch without issue",
+        ),
+    ],
+)
+def test_prepare_commit_msg_with_custom_default_commit_type(raw_commit_msg, branch, expected_commit_msg):
+    result = prepare_commit_msg(raw_commit_msg, branch)
+    assert result == expected_commit_msg
+
+
+@mock.patch("prepare_commit_msg.DEFAULT_COMMIT_TYPE", "feat")
+@pytest.mark.parametrize(
+    "prefix, expected",
+    [
+        ("feat", "feat"),
+        ("fix", "fix"),
+        ("chore", "chore"),
+        ("unknown", "feat"),  # Should fall back to DEFAULT_COMMIT_TYPE
+        ("invalid", "feat"),  # Should fall back to DEFAULT_COMMIT_TYPE
+    ],
+)
+def test_prefix_to_commit_type_with_default_feat(prefix, expected):
+    result = prefix_to_commit_type(prefix)
+    assert result == expected
+
+
+@mock.patch("prepare_commit_msg.DEFAULT_COMMIT_TYPE", "chore")
+@pytest.mark.parametrize(
+    "prefix, expected",
+    [
+        ("feat", "feat"),
+        ("fix", "fix"),
+        ("chore", "chore"),
+        ("unknown", "chore"),  # Should fall back to DEFAULT_COMMIT_TYPE
+        ("invalid", "chore"),  # Should fall back to DEFAULT_COMMIT_TYPE
+    ],
+)
+def test_prefix_to_commit_type_with_default_chore(prefix, expected):
+    result = prefix_to_commit_type(prefix)
+    assert result == expected