feat: add prompt templating (#24)

Author: mtth

poetry.lock

@@ -9,6 +9,7 @@ requires-python = '>=3.12'
 dependencies = [
   'gitpython (>=3.1.44,<4)',
   "xdg-base-dirs (>=6.0.2,<7.0.0)",
+  "jinja2 (>=3.1.5,<4.0.0)",
 ]
 
 [project.optional-dependencies]

pyproject.toml

@@ -9,6 +9,7 @@
 from .common import (
     Config,
     PROGRAM,
+    PromptRenderer,
     Store,
     UnreachableError,
     ensure_state_home,
@@ -74,7 +75,7 @@ def callback(_option, _opt, _value, parser) -> None:
         "-p",
         "--prompt",
         dest="prompt",
-        help="draft generation prompt, read from stdin if unset",
+        help="inline prompt",
     )
     parser.add_option(
         "-r",
@@ -88,6 +89,12 @@ def callback(_option, _opt, _value, parser) -> None:
         help="commit prior worktree changes separately",
         action="store_true",
     )
+    parser.add_option(
+        "-t",
+        "--template",
+        dest="template",
+        help="prompt template",
+    )
 
     return parser
 
@@ -98,7 +105,7 @@ def print_operation(op: Operation) -> None:
 
 def main() -> None:
     config = Config.load()
-    (opts, _args) = new_parser().parse_args()
+    (opts, args) = new_parser().parse_args()
 
     log_path = ensure_state_home() / "log"
     if opts.log:
@@ -123,12 +130,18 @@ def main() -> None:
         else:
             bot_config = config.bots[0]
         bot = load_bot(bot_config)
+
         prompt = opts.prompt
         if not prompt:
-            if sys.stdin.isatty():
+            if opts.template:
+                renderer = PromptRenderer.default()
+                kwargs = dict(e.split("=", 1) for e in args)
+                prompt = renderer.render(opts.template, **kwargs)
+            elif sys.stdin.isatty():
                 prompt = open_editor("Enter your prompt here...")
             else:
                 prompt = sys.stdin.read()
+
         manager.generate_draft(
             prompt, bot, checkout=opts.checkout, reset=opts.reset
         )

src/git_draft/__main__.py

@@ -4,6 +4,7 @@
 import dataclasses
 from datetime import datetime
 import functools
+import jinja2
 import logging
 import os
 from pathlib import Path
@@ -22,23 +23,35 @@
 PROGRAM = "git-draft"
 
 
+type JSONValue = Any
+type JSONObject = Mapping[str, JSONValue]
+
+
+_package_root = Path(__file__).parent
+
+
+def ensure_state_home() -> Path:
+    path = xdg_base_dirs.xdg_state_home() / PROGRAM
+    path.mkdir(parents=True, exist_ok=True)
+    return path
+
+
 @dataclasses.dataclass(frozen=True)
 class Config:
     log_level: int
     bots: Sequence[BotConfig]
-    # TODO: Add (prompt) templates.
 
     @staticmethod
-    def path() -> Path:
-        return xdg_base_dirs.xdg_config_home() / PROGRAM / "config.toml"
+    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.path()
+        path = cls.folder_path() / "config.toml"
         try:
             with open(path, "rb") as reader:
                 data = tomllib.load(reader)
@@ -51,10 +64,6 @@ def load(cls) -> Self:
             )
 
 
-type JSONValue = Any
-type JSONObject = Mapping[str, JSONValue]
-
-
 @dataclasses.dataclass(frozen=True)
 class BotConfig:
     factory: str
@@ -63,10 +72,28 @@ class BotConfig:
     pythonpath: str | None = None
 
 
-def ensure_state_home() -> Path:
-    path = xdg_base_dirs.xdg_state_home() / PROGRAM
-    path.mkdir(parents=True, exist_ok=True)
-    return path
+_prompt_root = _package_root / "prompts"
+
+
+class PromptRenderer:
+    def __init__(self, env: jinja2.Environment) -> None:
+        self._environment = env
+
+    @classmethod
+    def default(cls):
+        env = jinja2.Environment(
+            loader=jinja2.FileSystemLoader(
+                [Config.folder_path() / "prompts", str(_prompt_root)]
+            ),
+            autoescape=False,
+            keep_trailing_newline=True,
+            auto_reload=False,
+        )
+        return cls(env)
+
+    def render(self, template_name: str, **kwargs) -> str:
+        template = self._environment.get_template(f"{template_name}.jinja")
+        return template.render(kwargs)
 
 
 _default_editors = ["vim", "emacs", "nano"]
@@ -141,7 +168,7 @@ def cursor(self) -> Iterator[sqlite3.Cursor]:
                 self._connection.commit()
 
 
-_query_root = Path(__file__).parent / "queries"
+_query_root = _package_root / "queries"
 
 
 @functools.cache

src/git_draft/common.py

@@ -0,0 +1 @@
+Add a test for {{ symbol }}.

src/git_draft/prompts/add-test.jinja

@@ -68,9 +68,9 @@ def test_load_ok(self) -> None:
             factory = "bar"
             config = {one=1}
         """
-        path = sut.Config.path()
-        path.parent.mkdir(parents=True, exist_ok=True)
-        with open(path, "w") as f:
+        path = sut.Config.folder_path()
+        path.mkdir(parents=True, exist_ok=True)
+        with open(path / "config.toml", "w") as f:
             f.write(textwrap.dedent(text))
 
         config = sut.Config.load()
@@ -85,3 +85,13 @@ def test_load_ok(self) -> None:
     def test_load_default(self) -> None:
         config = sut.Config.load()
         assert config.log_level == logging.INFO
+
+
+class TestPromptRenderer:
+    @pytest.fixture(autouse=True)
+    def setup(self) -> None:
+        self._renderer = sut.PromptRenderer.default()
+
+    def test_ok(self) -> None:
+        prompt = self._renderer.render("add-test", symbol="foo")
+        assert "foo" in prompt