git-commit-msg-ai 2.1.2__tar.gz → 2.2.0__tar.gz

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-msg-ai
-Version: 2.1.2
+Version: 2.2.0
 Summary: AI-powered git commit message generator following Conventional Commits
 License: MIT License
         
@@ -125,6 +125,8 @@ The tool will:
 - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
 - **r** - exits without committing
 
+The tool automatically reads the current branch name and recent commit history and includes them in the request to the AI. This helps the AI match the commit style already established in the project. No configuration is required to enable this; see [Configuration](#configuration) to control how many recent commits are included.
+
 ## Commit message format
 
 Generated messages follow the Conventional Commits specification:
@@ -156,11 +158,11 @@ The set of optional commit types the AI may use can be customised through a conf
 
 ### Config file locations and precedence
 
-The tool checks the following locations in order, using the first one that defines a `types` list:
+The tool checks the following locations in order, using the first one that defines a given setting:
 
 1. **Project-level** — `pyproject.toml` walked up from the current working directory, under `[tool.git-commit-msg-ai]`
 2. **User-level** — `~/.git-commit-msg-ai.toml` in your home directory
-3. **Built-in defaults** — used when neither config file is present or neither defines `types`
+3. **Built-in defaults** — used when neither config file is present or neither defines the setting
 
 ### Config file formats
 
@@ -169,16 +171,20 @@ Project-level (`pyproject.toml`):
 ```toml
 [tool.git-commit-msg-ai]
 types = ["build", "ci", "docs", "perf", "refactor", "style", "test"]
+context_commits = 10  # include last 10 commits for context (default: 5)
 ```
 
 User-level (`~/.git-commit-msg-ai.toml`):
 
 ```toml
 types = ["build", "ci", "docs", "chore"]
+context_commits = 0  # disable commit context
 ```
 
 Setting `types = []` restricts the AI to only the three mandatory types (`feat`, `fix`, `revert`).
 
+`context_commits` controls how many recent commit messages are sent to the AI as context. The default is `5`. Set it to `0` to disable context entirely.
+
 ### Default optional types
 
 | Type | Purpose |

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/README.md

@@ -82,6 +82,8 @@ The tool will:
 - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
 - **r** - exits without committing
 
+The tool automatically reads the current branch name and recent commit history and includes them in the request to the AI. This helps the AI match the commit style already established in the project. No configuration is required to enable this; see [Configuration](#configuration) to control how many recent commits are included.
+
 ## Commit message format
 
 Generated messages follow the Conventional Commits specification:
@@ -113,11 +115,11 @@ The set of optional commit types the AI may use can be customised through a conf
 
 ### Config file locations and precedence
 
-The tool checks the following locations in order, using the first one that defines a `types` list:
+The tool checks the following locations in order, using the first one that defines a given setting:
 
 1. **Project-level** — `pyproject.toml` walked up from the current working directory, under `[tool.git-commit-msg-ai]`
 2. **User-level** — `~/.git-commit-msg-ai.toml` in your home directory
-3. **Built-in defaults** — used when neither config file is present or neither defines `types`
+3. **Built-in defaults** — used when neither config file is present or neither defines the setting
 
 ### Config file formats
 
@@ -126,16 +128,20 @@ Project-level (`pyproject.toml`):
 ```toml
 [tool.git-commit-msg-ai]
 types = ["build", "ci", "docs", "perf", "refactor", "style", "test"]
+context_commits = 10  # include last 10 commits for context (default: 5)
 ```
 
 User-level (`~/.git-commit-msg-ai.toml`):
 
 ```toml
 types = ["build", "ci", "docs", "chore"]
+context_commits = 0  # disable commit context
 ```
 
 Setting `types = []` restricts the AI to only the three mandatory types (`feat`, `fix`, `revert`).
 
+`context_commits` controls how many recent commit messages are sent to the AI as context. The default is `5`. Set it to `0` to disable context entirely.
+
 ### Default optional types
 
 | Type | Purpose |

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/git_commit_msg_ai/ai_client.py

@@ -27,16 +27,36 @@ def _build_system_prompt(types: tuple[str, ...]) -> list[TextBlockParam]:
     return [TextBlockParam(type="text", text=text, cache_control=CacheControlEphemeralParam(type="ephemeral"))]
 
 
-def generate_commit_message(diff: str, types: tuple[str, ...]) -> str:
+def _build_user_message(diff: str, recent_commits: list[str] | None, branch_name: str | None) -> str:
+    parts: list[str] = []
+    if branch_name:
+        parts.append(f"Branch: {branch_name}")
+    if recent_commits:
+        commit_lines = ["Recent commits (most recent first):"] + [f"- {commit}" for commit in recent_commits]
+        parts.append("\n".join(commit_lines))
+    if parts:
+        parts.append("\n".join(["Staged diff:", diff]))
+        return "\n\n".join(parts)
+    return diff
+
+
+def generate_commit_message(
+    diff: str,
+    types: tuple[str, ...],
+    *,
+    recent_commits: list[str] | None = None,
+    branch_name: str | None = None,
+) -> str:
     try:
         anthropic_client = anthropic.Anthropic()
 
+        user_message = _build_user_message(diff, recent_commits, branch_name)
         logger.debug(f"Calling Anthropic API: model={MODEL} max_tokens={MAX_TOKENS}")
         anthropic_api_response = anthropic_client.messages.create(
             model=MODEL,
             max_tokens=MAX_TOKENS,
             system=_build_system_prompt(types),
-            messages=[{"role": "user", "content": diff}],
+            messages=[{"role": "user", "content": user_message}],
         )
     except anthropic.AuthenticationError:
         raise AIError("Anthropic API key is missing or invalid. Set the ANTHROPIC_API_KEY environment variable.")

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/git_commit_msg_ai/cli.py

@@ -24,12 +24,13 @@ def main() -> None:
 
     logging.basicConfig(level=effective_log_level, format=LOG_FORMAT, stream=sys.stderr)
 
-    optional_types = config.load_optional_types()
-    all_types = config.get_all_types(optional_types)
+    app_config = config.load_config()
 
     try:
         diff = git_ops.get_staged_diff()
-        commit_message = ai_client.generate_commit_message(diff, all_types)
+        recent_commits = git_ops.get_recent_commit_messages(app_config.context_commits)
+        branch_name = git_ops.get_branch_name()
+        commit_message = ai_client.generate_commit_message(diff, app_config.types, recent_commits=recent_commits, branch_name=branch_name)
         print(commit_message)
 
         print()

git_commit_msg_ai-2.2.0/git_commit_msg_ai/config.py

@@ -0,0 +1,142 @@
+import logging
+import tomllib
+from dataclasses import dataclass
+from pathlib import Path
+from typing import Any, Final, cast
+
+logger = logging.getLogger(__name__)
+
+MANDATORY_TYPES: Final[tuple[str, ...]] = ("feat", "fix", "revert")
+DEFAULT_OPTIONAL_TYPES: Final[tuple[str, ...]] = ("build", "ci", "docs", "perf", "refactor", "style", "test")
+CONTEXT_COMMITS_DEFAULT: Final[int] = 5
+
+
+@dataclass(frozen=True)
+class AppConfig:
+    types: tuple[str, ...]
+    context_commits: int
+
+
+def _find_pyproject_toml() -> Path | None:
+    for directory in [Path.cwd(), *Path.cwd().parents]:
+        candidate = directory / "pyproject.toml"
+        if candidate.is_file():
+            return candidate
+
+    return None
+
+
+def _parse_types_list(types_value: object, source: str) -> tuple[str, ...] | None:
+    if types_value is None:
+        return None
+    if not isinstance(types_value, list):
+        logger.warning(f"'types' in {source} must be a TOML array, skipping")
+        return None
+
+    entries = cast(list[object], types_value)
+    return tuple(entry.strip().lower() for entry in entries if isinstance(entry, str) and entry.strip())
+
+
+def _parse_context_commits(value: object, source: str) -> int | None:
+    if value is None:
+        return None
+    if isinstance(value, bool) or not isinstance(value, int):
+        logger.warning(f"'context_commits' in {source} must be an integer, skipping")
+        return None
+    return max(0, value)
+
+
+def _read_pkg_section_from_pyproject_toml(path: Path) -> dict[str, object] | None:
+    try:
+        with open(path, "rb") as toml_file:
+            data = tomllib.load(toml_file)
+    except tomllib.TOMLDecodeError:
+        logger.warning(f"Could not parse {path}, trying next config source")
+        return None
+
+    tool_section = data.get("tool")
+    if not isinstance(tool_section, dict):
+        return None
+
+    pkg_section = cast(dict[str, object], tool_section).get("git-commit-msg-ai")
+    return cast(dict[str, object], pkg_section) if isinstance(pkg_section, dict) else None
+
+
+def _read_global_config_data() -> dict[str, Any] | None:
+    path = Path.home() / ".git-commit-msg-ai.toml"
+    if not path.is_file():
+        return None
+
+    try:
+        with open(path, "rb") as toml_file:
+            return tomllib.load(toml_file)
+    except tomllib.TOMLDecodeError:
+        logger.warning(f"Could not parse {path}, using defaults")
+        return None
+
+
+def _load_types_from_pyproject_toml(path: Path) -> tuple[str, ...] | None:
+    section = _read_pkg_section_from_pyproject_toml(path)
+    if section is None:
+        return None
+    return _parse_types_list(section.get("types"), f"[tool.git-commit-msg-ai] in {path}")
+
+
+def _load_types_from_global_config() -> tuple[str, ...] | None:
+    data = _read_global_config_data()
+    if data is None:
+        return None
+    return _parse_types_list(data.get("types"), str(Path.home() / ".git-commit-msg-ai.toml"))
+
+
+def _load_context_commits_from_pyproject_toml(path: Path) -> int | None:
+    section = _read_pkg_section_from_pyproject_toml(path)
+    if section is None:
+        return None
+    return _parse_context_commits(section.get("context_commits"), f"[tool.git-commit-msg-ai] in {path}")
+
+
+def _load_context_commits_from_global_config() -> int | None:
+    data = _read_global_config_data()
+    if data is None:
+        return None
+    return _parse_context_commits(data.get("context_commits"), str(Path.home() / ".git-commit-msg-ai.toml"))
+
+
+def load_optional_types() -> tuple[str, ...]:
+    pyproject_path = _find_pyproject_toml()
+    if pyproject_path is not None:
+        result = _load_types_from_pyproject_toml(pyproject_path)
+        if result is not None:
+            return result
+
+    result = _load_types_from_global_config()
+    if result is not None:
+        return result
+
+    return DEFAULT_OPTIONAL_TYPES
+
+
+def load_context_commits() -> int:
+    pyproject_path = _find_pyproject_toml()
+    if pyproject_path is not None:
+        result = _load_context_commits_from_pyproject_toml(pyproject_path)
+        if result is not None:
+            return result
+
+    result = _load_context_commits_from_global_config()
+    if result is not None:
+        return result
+
+    return CONTEXT_COMMITS_DEFAULT
+
+
+def load_config() -> AppConfig:
+    return AppConfig(
+        types=get_all_types(load_optional_types()),
+        context_commits=load_context_commits(),
+    )
+
+
+def get_all_types(optional_types: tuple[str, ...]) -> tuple[str, ...]:
+    return tuple(dict.fromkeys(MANDATORY_TYPES + optional_types))

git_commit_msg_ai-2.2.0/git_commit_msg_ai/git_ops.py

@@ -0,0 +1,62 @@
+import logging
+import subprocess
+
+from git_commit_msg_ai.exceptions import GitError
+
+logger = logging.getLogger(__name__)
+
+
+def get_staged_diff() -> str:
+    try:
+        logger.debug("Running: git diff --cached")
+        raw_diff_bytes = subprocess.check_output(["git", "diff", "--cached"])
+        staged_diff = raw_diff_bytes.decode("utf-8")
+    except FileNotFoundError:
+        raise GitError("git is not installed or not on PATH.")
+    except subprocess.CalledProcessError:
+        raise GitError("Failed to get staged diff. Are you inside a git repository?")
+    except UnicodeDecodeError:
+        raise GitError("Staged diff contains bytes that could not be decoded as UTF-8.")
+
+    logger.debug(f"Staged diff received: {len(staged_diff)} chars")
+
+    if not staged_diff:
+        raise GitError("No staged changes found. Stage files with git add before running.")
+
+    return staged_diff
+
+
+def get_recent_commit_messages(n: int) -> list[str]:
+    if n <= 0:
+        return []
+    try:
+        logger.debug(f"Running: git log --format=%s -n {n}")
+        raw_git_log_bytes = subprocess.check_output(["git", "log", "--format=%s", f"-n{n}"])
+        commit_message_lines = raw_git_log_bytes.decode("utf-8").splitlines()
+        return [commit_message for commit_message in commit_message_lines if commit_message.strip()]
+    except Exception:
+        logger.debug("Could not retrieve recent commit messages; proceeding without context")
+        return []
+
+
+def get_branch_name() -> str | None:
+    try:
+        logger.debug("Running: git rev-parse --abbrev-ref HEAD")
+        raw_branch_name_bytes = subprocess.check_output(["git", "rev-parse", "--abbrev-ref", "HEAD"])
+        branch_name = raw_branch_name_bytes.decode("utf-8").strip()
+        return branch_name if branch_name != "HEAD" else None
+    except Exception:
+        logger.debug("Could not retrieve branch name; proceeding without context")
+        return None
+
+
+def commit(message: str) -> None:
+    try:
+        logger.debug("Running: git commit -m <message>")
+        subprocess.run(["git", "commit", "-m", message], check=True)
+    except FileNotFoundError:
+        raise GitError("git is not installed or not on PATH.")
+    except subprocess.CalledProcessError:
+        raise GitError("git commit failed.")
+
+    logger.info("Commit created successfully")

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/git_commit_msg_ai.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-msg-ai
-Version: 2.1.2
+Version: 2.2.0
 Summary: AI-powered git commit message generator following Conventional Commits
 License: MIT License
         
@@ -125,6 +125,8 @@ The tool will:
 - **e** - opens the message in your `$EDITOR` (defaults to `notepad` on Windows, `vi` on Linux/macOS), lets you modify it, then commits
 - **r** - exits without committing
 
+The tool automatically reads the current branch name and recent commit history and includes them in the request to the AI. This helps the AI match the commit style already established in the project. No configuration is required to enable this; see [Configuration](#configuration) to control how many recent commits are included.
+
 ## Commit message format
 
 Generated messages follow the Conventional Commits specification:
@@ -156,11 +158,11 @@ The set of optional commit types the AI may use can be customised through a conf
 
 ### Config file locations and precedence
 
-The tool checks the following locations in order, using the first one that defines a `types` list:
+The tool checks the following locations in order, using the first one that defines a given setting:
 
 1. **Project-level** — `pyproject.toml` walked up from the current working directory, under `[tool.git-commit-msg-ai]`
 2. **User-level** — `~/.git-commit-msg-ai.toml` in your home directory
-3. **Built-in defaults** — used when neither config file is present or neither defines `types`
+3. **Built-in defaults** — used when neither config file is present or neither defines the setting
 
 ### Config file formats
 
@@ -169,16 +171,20 @@ Project-level (`pyproject.toml`):
 ```toml
 [tool.git-commit-msg-ai]
 types = ["build", "ci", "docs", "perf", "refactor", "style", "test"]
+context_commits = 10  # include last 10 commits for context (default: 5)
 ```
 
 User-level (`~/.git-commit-msg-ai.toml`):
 
 ```toml
 types = ["build", "ci", "docs", "chore"]
+context_commits = 0  # disable commit context
 ```
 
 Setting `types = []` restricts the AI to only the three mandatory types (`feat`, `fix`, `revert`).
 
+`context_commits` controls how many recent commit messages are sent to the AI as context. The default is `5`. Set it to `0` to disable context entirely.
+
 ### Default optional types
 
 | Type | Purpose |

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "git-commit-msg-ai"
-version = "2.1.2"
+version = "2.2.0"
 description = "AI-powered git commit message generator following Conventional Commits"
 readme = "README.md"
 license = {file = "LICENSE"}

{git_commit_msg_ai-2.1.2 → git_commit_msg_ai-2.2.0}/tests/test_ai_client.py

@@ -1,4 +1,5 @@
 from contextlib import ExitStack
+from typing import Any
 from unittest.mock import MagicMock, patch
 
 import anthropic
@@ -105,7 +106,7 @@ class TestGenerateCommitMessage:
 
             generate_commit_message("diff", ("feat", "fix", "chore"))
 
-        system_param = mock_client.messages.create.call_args.kwargs["system"]
+        system_param: list[Any] = mock_client.messages.create.call_args.kwargs["system"]
 
         assert isinstance(system_param, list)
         assert len(system_param) == 1
@@ -113,3 +114,63 @@ class TestGenerateCommitMessage:
         assert block["type"] == "text"
         assert block["cache_control"] == {"type": "ephemeral"}
         assert "feat, fix, chore" in block["text"]
+
+    def test_generate_commit_message_without_context_sends_raw_diff(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.return_value = _make_api_response("feat: add feature")
+            mock_anthropic_class.return_value = mock_client
+
+            generate_commit_message("diff content", TYPES)
+
+        user_content = mock_client.messages.create.call_args.kwargs["messages"][0]["content"]
+
+        assert user_content == "diff content"
+
+    def test_generate_commit_message_with_recent_commits_includes_them_in_user_message(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.return_value = _make_api_response("feat: add feature")
+            mock_anthropic_class.return_value = mock_client
+
+            generate_commit_message(
+                "diff content",
+                TYPES,
+                recent_commits=["feat: first commit", "fix: second commit"],
+            )
+
+        user_content = mock_client.messages.create.call_args.kwargs["messages"][0]["content"]
+
+        assert "feat: first commit" in user_content
+        assert "fix: second commit" in user_content
+        assert "Recent commits" in user_content
+        assert "Staged diff:" in user_content
+
+    def test_generate_commit_message_with_branch_name_includes_it_in_user_message(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.return_value = _make_api_response("feat: add feature")
+            mock_anthropic_class.return_value = mock_client
+
+            generate_commit_message("diff content", TYPES, branch_name="feature/oauth-login")
+
+        user_content = mock_client.messages.create.call_args.kwargs["messages"][0]["content"]
+
+        assert "Branch: feature/oauth-login" in user_content
+        assert "Staged diff:" in user_content
+
+    def test_generate_commit_message_with_empty_recent_commits_sends_raw_diff(self) -> None:
+        with ExitStack() as stack:
+            mock_anthropic_class = stack.enter_context(patch("git_commit_msg_ai.ai_client.anthropic.Anthropic"))
+            mock_client = MagicMock()
+            mock_client.messages.create.return_value = _make_api_response("feat: add feature")
+            mock_anthropic_class.return_value = mock_client
+
+            generate_commit_message("diff content", TYPES, recent_commits=[])
+
+        user_content = mock_client.messages.create.call_args.kwargs["messages"][0]["content"]
+
+        assert user_content == "diff content"