241 lines
8.4 KiB
Python
241 lines
8.4 KiB
Python
|
#!/usr/bin/env python3
|
||
|
|
"""Trellis per-turn breadcrumb hook (UserPromptSubmit / BeforeAgent equivalent).
|
||
|
|
|
||
|
|
Runs on every user prompt. Resolves the active task through Trellis'
|
||
|
|
session-aware active task resolver and emits a short <workflow-state>
|
||
|
|
block reminding the main AI what task is active and its expected flow.
|
||
|
|
|
||
|
|
The emitted ``hookEventName`` field is platform-aware: most hosts expect
|
||
|
|
``UserPromptSubmit`` (Claude Code naming, also accepted by Cursor / Qoder /
|
||
|
|
CodeBuddy / Droid / Codex / Copilot wiring), but Gemini CLI 0.40.x renamed
|
||
|
|
its per-turn event to ``BeforeAgent`` and its schema validator rejects the
|
||
|
|
legacy name. ``_detect_platform`` picks the right value at runtime.
|
||
|
|
Breadcrumb text is pulled exclusively from workflow.md
|
||
|
|
[workflow-state:STATUS] tag blocks — workflow.md is the single source of
|
||
|
|
truth. There are no fallback dicts in this script: when workflow.md is
|
||
|
|
missing or a tag is absent, the breadcrumb degrades to a generic
|
||
|
|
"Refer to workflow.md for current step." line so users see (and fix)
|
||
|
|
the broken state instead of the hook silently masking it.
|
||
|
|
|
||
|
|
Shared across all hook-capable platforms (Claude, Cursor, Codex, Qoder,
|
||
|
|
CodeBuddy, Droid, Gemini, Copilot). Kiro is not wired (no per-turn
|
||
|
|
hook entry point). Written to each platform's hooks directory via
|
||
|
|
writeSharedHooks() at init time.
|
||
|
|
|
||
|
|
Silent exit 0 cases (no output):
|
||
|
|
- No .trellis/ directory found (not a Trellis project)
|
||
|
|
- task.json malformed or missing status
|
||
|
|
"""
|
||
|
|
from __future__ import annotations
|
||
|
|
|
||
|
|
import json
|
||
|
|
import os
|
||
|
|
import re
|
||
|
|
import sys
|
||
|
|
from pathlib import Path
|
||
|
|
from typing import Optional
|
||
|
|
|
||
|
|
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
# CWD-robust Trellis root discovery (fixes hook-path-robustness for this hook)
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
|
||
|
|
def find_trellis_root(start: Path) -> Optional[Path]:
|
||
|
|
"""Walk up from start to find directory containing .trellis/.
|
||
|
|
|
||
|
|
Handles CWD drift: subdirectory launches, monorepo packages, etc.
|
||
|
|
Returns None if no .trellis/ found (silent no-op).
|
||
|
|
"""
|
||
|
|
cur = start.resolve()
|
||
|
|
while cur != cur.parent:
|
||
|
|
if (cur / ".trellis").is_dir():
|
||
|
|
return cur
|
||
|
|
cur = cur.parent
|
||
|
|
return None
|
||
|
|
|
||
|
|
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
# Active task discovery
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
|
||
|
|
def _detect_platform(input_data: dict) -> str | None:
|
||
|
|
if isinstance(input_data.get("cursor_version"), str):
|
||
|
|
return "cursor"
|
||
|
|
env_map = {
|
||
|
|
"CLAUDE_PROJECT_DIR": "claude",
|
||
|
|
"CURSOR_PROJECT_DIR": "cursor",
|
||
|
|
"CODEBUDDY_PROJECT_DIR": "codebuddy",
|
||
|
|
"FACTORY_PROJECT_DIR": "droid",
|
||
|
|
"GEMINI_PROJECT_DIR": "gemini",
|
||
|
|
"QODER_PROJECT_DIR": "qoder",
|
||
|
|
"KIRO_PROJECT_DIR": "kiro",
|
||
|
|
"COPILOT_PROJECT_DIR": "copilot",
|
||
|
|
}
|
||
|
|
for env_name, platform in env_map.items():
|
||
|
|
if os.environ.get(env_name):
|
||
|
|
return platform
|
||
|
|
script_parts = set(Path(sys.argv[0]).parts)
|
||
|
|
if ".claude" in script_parts:
|
||
|
|
return "claude"
|
||
|
|
if ".cursor" in script_parts:
|
||
|
|
return "cursor"
|
||
|
|
if ".codex" in script_parts:
|
||
|
|
return "codex"
|
||
|
|
if ".gemini" in script_parts:
|
||
|
|
return "gemini"
|
||
|
|
if ".qoder" in script_parts:
|
||
|
|
return "qoder"
|
||
|
|
if ".codebuddy" in script_parts:
|
||
|
|
return "codebuddy"
|
||
|
|
if ".factory" in script_parts:
|
||
|
|
return "droid"
|
||
|
|
if ".kiro" in script_parts:
|
||
|
|
return "kiro"
|
||
|
|
return None
|
||
|
|
|
||
|
|
|
||
|
|
def _resolve_active_task(root: Path, input_data: dict):
|
||
|
|
scripts_dir = root / ".trellis" / "scripts"
|
||
|
|
if str(scripts_dir) not in sys.path:
|
||
|
|
sys.path.insert(0, str(scripts_dir))
|
||
|
|
from common.active_task import resolve_active_task # type: ignore[import-not-found]
|
||
|
|
|
||
|
|
return resolve_active_task(root, input_data, platform=_detect_platform(input_data))
|
||
|
|
|
||
|
|
|
||
|
|
def get_active_task(root: Path, input_data: dict) -> Optional[tuple[str, str, str]]:
|
||
|
|
"""Return (task_id, status, source) from the current active task."""
|
||
|
|
active = _resolve_active_task(root, input_data)
|
||
|
|
if not active.task_path:
|
||
|
|
return None
|
||
|
|
|
||
|
|
task_dir = Path(active.task_path)
|
||
|
|
if not task_dir.is_absolute():
|
||
|
|
task_dir = root / task_dir
|
||
|
|
if active.stale:
|
||
|
|
return task_dir.name, f"stale_{active.source_type}", active.source
|
||
|
|
|
||
|
|
task_json = task_dir / "task.json"
|
||
|
|
if not task_json.is_file():
|
||
|
|
return None
|
||
|
|
try:
|
||
|
|
data = json.loads(task_json.read_text(encoding="utf-8"))
|
||
|
|
except (json.JSONDecodeError, OSError):
|
||
|
|
return None
|
||
|
|
|
||
|
|
task_id = data.get("id") or task_dir.name
|
||
|
|
status = data.get("status", "")
|
||
|
|
if not isinstance(status, str) or not status:
|
||
|
|
return None
|
||
|
|
return task_id, status, active.source
|
||
|
|
|
||
|
|
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
# Breadcrumb loading: parse workflow.md, fall back to hardcoded defaults
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
|
||
|
|
# Supports STATUS values with letters, digits, underscores, hyphens
|
||
|
|
# (so "in-review" / "blocked-by-team" work alongside "in_progress").
|
||
|
|
_TAG_RE = re.compile(
|
||
|
|
r"\[workflow-state:([A-Za-z0-9_-]+)\]\s*\n(.*?)\n\s*\[/workflow-state:\1\]",
|
||
|
|
re.DOTALL,
|
||
|
|
)
|
||
|
|
|
||
|
|
def load_breadcrumbs(root: Path) -> dict[str, str]:
|
||
|
|
"""Parse workflow.md for [workflow-state:STATUS] blocks.
|
||
|
|
|
||
|
|
Returns {status: body_text}. workflow.md is the single source of
|
||
|
|
truth — there are no fallback dicts in this script. Missing tags
|
||
|
|
(or a missing/unreadable workflow.md) fall back to a generic line
|
||
|
|
in build_breadcrumb so users see the broken state and fix
|
||
|
|
workflow.md, rather than the hook silently masking the issue.
|
||
|
|
"""
|
||
|
|
workflow = root / ".trellis" / "workflow.md"
|
||
|
|
if not workflow.is_file():
|
||
|
|
return {}
|
||
|
|
try:
|
||
|
|
content = workflow.read_text(encoding="utf-8")
|
||
|
|
except OSError:
|
||
|
|
return {}
|
||
|
|
|
||
|
|
result: dict[str, str] = {}
|
||
|
|
for match in _TAG_RE.finditer(content):
|
||
|
|
status = match.group(1)
|
||
|
|
body = match.group(2).strip()
|
||
|
|
if body:
|
||
|
|
result[status] = body
|
||
|
|
return result
|
||
|
|
|
||
|
|
|
||
|
|
def build_breadcrumb(
|
||
|
|
task_id: Optional[str],
|
||
|
|
status: str,
|
||
|
|
templates: dict[str, str],
|
||
|
|
source: str | None = None,
|
||
|
|
) -> str:
|
||
|
|
"""Build the <workflow-state>...</workflow-state> block.
|
||
|
|
|
||
|
|
- Known status (tag present in workflow.md) → detailed template body
|
||
|
|
- Unknown status (no tag, or workflow.md missing) → generic
|
||
|
|
"Refer to workflow.md for current step." line
|
||
|
|
- `no_task` pseudo-status (task_id is None) → header omits task info
|
||
|
|
"""
|
||
|
|
body = templates.get(status)
|
||
|
|
if body is None:
|
||
|
|
body = "Refer to workflow.md for current step."
|
||
|
|
header = f"Status: {status}" if task_id is None else f"Task: {task_id} ({status})"
|
||
|
|
if source:
|
||
|
|
header = f"{header}\nSource: {source}"
|
||
|
|
return f"<workflow-state>\n{header}\n{body}\n</workflow-state>"
|
||
|
|
|
||
|
|
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
# Entry
|
||
|
|
# ---------------------------------------------------------------------------
|
||
|
|
|
||
|
|
def main() -> int:
|
||
|
|
if os.environ.get("TRELLIS_HOOKS") == "0" or os.environ.get("TRELLIS_DISABLE_HOOKS") == "1":
|
||
|
|
return 0
|
||
|
|
|
||
|
|
try:
|
||
|
|
data = json.load(sys.stdin)
|
||
|
|
except (json.JSONDecodeError, ValueError):
|
||
|
|
data = {}
|
||
|
|
|
||
|
|
cwd_str = data.get("cwd") or os.getcwd()
|
||
|
|
cwd = Path(cwd_str)
|
||
|
|
|
||
|
|
root = find_trellis_root(cwd)
|
||
|
|
if root is None:
|
||
|
|
return 0 # not a Trellis project
|
||
|
|
|
||
|
|
templates = load_breadcrumbs(root)
|
||
|
|
task = get_active_task(root, data)
|
||
|
|
if task is None:
|
||
|
|
# No active task — still emit a breadcrumb nudging AI toward
|
||
|
|
# trellis-brainstorm + task.py create when user describes real work.
|
||
|
|
breadcrumb = build_breadcrumb(None, "no_task", templates)
|
||
|
|
else:
|
||
|
|
task_id, status, source = task
|
||
|
|
breadcrumb = build_breadcrumb(task_id, status, templates, source)
|
||
|
|
|
||
|
|
# Gemini CLI 0.40.x rejects "UserPromptSubmit" — its per-turn event is
|
||
|
|
# named "BeforeAgent". Other platforms (Claude/Cursor/Qoder/CodeBuddy/
|
||
|
|
# Droid/Codex/Copilot) accept the original Claude-style name.
|
||
|
|
hook_event_name = (
|
||
|
|
"BeforeAgent" if _detect_platform(data) == "gemini" else "UserPromptSubmit"
|
||
|
|
)
|
||
|
|
|
||
|
|
output = {
|
||
|
|
"hookSpecificOutput": {
|
||
|
|
"hookEventName": hook_event_name,
|
||
|
|
"additionalContext": breadcrumb,
|
||
|
|
}
|
||
|
|
}
|
||
|
|
print(json.dumps(output))
|
||
|
|
return 0
|
||
|
|
|
||
|
|
|
||
|
|
if __name__ == "__main__":
|
||
|
|
sys.exit(main())
|