git-commit-msg-ai 2.0.0__py3-none-any.whl → 2.1.0__py3-none-any.whl

git_commit_msg_ai/ai_client.py

@@ -3,24 +3,31 @@ import textwrap
 from typing import Final
 
 import anthropic
+from anthropic.types import CacheControlEphemeralParam, TextBlockParam
 
 from git_commit_msg_ai.exceptions import AIError
 
 logger = logging.getLogger(__name__)
 
-SYSTEM_PROMPT: Final[str] = textwrap.dedent("""\
-    You are a Git commit message generator. Output only the commit message, nothing else. Follow the Conventional Commits specification:
-    - First line: <type>(<optional scope>)<!>: <short subject> (50 chars max); append ! before the colon if the commit introduces a breaking change
-    - Blank line
-    - Bullet-point body explaining WHY the changes were made, not what
-    - If there is a breaking change, add a blank line after the body followed by "BREAKING CHANGE: <description of what breaks and why>
-    Types: feat, fix, docs, style, refactor, test, chore""")
+MODEL: Final[str] = "claude-sonnet-4-6"
+MAX_TOKENS: Final[int] = 1024  # generous ceiling for any Conventional Commit message; caps API cost and output length
 
-MODEL: Final[str] = "claude-haiku-4-5-20251001"
-MAX_TOKENS: Final[int] = 1024
 
+def _build_system_prompt(types: tuple[str, ...]) -> list[TextBlockParam]:
+    types_str = ", ".join(types)
 
-def generate_commit_message(diff: str) -> str:
+    text = textwrap.dedent(f"""\
+        You are a Git commit message generator. Output only the commit message, nothing else. Follow the Conventional Commits specification:
+        - First line: <type>(<optional scope>)<!>: <short subject> (50 chars max); append ! before the colon if the commit introduces a breaking change
+        - Blank line
+        - Bullet-point body explaining WHY the changes were made, not what
+        - If there is a breaking change, add a blank line after the body followed by "BREAKING CHANGE: <description of what breaks and why>
+        - For revert commits: begin the first line with "revert: " followed by the header of the reverted commit; the body must contain "This reverts commit <hash>." where <hash> is the SHA of the reverted commit
+        Types: {types_str}""")
+    return [TextBlockParam(type="text", text=text, cache_control=CacheControlEphemeralParam(type="ephemeral"))]
+
+
+def generate_commit_message(diff: str, types: tuple[str, ...]) -> str:
     try:
         anthropic_client = anthropic.Anthropic()
 
@@ -28,7 +35,7 @@ def generate_commit_message(diff: str) -> str:
         anthropic_api_response = anthropic_client.messages.create(
             model=MODEL,
             max_tokens=MAX_TOKENS,
-            system=SYSTEM_PROMPT,
+            system=_build_system_prompt(types),
             messages=[{"role": "user", "content": diff}],
         )
     except anthropic.AuthenticationError:

git_commit_msg_ai/cli.py

@@ -3,19 +3,14 @@ import os
 import sys
 from typing import Final
 
-from git_commit_msg_ai import ai_client, editor, git_ops
+from git_commit_msg_ai import ai_client, config, editor, git_ops
 from git_commit_msg_ai.exceptions import GitCommitAIError
 
 LOG_LEVEL_ENVIRONMENT_VARIABLE: Final[str] = "GIT_COMMIT_AI_LOG_LEVEL"
 DEFAULT_LOG_LEVEL: Final[str] = "WARNING"
 LOG_FORMAT: Final[str] = "%(levelname)s:%(name)s:%(message)s"
-SELECTION_PROMPT: Final[str] = "[a]ccept / [e]dit / [r]eject: "
-SELECTION_ACCEPT: Final[str] = "a"
-SELECTION_EDIT: Final[str] = "e"
-SELECTION_REJECT: Final[str] = "r"
-REJECTED_MESSAGE: Final[str] = "User rejected the generated commit message. No commit made."
-INVALID_SELECTION_MESSAGE: Final[str] = "Invalid selection."
-ABORTED_MESSAGE: Final[str] = "Aborted."
+
+logger = logging.getLogger(__name__)
 
 
 def main() -> None:
@@ -29,29 +24,33 @@ 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)
+
     try:
         diff = git_ops.get_staged_diff()
-        commit_message = ai_client.generate_commit_message(diff)
+        commit_message = ai_client.generate_commit_message(diff, all_types)
         print(commit_message)
 
         print()
-        user_selection = input(SELECTION_PROMPT).strip().lower()
+        user_selection = input("[a]ccept / [e]dit / [r]eject: ").strip().lower()
 
-        if user_selection == SELECTION_ACCEPT:
+        if user_selection == "a":
             git_ops.commit(commit_message)
-        elif user_selection == SELECTION_EDIT:
+        elif user_selection == "e":
             updated_commit_message = editor.open_in_editor(commit_message)
             git_ops.commit(updated_commit_message)
-        elif user_selection == SELECTION_REJECT:
-            print(REJECTED_MESSAGE)
+        elif user_selection == "r":
+            print("User rejected the generated commit message. No commit made.")
         else:
-            print(INVALID_SELECTION_MESSAGE)
+            print("Invalid selection.")
             sys.exit(1)
     except GitCommitAIError as error:
-        logging.error(str(error))
+        logger.error(str(error))
+        print(f"Error: {error}", file=sys.stderr)
         sys.exit(1)
     except KeyboardInterrupt, EOFError:
-        print(ABORTED_MESSAGE)
+        print("Aborted.")
         sys.exit(1)
 
 

git_commit_msg_ai/config.py

@@ -0,0 +1,80 @@
+import logging
+import tomllib
+from pathlib import Path
+from typing import Final
+
+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")
+
+
+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
+
+    return tuple(entry.strip().lower() for entry in types_value if isinstance(entry, str) and entry.strip())
+
+
+def _load_from_pyproject_toml(path: Path) -> tuple[str, ...] | 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 = tool_section.get("git-commit-msg-ai")
+    if not isinstance(pkg_section, dict):
+        return None
+
+    return _parse_types_list(pkg_section.get("types"), f"[tool.git-commit-msg-ai] in {path}")
+
+
+def _load_from_global_config() -> tuple[str, ...] | None:
+    global_config = Path.home() / ".git-commit-msg-ai.toml"
+    if not global_config.is_file():
+        return None
+
+    try:
+        with open(global_config, "rb") as toml_file:
+            data = tomllib.load(toml_file)
+    except tomllib.TOMLDecodeError:
+        logger.warning(f"Could not parse {global_config}, using default commit types")
+        return None
+
+    return _parse_types_list(data.get("types"), str(global_config))
+
+
+def load_optional_types() -> tuple[str, ...]:
+    pyproject_path = _find_pyproject_toml()
+    if pyproject_path is not None:
+        result = _load_from_pyproject_toml(pyproject_path)
+        if result is not None:
+            return result
+
+    result = _load_from_global_config()
+    if result is not None:
+        return result
+
+    return DEFAULT_OPTIONAL_TYPES
+
+
+def get_all_types(optional_types: tuple[str, ...]) -> tuple[str, ...]:
+    return tuple(dict.fromkeys(MANDATORY_TYPES + optional_types))

{git_commit_msg_ai-2.0.0.dist-info → git_commit_msg_ai-2.1.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-msg-ai
-Version: 2.0.0
+Version: 2.1.0
 Summary: AI-powered git commit message generator following Conventional Commits
 License-Expression: MIT
 Requires-Python: >=3.14
@@ -112,7 +112,50 @@ feat(api)!: remove deprecated endpoint
 BREAKING CHANGE: /v1/legacy is no longer available
 ```
 
-Supported types: `feat`, `fix`, `docs`, `style`, `refactor`, `test`, `chore`
+Supported types: `feat`, `fix`, `revert`, `build`, `ci`, `docs`, `perf`, `refactor`, `style`, `test` (configurable — see [Configuration](#configuration))
+
+`revert` commits always follow this format: the subject line begins with `revert: ` followed by the header of the reverted commit, and the body must contain `This reverts commit <hash>.`
+
+## Configuration
+
+The set of optional commit types the AI may use can be customised through a config file. `feat`, `fix`, and `revert` are always included regardless of any configuration.
+
+### Config file locations and precedence
+
+The tool checks the following locations in order, using the first one that defines a `types` list:
+
+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`
+
+### Config file formats
+
+Project-level (`pyproject.toml`):
+
+```toml
+[tool.git-commit-msg-ai]
+types = ["build", "ci", "docs", "perf", "refactor", "style", "test"]
+```
+
+User-level (`~/.git-commit-msg-ai.toml`):
+
+```toml
+types = ["build", "ci", "docs", "chore"]
+```
+
+Setting `types = []` restricts the AI to only the three mandatory types (`feat`, `fix`, `revert`).
+
+### Default optional types
+
+| Type | Purpose |
+|---|---|
+| `build` | Changes to the build system or external dependencies |
+| `ci` | Changes to CI configuration files and scripts |
+| `docs` | Documentation-only changes |
+| `perf` | A code change that improves performance |
+| `refactor` | A code change that neither fixes a bug nor adds a feature |
+| `style` | Changes that do not affect the meaning of the code (whitespace, formatting) |
+| `test` | Adding missing tests or correcting existing tests |
 
 ## CI/CD
 
@@ -123,7 +166,7 @@ Pushing a version tag (e.g. `v1.5.2`) triggers the CD pipeline:
 1. Tests are re-run as a gate
 2. The tag version is verified to match the version in `pyproject.toml`
 3. The package is built and published to [PyPI](https://pypi.org/project/git-commit-msg-ai/)
-4. A GitHub Release is created with release notes generated by Claude Haiku from the commit log
+4. A GitHub Release is created with release notes generated by Claude Sonnet from the commit log
 
 **Releasing a new version:**
 
@@ -140,7 +183,7 @@ git push origin v1.5.2
 
 ## Debugging
 
-By default the tool produces no diagnostic output. To enable logging, set the `GIT_COMMIT_AI_LOG_LEVEL` environment variable before running the command. Logs are written to **stderr** and do not interfere with the generated commit message on **stdout**.
+When a failure occurs (git error, API error, editor error), the tool always prints an error message to **stderr**. Diagnostic logs are disabled by default; to enable them, set the `GIT_COMMIT_AI_LOG_LEVEL` environment variable before running the command. Both error messages and logs are written to **stderr** and do not interfere with the generated commit message on **stdout**.
 
 Valid values: `DEBUG`, `INFO`, `WARNING`, `ERROR`, `CRITICAL`
 

git_commit_msg_ai-2.1.0.dist-info/RECORD

@@ -0,0 +1,12 @@
+git_commit_msg_ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+git_commit_msg_ai/ai_client.py,sha256=7B4bBrh9ZSd-1uChccnK3KYPnk9tXs9gOez5ASC5P54,2836
+git_commit_msg_ai/cli.py,sha256=MzFQWHLAcheg7ldWwDQG05KcAQeIjlKtiEmcSKzvDUk,2049
+git_commit_msg_ai/config.py,sha256=auD_QRw-8ngRz2p1DT5L5G5riszegZItSasmczv5W2s,2523
+git_commit_msg_ai/editor.py,sha256=wW7TJ4zVvvN7ThLtrJthAf9FjdmIDTbBS7V5pIW490s,2143
+git_commit_msg_ai/exceptions.py,sha256=7Hwluf3zHMjs4lpGktWS-Lwgo8y_4Xbb1WqzPQHkkUA,352
+git_commit_msg_ai/git_ops.py,sha256=qZae4w3IEf3Lmf2T5oWItkgM0PrEYHCWr3TgBJLeecY,1387
+git_commit_msg_ai-2.1.0.dist-info/METADATA,sha256=tv8CnvgRuFz0UqVpjx-raiMG6LOFWt05kPNnHAUIURs,6110
+git_commit_msg_ai-2.1.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+git_commit_msg_ai-2.1.0.dist-info/entry_points.txt,sha256=KTu6wUhl0p3nf27k8L4vpSH_hpeRQpwzMPSmKv7K5Cs,65
+git_commit_msg_ai-2.1.0.dist-info/top_level.txt,sha256=XYQC2BXvrcREGKEG7sm9nbwO7ifqcUSVgU7SW8BTURs,18
+git_commit_msg_ai-2.1.0.dist-info/RECORD,,

git_commit_msg_ai-2.0.0.dist-info/RECORD

@@ -1,11 +0,0 @@
-git_commit_msg_ai/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-git_commit_msg_ai/ai_client.py,sha256=DktS01lI62kaIRW4SccdelpwFn3VSJ_YRjlO5_IQE6I,2238
-git_commit_msg_ai/cli.py,sha256=33N5IFgD_ENAfNTf3X4w4fsE9WyiV-qLneN5Lay7IdQ,2187
-git_commit_msg_ai/editor.py,sha256=wW7TJ4zVvvN7ThLtrJthAf9FjdmIDTbBS7V5pIW490s,2143
-git_commit_msg_ai/exceptions.py,sha256=7Hwluf3zHMjs4lpGktWS-Lwgo8y_4Xbb1WqzPQHkkUA,352
-git_commit_msg_ai/git_ops.py,sha256=qZae4w3IEf3Lmf2T5oWItkgM0PrEYHCWr3TgBJLeecY,1387
-git_commit_msg_ai-2.0.0.dist-info/METADATA,sha256=il4_uh_01x9ON1Dfz69-ExOB2a3z1gYRG4_z0DQy-MI,4226
-git_commit_msg_ai-2.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
-git_commit_msg_ai-2.0.0.dist-info/entry_points.txt,sha256=KTu6wUhl0p3nf27k8L4vpSH_hpeRQpwzMPSmKv7K5Cs,65
-git_commit_msg_ai-2.0.0.dist-info/top_level.txt,sha256=XYQC2BXvrcREGKEG7sm9nbwO7ifqcUSVgU7SW8BTURs,18
-git_commit_msg_ai-2.0.0.dist-info/RECORD,,