feat: support editing templates (#48)

Author: mtth

docs/git-draft.adoc

@@ -12,25 +12,98 @@ v{manversion}
 
 git-draft - git-friendly code assistant
 
-IMPORTANT: _git-draft_ is WIP.
-Options documented below may not be implemented yet.
+IMPORTANT: `git-draft` is WIP.
 
 
 == Synopsis
 
-*git-draft* _[--generate]_ _[--prompt PROMPT]_ _[--reset]_ _[TEMPLATE [...]]_
+[verse]
+git draft [options] [--generate] [--bot BOT] [--edit] [--reset | --no-reset]
+                    [--sync] [TEMPLATE [VARIABLE...]]
+git draft [options] --finalize [--clean | --revert] [--delete]
+git draft [options] --show-drafts [--json]
+git draft [options] --show-prompts [--json] [PROMPT]
+git draft [options] --show-templates [--json | [--edit] TEMPLATE]
 
-*git-draft* _--finalize_ _[--delete]_
 
-*git-draft* _--discard_ _[--delete]_
+== Description
 
+`git-draft` is a git-centric way to edit code using AI.
 
-== Description
 
-_git-draft_ is a git-centric way to edit code using AI.
+== Options
+
+-b BOT::
+--bot=BOT::
+  Bot name.
+
+-c::
+--clean::
+  TODO
+
+-d::
+--delete::
+  Delete finalized branch.
+
+-e::
+--edit::
+  Edit.
+
+-F::
+--finalize::
+  TODO
+
+-G::
+--generate::
+  TODO
+
+-h::
+--help::
+  Show help message and exit.
+
+-j::
+--json::
+  Use JSON output.
+
+--log::
+  Show log path and exit.
+
+--reset::
+--no-reset::
+  TODO
+
+-r::
+--revert::
+  Abandon any changes since draft creation.
+
+--root::
+  Repository search root.
+
+-D::
+--show-drafts::
+  TODO
+
+-P::
+--show-prompts::
+  TODO
+
+-T::
+--show-templates::
+  TODO
+
+-s::
+--sync::
+  Create a sync commit with any changes.
+
+-t TIMEOUT::
+--timeout=TIMEOUT::
+  Action timeout.
+
+--version::
+  Show version and exit.
 
-=== How it works
 
+== Examples
 
 The workhorse command is `git draft --generate` which leverages AI to edit our code.
 A prompt can be specified as standard input, for example `echo "Add a test for compute_offset in chart.py" | git draft --generate`.
@@ -52,4 +125,4 @@ Note that you can come back to an existing draft anytime (by checking its branch
 
 == See also
 
-_git(1)_
+`git(1)`

src/git_draft/__main__.py

@@ -5,15 +5,15 @@
 import importlib.metadata
 import logging
 import optparse
-from pathlib import PurePosixPath
+from pathlib import Path, PurePosixPath
 import sys
 from typing import Sequence
 
 from .bots import load_bot
 from .common import PROGRAM, Config, UnreachableError, ensure_state_home
 from .drafter import Drafter
 from .editor import open_editor
-from .prompt import TemplatedPrompt, template_source, templates_table
+from .prompt import Template, TemplatedPrompt, templates_table
 from .store import Store
 from .toolbox import ToolVisitor
 
@@ -54,9 +54,9 @@ def callback(_option, _opt, _value, parser) -> None:
 
     add_command("finalize", help="apply current draft to original branch")
     add_command("generate", help="start a new draft from a prompt")
-    add_command("history", help="show history drafts or prompts")
-    add_command("revert", help="discard the current draft")
-    add_command("templates", help="show template information")
+    add_command("show-drafts", short="D", help="show draft history")
+    add_command("show-prompts", short="P", help="show prompt history")
+    add_command("show-templates", short="T", help="show template information")
 
     parser.add_option(
         "-b",
@@ -76,7 +76,12 @@ def callback(_option, _opt, _value, parser) -> None:
         help="delete draft after finalizing or discarding",
         action="store_true",
     )
-    # TODO: Add edit option. Works both for prompts and templates.
+    parser.add_option(
+        "-e",
+        "--edit",
+        help="edit prompt or template",
+        action="store_true",
+    )
     parser.add_option(
         "-j",
         "--json",
@@ -85,8 +90,8 @@ def callback(_option, _opt, _value, parser) -> None:
     )
     parser.add_option(
         "-r",
-        "--reset",
-        help="reset index before generating a new draft",
+        "--revert",
+        help="abandon any changes since draft creation",
         action="store_true",
     )
     parser.add_option(
@@ -95,11 +100,23 @@ def callback(_option, _opt, _value, parser) -> None:
         help="commit prior worktree changes separately",
         action="store_true",
     )
+
+    parser.add_option(
+        "--no-reset",
+        help="abort if there are any staged changes",
+        dest="reset",
+        action="store_false",
+    )
+    parser.add_option(
+        "--reset",
+        help="reset index before generating a new draft",
+        dest="reset",
+        action="store_true",
+    )
     parser.add_option(
-        "-t",
         "--timeout",
         dest="timeout",
-        help="bot generation timeout",
+        help="generation timeout",
     )
 
     return parser
@@ -125,6 +142,17 @@ def on_delete_file(self, path: PurePosixPath, _reason: str | None) -> None:
         print(f"Deleted {path}.")
 
 
+def edit(text: str | None, path: Path | None) -> str | None:
+    if sys.stdin.isatty():
+        return open_editor(text or "", path)
+    else:
+        if path and text is not None:
+            with open(path, "w") as f:
+                f.write(text)
+        print(path)
+        return None
+
+
 def main() -> None:
     config = Config.load()
     (opts, args) = new_parser().parse_args()
@@ -162,22 +190,35 @@ def main() -> None:
             bot,
             bot_name=opts.bot,
             tool_visitors=[ToolPrinter()],
-            reset=opts.reset,
+            reset=config.auto_reset if opts.reset is None else opts.reset,
+            sync=opts.sync,
         )
         print(f"Generated {name}.")
     elif command == "finalize":
-        name = drafter.finalize_draft(clean=opts.clean, delete=opts.delete)
-        print(f"Finalized {name}.")
-    elif command == "revert":
-        name = drafter.revert_draft(delete=opts.delete)
-        print(f"Reverted {name}.")
-    elif command == "history":
+        name = drafter.exit_draft(
+            revert=opts.revert, clean=opts.clean, delete=opts.delete
+        )
+        verb = "Reverted" if opts.revert else "Finalized"
+        print(f"{verb} {name}.")
+    elif command == "show-drafts":
         table = drafter.history_table(args[0] if args else None)
         if table:
             print(table.to_json() if opts.json else table)
-    elif command == "templates":
+    elif command == "show-prompts":
+        raise NotImplementedError()  # TODO
+    elif command == "show-templates":
         if args:
-            print(template_source(args[0]))
+            name = args[0]
+            tpl = Template.find(name)
+            if opts.edit:
+                if tpl:
+                    edit(tpl.source, tpl.local_path())
+                else:
+                    edit("", Template.local_path_for(name))
+            else:
+                if not tpl:
+                    raise ValueError(f"No template named {name!r}")
+                print(tpl.source)
         else:
             table = templates_table()
             print(table.to_json() if opts.json else table)

src/git_draft/common.py

@@ -35,30 +35,28 @@ def ensure_state_home() -> Path:
 
 @dataclasses.dataclass(frozen=True)
 class Config:
-    log_level: int
-    bots: Sequence[BotConfig]
+    log_level: int = logging.INFO
+    auto_reset: bool = True
+    bots: Sequence[BotConfig] = dataclasses.field(default_factory=lambda: [])
 
     @staticmethod
     def folder_path() -> Path:
         return xdg_base_dirs.xdg_config_home() / PROGRAM
 
-    @classmethod
-    def default(cls) -> Self:
-        return cls(logging.INFO, [])
-
     @classmethod
     def load(cls) -> Self:
         path = cls.folder_path() / "config.toml"
         try:
             with open(path, "rb") as reader:
                 data = tomllib.load(reader)
         except FileNotFoundError:
-            return cls.default()
+            return cls()
         else:
-            return cls(
-                log_level=logging.getLevelName(data["log_level"]),
-                bots=[BotConfig(**v) for v in data.get("bots", [])],
-            )
+            if level := data["log_level"]:
+                data["log_level"] = logging.getLevelName(level)
+            if bots := data["bots"]:
+                data["bots"] = [BotConfig(**v) for v in bots]
+            return cls(**data)
 
 
 @dataclasses.dataclass(frozen=True)