Squashed 'docs/standards/playbook/' changes from b529012..a854534
a854534 ✨ feat(plan_progress): auto-detect env for blocked plans 0d9a8ec 🐛 fix(playbook): honor no_backup for sync 2d401fa ✅ test(templates): update prompts validation e23474e 📝 docs(playbook): update prompts and sync notes 60ff3cd 🐛 fix(playbook): sync templates per file 816f036 ✅ test(playbook): add sync and vendor coverage 625cabb 📝 docs(memory_bank): reformat templates 2554c87 📝 docs(prompts): refresh prompt templates 6774a9d ✨ feat(plan_progress): track plan status in progress.md 73d5c26 🔧 chore(playbook): split sync_templates into sections 278750e ✨ feat(playbook): add plan progress tracking and rules updates 6efd637 🐛 fix(sync): keep agents block blank lines ea00d43 🐛 fix(playbook): support toml without tomllib ab0dd11 📝 docs(playbook): drop docs/plans snapshots 398696c ✨ feat(playbook): merge unified cli d959f80 🎨 style(docs): format markdown b4f712a 🗑️ remove(legacy): drop old scripts and tests 0c4cd0e ✨ feat(actions): add install_skills and format_md 3d1582c ✨ feat(sync): add templates and standards actions 49bbfa1 ✨ feat(vendor): add playbook snapshot generation 8cfcc25 ✨ feat(cli): parse toml config and dispatch actions 05903c3 ✨ feat(cli): add toml config and dispatch order 65d216e ✅ test(cli): add basic playbook cli tests f0bcf54 📝 docs(plans): add unified playbook cli plan 0885309 📝 docs(plans): add unified playbook cli design 3483d8a 🔧 chore(git): ignore .worktrees dir eb75036 🔧 chore(templates): align agent templates and docs efb93f1 📝 docs(playbook): drop todo/confirm mentions 4a85306 🗑️ remove(workflow): drop todo/confirm artifacts 9c5ee9f 🎨 style(markdown): format docs with prettier 5a2925f 🐛 fix(scripts): repair windows script parsing 26a35e0 ✅ test(ci): update required skills list 8df3883 🐛 fix(test): skip external root doc links b067fc1 📦 deps(skills): sync superpowers c03cda0 🔧 chore(ci): sync from origin main 55e05cb 🔧 chore(ci): use superpowers sync script 73c97f3 🔧 chore(ci): centralize superpowers sync 945704f 🔧 chore(ci): add superpowers sync workflow e5d2c93 🗑️ remove(skills): drop duplicate workflows 3ae9708 🐛 fix(ci): update tests for flag-only scripts c44b9aa 🔧 chore(scripts): require flag-driven args e4e1d14 🔧 chore(scripts): unify single-dash options b2eb475 ✅ test(templates): add template coverage fc230b7 🎨 style(markdown): format markdown files 8dc8924 🔧 chore(markdown): add prettier config and usage 2045dd4 ✨ feat(vendor_playbook): add apply-templates option 872d8cf ✨ feat(templates): add sync templates scaffolding 5b1ca45 📝 docs(skills): clarify todo-plan template 054967a ✨ feat(skills): add todo-plan skill cc340f1 🔧 chore(ci): align standards-check workflow template e9de0aa 🔧 chore(ci): drop removed skill check e5dd7d9 🔧 fix(sync): avoid backtick expansion 087b0b9 🔧 chore(sync): align agents block across ps1/bat 9481510 🔧 chore(sync): scope agents block to existing langs b0ca842 🔧 fix(sync): rewrite docs path in agents c98d65c 🔧 chore(sync): rewrite agents docs paths c33611c 🗑️ remove(skills): drop unused skills and update references 2b37860 🎨 style(markdown): format markdown files e3ecd26 📝 docs(tsl): align syntax annotations and examples 37546fe 🐛 fix(playbook): enforce rulesets to agents flow f2df89d 🐛 fix(scripts): include language list in AGENTS.md c0d0737 🐛 fix(playbook): add agents mirror for sync 3b8b99b 🎨 style(markdown): normalize md headings and lists 31f3000 ♻️ refactor(playbook): rename agents template directory to rulesets 11b2bed ✨ feat(markdown): add ruleset and sync support 5b89580 ✅ test(scripts): quiet git init warnings 5822a87 ♻️ refactor(playbook): streamline agents and refresh tsl docs git-subtree-dir: docs/standards/playbook git-subtree-split: a85453439f65b0c0aa05a5bbece773a02216ce76
This commit is contained in:
@@ -0,0 +1,210 @@
|
||||
#!/usr/bin/env python3
|
||||
from __future__ import annotations
|
||||
|
||||
import json
|
||||
import os
|
||||
import pathlib
|
||||
import re
|
||||
import subprocess
|
||||
import sys
|
||||
from typing import Dict, List, Optional, Tuple
|
||||
|
||||
|
||||
def _eprint(*args: object) -> None:
|
||||
print(*args, file=sys.stderr)
|
||||
|
||||
|
||||
def _git(*args: str) -> str:
|
||||
return subprocess.check_output(["git", *args], text=True).strip()
|
||||
|
||||
|
||||
def _repo_root() -> pathlib.Path:
|
||||
return pathlib.Path(_git("rev-parse", "--show-toplevel"))
|
||||
|
||||
|
||||
def _find_commit_spec(root: pathlib.Path) -> pathlib.Path:
|
||||
candidates = [
|
||||
root / "docs" / "common" / "commit_message.md",
|
||||
root / "docs" / "standards" / "playbook" / "docs" / "common" / "commit_message.md",
|
||||
]
|
||||
for path in candidates:
|
||||
if path.is_file():
|
||||
return path
|
||||
raise FileNotFoundError(
|
||||
"commit_message.md not found; expected one of:\n"
|
||||
+ "\n".join(f"- {p}" for p in candidates)
|
||||
)
|
||||
|
||||
|
||||
def _parse_type_emoji_mapping(md_text: str) -> Dict[str, str]:
|
||||
mapping: Dict[str, str] = {}
|
||||
for raw_line in md_text.splitlines():
|
||||
line = raw_line.strip()
|
||||
if not (line.startswith("|") and line.endswith("|")):
|
||||
continue
|
||||
if "type" in line and "emoji" in line:
|
||||
continue
|
||||
if re.fullmatch(r"\|\s*-+\s*(\|\s*-+\s*)+\|", line):
|
||||
continue
|
||||
|
||||
cols = [c.strip() for c in line.strip("|").split("|")]
|
||||
if len(cols) < 2:
|
||||
continue
|
||||
|
||||
m_type = re.search(r"`([^`]+)`", cols[0])
|
||||
m_emoji = re.search(r"`(:[^`]+:)`", cols[1])
|
||||
if not m_type or not m_emoji:
|
||||
continue
|
||||
|
||||
type_name = m_type.group(1).strip()
|
||||
emoji_code = m_emoji.group(1).strip()
|
||||
mapping[type_name] = emoji_code
|
||||
|
||||
if not mapping:
|
||||
raise ValueError("failed to parse type/emoji mapping from commit_message.md")
|
||||
return mapping
|
||||
|
||||
|
||||
def _validate_subject_line(
|
||||
line: str,
|
||||
mapping: Dict[str, str],
|
||||
*,
|
||||
require_emoji: bool,
|
||||
) -> Optional[str]:
|
||||
subject = line.strip()
|
||||
if not subject:
|
||||
return "empty subject"
|
||||
|
||||
m = re.match(
|
||||
r"^(?:(?P<emoji>:[a-z0-9_+-]+:)\s+)?"
|
||||
r"(?P<type>[a-z]+)"
|
||||
r"(?P<scope>\([a-z0-9_]+\))?"
|
||||
r":\s+(?P<text>.+)$",
|
||||
subject,
|
||||
)
|
||||
if not m:
|
||||
return "does not match ':emoji: type(scope): subject' or 'type(scope): subject'"
|
||||
|
||||
emoji = m.group("emoji")
|
||||
type_name = m.group("type")
|
||||
text = (m.group("text") or "").rstrip()
|
||||
|
||||
if type_name not in mapping:
|
||||
return f"unknown type: {type_name}"
|
||||
|
||||
if emoji:
|
||||
expected = mapping[type_name]
|
||||
if emoji != expected:
|
||||
return f"emoji/type mismatch: got {emoji} {type_name}, expected {expected} for type {type_name}"
|
||||
elif require_emoji:
|
||||
return "missing emoji (set COMMIT_LINT_REQUIRE_EMOJI=0 to allow)"
|
||||
|
||||
if text.endswith((".", "。")):
|
||||
return "subject should not end with a period"
|
||||
|
||||
return None
|
||||
|
||||
|
||||
def _load_event_payload() -> Tuple[str, Optional[dict]]:
|
||||
event_name = os.getenv("GITHUB_EVENT_NAME") or os.getenv("GITEA_EVENT_NAME") or ""
|
||||
event_path = os.getenv("GITHUB_EVENT_PATH") or os.getenv("GITEA_EVENT_PATH") or ""
|
||||
if not event_path:
|
||||
return event_name, None
|
||||
|
||||
path = pathlib.Path(event_path)
|
||||
if not path.is_file():
|
||||
return event_name, None
|
||||
|
||||
try:
|
||||
return event_name, json.loads(path.read_text(encoding="utf-8"))
|
||||
except Exception as exc:
|
||||
_eprint(f"WARN: failed to parse event payload: {path} ({exc})")
|
||||
return event_name, None
|
||||
|
||||
|
||||
def _gather_subjects(event_name: str, payload: Optional[dict]) -> List[Tuple[str, str]]:
|
||||
subjects: List[Tuple[str, str]] = []
|
||||
|
||||
if isinstance(payload, dict):
|
||||
if event_name.startswith("pull_request"):
|
||||
pr = payload.get("pull_request")
|
||||
if isinstance(pr, dict):
|
||||
title = (pr.get("title") or "").strip()
|
||||
if title:
|
||||
subjects.append(("pull_request.title", title.splitlines()[0].strip()))
|
||||
|
||||
if event_name == "push":
|
||||
commits = payload.get("commits")
|
||||
if isinstance(commits, list):
|
||||
for commit in commits:
|
||||
if not isinstance(commit, dict):
|
||||
continue
|
||||
msg = (commit.get("message") or "").strip()
|
||||
if not msg:
|
||||
continue
|
||||
subject = msg.splitlines()[0].strip()
|
||||
sha = commit.get("id") or commit.get("sha") or ""
|
||||
label = f"push.commit {sha[:7]}" if sha else "push.commit"
|
||||
subjects.append((label, subject))
|
||||
|
||||
if subjects:
|
||||
return subjects
|
||||
|
||||
try:
|
||||
subjects.append(("HEAD", _git("log", "-1", "--format=%s", "HEAD")))
|
||||
except Exception:
|
||||
pass
|
||||
return subjects
|
||||
|
||||
|
||||
def main() -> int:
|
||||
try:
|
||||
root = _repo_root()
|
||||
except Exception as exc:
|
||||
_eprint(f"ERROR: not a git repository: {exc}")
|
||||
return 2
|
||||
|
||||
os.chdir(root)
|
||||
|
||||
require_emoji = os.getenv("COMMIT_LINT_REQUIRE_EMOJI", "1") not in ("0", "false", "False")
|
||||
|
||||
try:
|
||||
spec_path = _find_commit_spec(root)
|
||||
except FileNotFoundError as exc:
|
||||
_eprint(f"ERROR: {exc}")
|
||||
return 2
|
||||
|
||||
try:
|
||||
mapping = _parse_type_emoji_mapping(spec_path.read_text(encoding="utf-8"))
|
||||
except Exception as exc:
|
||||
_eprint(f"ERROR: failed to read/parse {spec_path}: {exc}")
|
||||
return 2
|
||||
|
||||
event_name, payload = _load_event_payload()
|
||||
subjects = _gather_subjects(event_name, payload)
|
||||
|
||||
print(f"commit spec: {spec_path}")
|
||||
if event_name:
|
||||
print(f"event: {event_name}")
|
||||
print(f"require emoji: {require_emoji}")
|
||||
print(f"checks: {len(subjects)} subject(s)")
|
||||
|
||||
errors: List[str] = []
|
||||
for label, subject in subjects:
|
||||
err = _validate_subject_line(subject, mapping, require_emoji=require_emoji)
|
||||
if err:
|
||||
errors.append(f"- {label}: {err}\n subject: {subject}")
|
||||
|
||||
if errors:
|
||||
_eprint("ERROR: commit message lint failed:")
|
||||
for item in errors:
|
||||
_eprint(item)
|
||||
return 1
|
||||
|
||||
print("OK")
|
||||
return 0
|
||||
|
||||
|
||||
if __name__ == "__main__":
|
||||
raise SystemExit(main())
|
||||
|
||||
Reference in New Issue
Block a user