git-commit-message 0.8.0__tar.gz → 0.8.1__tar.gz

{git_commit_message-0.8.0 → git_commit_message-0.8.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-message
-Version: 0.8.0
+Version: 0.8.1
 Summary: Generate Git commit messages from staged changes using LLM
 Maintainer-email: Mina Her <minacle@live.com>
 License: This is free and unencumbered software released into the public domain.
@@ -58,7 +58,7 @@ Generate a commit message from your staged changes using OpenAI, Google Gemini,
 ## Requirements
 
 - Python 3.13+
-- A Git repo with staged changes (`git add ...`)
+- A Git repo with staged changes (`git add ...`) (or use `--amend` even if nothing is staged)
 
 ## Install
 
@@ -167,6 +167,19 @@ git-commit-message --commit "refactor parser for speed"
 git-commit-message --commit --edit "refactor parser for speed"
 ```
 
+Amend the previous commit:
+
+```sh
+# print only (useful for pasting into a GUI editor)
+git-commit-message --amend "optional context"
+
+# amend immediately
+git-commit-message --commit --amend "optional context"
+
+# amend immediately, but open editor for final tweaks
+git-commit-message --commit --amend --edit "optional context"
+```
+
 Limit subject length:
 
 ```sh
@@ -216,6 +229,7 @@ git-commit-message --provider ollama --host http://192.168.1.100:11434
 - `--chunk-tokens N`: token budget per diff chunk (`0` = single summary pass, `-1` disables summarisation)
 - `--debug`: print request/response details
 - `--commit`: run `git commit -m <message>`
+- `--amend`: generate a message suitable for amending the previous commit (diff is from the amended commit's parent to the staged index; if nothing is staged, this effectively becomes the diff introduced by `HEAD`)
 - `--edit`: with `--commit`, open editor for final message
 - `--host URL`: host URL for providers like Ollama (default: `http://localhost:11434`)
 

{git_commit_message-0.8.0 → git_commit_message-0.8.1}/README.md

@@ -7,7 +7,7 @@ Generate a commit message from your staged changes using OpenAI, Google Gemini,
 ## Requirements
 
 - Python 3.13+
-- A Git repo with staged changes (`git add ...`)
+- A Git repo with staged changes (`git add ...`) (or use `--amend` even if nothing is staged)
 
 ## Install
 
@@ -116,6 +116,19 @@ git-commit-message --commit "refactor parser for speed"
 git-commit-message --commit --edit "refactor parser for speed"
 ```
 
+Amend the previous commit:
+
+```sh
+# print only (useful for pasting into a GUI editor)
+git-commit-message --amend "optional context"
+
+# amend immediately
+git-commit-message --commit --amend "optional context"
+
+# amend immediately, but open editor for final tweaks
+git-commit-message --commit --amend --edit "optional context"
+```
+
 Limit subject length:
 
 ```sh
@@ -165,6 +178,7 @@ git-commit-message --provider ollama --host http://192.168.1.100:11434
 - `--chunk-tokens N`: token budget per diff chunk (`0` = single summary pass, `-1` disables summarisation)
 - `--debug`: print request/response details
 - `--commit`: run `git commit -m <message>`
+- `--amend`: generate a message suitable for amending the previous commit (diff is from the amended commit's parent to the staged index; if nothing is staged, this effectively becomes the diff introduced by `HEAD`)
 - `--edit`: with `--commit`, open editor for final message
 - `--host URL`: host URL for providers like Ollama (default: `http://localhost:11434`)
 

{git_commit_message-0.8.0 → git_commit_message-0.8.1}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "git-commit-message"
-version = "0.8.0"
+version = "0.8.1"
 description = "Generate Git commit messages from staged changes using LLM"
 readme = "README.md"
 requires-python = ">=3.13"

{git_commit_message-0.8.0 → git_commit_message-0.8.1}/src/git_commit_message/_cli.py

@@ -17,7 +17,9 @@ from ._git import (
     commit_with_message,
     get_repo_root,
     get_staged_diff,
+    has_head_commit,
     has_staged_changes,
+    resolve_amend_base_ref,
 )
 from ._llm import (
     CommitMessageResult,
@@ -31,6 +33,7 @@ class CliArgs(Namespace):
     __slots__ = (
         "description",
         "commit",
+        "amend",
         "edit",
         "provider",
         "model",
@@ -48,6 +51,7 @@ class CliArgs(Namespace):
     ) -> None:
         self.description: str | None = None
         self.commit: bool = False
+        self.amend: bool = False
         self.edit: bool = False
         self.provider: str | None = None
         self.model: str | None = None
@@ -99,6 +103,16 @@ def _build_parser() -> ArgumentParser:
         help="Commit immediately with the generated message.",
     )
 
+    parser.add_argument(
+        "--amend",
+        action="store_true",
+        help=(
+            "Generate a message suitable for amending the previous commit. "
+            "When set, the diff is computed from the amended commit's parent to the staged index. "
+            "Use with '--commit' to run the amend, or omit '--commit' to print the message only."
+        ),
+    )
+
     parser.add_argument(
         "--edit",
         action="store_true",
@@ -198,11 +212,19 @@ def _run(
 
     repo_root: Path = get_repo_root()
 
-    if not has_staged_changes(repo_root):
-        print("No staged changes. Run 'git add' and try again.", file=stderr)
-        return 2
+    if args.amend:
+        if not has_head_commit(repo_root):
+            print("Cannot amend: the repository has no commits yet.", file=stderr)
+            return 2
+
+        base_ref = resolve_amend_base_ref(repo_root)
+        diff_text: str = get_staged_diff(repo_root, base_ref=base_ref)
+    else:
+        if not has_staged_changes(repo_root):
+            print("No staged changes. Run 'git add' and try again.", file=stderr)
+            return 2
 
-    diff_text: str = get_staged_diff(repo_root)
+        diff_text = get_staged_diff(repo_root)
 
     hint: str | None = args.description if isinstance(args.description, str) else None
 
@@ -299,9 +321,9 @@ def _run(
         print(message)
 
     if args.edit:
-        rc: int = commit_with_message(message, True, repo_root)
+        rc: int = commit_with_message(message, True, repo_root, amend=args.amend)
     else:
-        rc = commit_with_message(message, False, repo_root)
+        rc = commit_with_message(message, False, repo_root, amend=args.amend)
 
     return rc
 

git_commit_message-0.8.1/src/git_commit_message/_git.py

@@ -0,0 +1,269 @@
+"""Git-related helper functions.
+
+Provides repository root discovery, extraction of staged changes, and
+creating commits from a message.
+"""
+
+from __future__ import annotations
+
+from pathlib import Path
+from subprocess import CalledProcessError, check_call, check_output, run
+
+
+def _get_empty_tree_hash(
+    cwd: Path,
+    /,
+) -> str:
+    """Return the empty tree hash for this repository.
+
+    Parameters
+    ----------
+    cwd
+        Repository directory in which to run Git.
+
+    Notes
+    -----
+    Do not hard-code the SHA, because repositories may use different
+    hash algorithms (e.g. SHA-1 vs SHA-256). We ask Git to compute the
+    empty tree object ID for the current repo.
+
+    Returns
+    -------
+    str
+        The empty tree object ID for the current repository.
+    """
+
+    try:
+        completed = run(
+            [
+                "git",
+                "hash-object",
+                "-t",
+                "tree",
+                "--stdin",
+            ],
+            cwd=str(cwd),
+            check=True,
+            input=b"",
+            capture_output=True,
+        )
+    except CalledProcessError as exc:
+        stderr_text = (exc.stderr or b"").decode(errors="replace").strip()
+        suffix = f"\nGit stderr: {stderr_text}" if stderr_text else ""
+        raise RuntimeError(
+            f"Failed to compute empty tree hash (git exited with {exc.returncode}).{suffix}"
+        ) from exc
+    except OSError as exc:
+        raise RuntimeError(
+            f"Failed to run git to compute empty tree hash: {exc}"
+        ) from exc
+    oid = completed.stdout.decode().strip()
+    if not oid:
+        raise RuntimeError(
+            "Failed to compute empty tree hash: git returned an empty object ID."
+        )
+    return oid
+
+
+def get_repo_root(
+    cwd: Path | None = None,
+    /,
+) -> Path:
+    """Find the repository root from the current working directory.
+
+    Parameters
+    ----------
+    cwd
+        Starting directory for the search. Defaults to the current working directory.
+
+    Returns
+    -------
+    Path
+        The repository root path.
+    """
+
+    start: Path = cwd or Path.cwd()
+    try:
+        out: bytes = check_output(
+            [
+                "git",
+                "rev-parse",
+                "--show-toplevel",
+            ],
+            cwd=str(start),
+        )
+    except CalledProcessError as exc:  # noqa: TRY003
+        raise RuntimeError("Not a Git repository.") from exc
+
+    root = Path(out.decode().strip())
+    return root
+
+
+def has_staged_changes(
+    cwd: Path,
+    /,
+) -> bool:
+    """Check whether there are staged changes."""
+
+    try:
+        check_call(
+            ["git", "diff", "--cached", "--quiet", "--exit-code"],
+            cwd=str(cwd),
+        )
+        return False
+    except CalledProcessError:
+        return True
+
+
+def has_head_commit(
+    cwd: Path,
+    /,
+) -> bool:
+    """Return True if the repository has at least one commit (HEAD exists).
+
+    Parameters
+    ----------
+    cwd
+        Repository directory in which to run Git.
+
+    Returns
+    -------
+    bool
+        True if ``HEAD`` exists in the repository, False otherwise.
+    """
+
+    completed = run(
+        ["git", "rev-parse", "--verify", "HEAD"],
+        cwd=str(cwd),
+        check=False,
+        capture_output=True,
+    )
+    return completed.returncode == 0
+
+
+def resolve_amend_base_ref(
+    cwd: Path,
+    /,
+) -> str:
+    """Resolve the base ref for an amend diff.
+
+    Parameters
+    ----------
+    cwd
+        Repository directory in which to run Git.
+
+    Notes
+    -----
+    The amended commit keeps the same parent as the current HEAD commit.
+
+    - If HEAD has a parent, base is ``HEAD^``.
+    - If HEAD is a root commit (no parent), base is the empty tree.
+
+    Returns
+    -------
+    str
+        The base reference for the amend diff: either ``HEAD^`` (when the
+        current ``HEAD`` commit has a parent) or the empty tree object ID
+        (when ``HEAD`` is a root commit).
+    """
+
+    completed = run(
+        ["git", "rev-parse", "--verify", "HEAD^"],
+        cwd=str(cwd),
+        check=False,
+        capture_output=True,
+    )
+    if completed.returncode == 0:
+        return "HEAD^"
+    return _get_empty_tree_hash(cwd)
+
+
+def get_staged_diff(
+    cwd: Path,
+    /,
+    *,
+    base_ref: str | None = None,
+) -> str:
+    """Return the staged changes as diff text.
+
+    Parameters
+    ----------
+    cwd
+        Git working directory.
+    base_ref
+        Optional Git reference or tree object ID (e.g., branch name, tag,
+        commit hash, or the empty tree hash) to diff against. When provided,
+        the diff shows changes from ``base_ref`` to the staged index, instead
+        of changes from ``HEAD`` to the staged index.
+
+    Returns
+    -------
+    str
+        Unified diff text for the staged changes.
+    """
+
+    cmd: list[str] = [
+        "git",
+        "diff",
+        "--cached",
+        "--patch",
+        "--minimal",
+        "--no-color",
+    ]
+    if base_ref:
+        cmd.append(base_ref)
+
+    try:
+        out: bytes = check_output(cmd, cwd=str(cwd))
+    except CalledProcessError as exc:
+        message = "Failed to retrieve staged diff from Git."
+        if base_ref:
+            message += (
+                " Ensure that the provided base_ref exists and is a valid Git reference."
+            )
+        raise RuntimeError(message) from exc
+
+    return out.decode()
+
+
+def commit_with_message(
+    message: str,
+    edit: bool,
+    cwd: Path,
+    /,
+    *,
+    amend: bool = False,
+) -> int:
+    """Create a commit with the given message.
+
+    Parameters
+    ----------
+    message
+        Commit message.
+    edit
+        If True, use the `--edit` flag to open an editor for amendments.
+    cwd
+        Git working directory.
+    amend
+        If True, pass ``--amend`` to Git to amend the current ``HEAD`` commit
+        instead of creating a new commit.
+
+    Returns
+    -------
+    int
+        The subprocess exit code.
+    """
+
+    cmd: list[str] = ["git", "commit"]
+    if amend:
+        cmd.append("--amend")
+
+    cmd.extend(["-m", message])
+    if edit:
+        cmd.append("--edit")
+
+    try:
+        completed = run(cmd, cwd=str(cwd), check=False)
+        return int(completed.returncode)
+    except OSError as exc:  # e.g., editor launch failure, etc.
+        raise RuntimeError(f"Failed to run 'git commit': {exc}") from exc

{git_commit_message-0.8.0 → git_commit_message-0.8.1}/src/git_commit_message.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: git-commit-message
-Version: 0.8.0
+Version: 0.8.1
 Summary: Generate Git commit messages from staged changes using LLM
 Maintainer-email: Mina Her <minacle@live.com>
 License: This is free and unencumbered software released into the public domain.
@@ -58,7 +58,7 @@ Generate a commit message from your staged changes using OpenAI, Google Gemini,
 ## Requirements
 
 - Python 3.13+
-- A Git repo with staged changes (`git add ...`)
+- A Git repo with staged changes (`git add ...`) (or use `--amend` even if nothing is staged)
 
 ## Install
 
@@ -167,6 +167,19 @@ git-commit-message --commit "refactor parser for speed"
 git-commit-message --commit --edit "refactor parser for speed"
 ```
 
+Amend the previous commit:
+
+```sh
+# print only (useful for pasting into a GUI editor)
+git-commit-message --amend "optional context"
+
+# amend immediately
+git-commit-message --commit --amend "optional context"
+
+# amend immediately, but open editor for final tweaks
+git-commit-message --commit --amend --edit "optional context"
+```
+
 Limit subject length:
 
 ```sh
@@ -216,6 +229,7 @@ git-commit-message --provider ollama --host http://192.168.1.100:11434
 - `--chunk-tokens N`: token budget per diff chunk (`0` = single summary pass, `-1` disables summarisation)
 - `--debug`: print request/response details
 - `--commit`: run `git commit -m <message>`
+- `--amend`: generate a message suitable for amending the previous commit (diff is from the amended commit's parent to the staged index; if nothing is staged, this effectively becomes the diff introduced by `HEAD`)
 - `--edit`: with `--commit`, open editor for final message
 - `--host URL`: host URL for providers like Ollama (default: `http://localhost:11434`)
 

git_commit_message-0.8.0/src/git_commit_message/_git.py

@@ -1,114 +0,0 @@
-"""Git-related helper functions.
-
-Provides repository root discovery, extraction of staged changes, and
-creating commits from a message.
-"""
-
-from __future__ import annotations
-
-from pathlib import Path
-from subprocess import CalledProcessError, check_call, check_output, run
-
-
-def get_repo_root(
-    cwd: Path | None = None,
-    /,
-) -> Path:
-    """Find the repository root from the current working directory.
-
-    Parameters
-    ----------
-    cwd
-        Starting directory for the search. Defaults to the current working directory.
-
-    Returns
-    -------
-    Path
-        The repository root path.
-    """
-
-    start: Path = cwd or Path.cwd()
-    try:
-        out: bytes = check_output(
-            [
-                "git",
-                "rev-parse",
-                "--show-toplevel",
-            ],
-            cwd=str(start),
-        )
-    except CalledProcessError as exc:  # noqa: TRY003
-        raise RuntimeError("Not a Git repository.") from exc
-
-    root = Path(out.decode().strip())
-    return root
-
-
-def has_staged_changes(
-    cwd: Path,
-    /,
-) -> bool:
-    """Check whether there are staged changes."""
-
-    try:
-        check_call(
-            ["git", "diff", "--cached", "--quiet", "--exit-code"],
-            cwd=str(cwd),
-        )
-        return False
-    except CalledProcessError:
-        return True
-
-
-def get_staged_diff(
-    cwd: Path,
-    /,
-) -> str:
-    """Return the staged changes as diff text."""
-
-    out: bytes = check_output(
-        [
-            "git",
-            "diff",
-            "--cached",
-            "--patch",
-            "--minimal",
-            "--no-color",
-        ],
-        cwd=str(cwd),
-    )
-    return out.decode()
-
-
-def commit_with_message(
-    message: str,
-    edit: bool,
-    cwd: Path,
-    /,
-) -> int:
-    """Create a commit with the given message.
-
-    Parameters
-    ----------
-    message
-        Commit message.
-    edit
-        If True, use the `--edit` flag to open an editor for amendments.
-    cwd
-        Git working directory.
-
-    Returns
-    -------
-    int
-        The subprocess exit code.
-    """
-
-    cmd: list[str] = ["git", "commit", "-m", message]
-    if edit:
-        cmd.append("--edit")
-
-    try:
-        completed = run(cmd, cwd=str(cwd), check=False)
-        return int(completed.returncode)
-    except OSError as exc:  # e.g., editor launch failure, etc.
-        raise RuntimeError(f"Failed to run 'git commit': {exc}") from exc