#!/usr/bin/env python3 # -*- coding: utf-8 -*- """ 结构哨兵.py —— nomad 骨架团队工作区的最小结构哨兵（零依赖，纯标准库）。 这是什么 一个不依赖任何第三方库的独立脚本，对这支团队的文件夹跑四项检查、 打印一份人话报告。它是**护栏**，不是**闸门**——从不阻断、不代改任何 文件，只如实告诉你哪里漂移了。 四项检查 1. 存在性 —— 人格文件点名"必读"的文件（员工家六件套 + 核心治理文件） 真的都在磁盘上。 2. 孤儿 —— 磁盘上 memory/（记忆）目录下真实存在，但没有在该目录 README.md 里被提及登记的文件。 3. frontmatter schema —— 三个强制区（00-index/、02-shared-knowledge/、 01-agents/*/memory/）下的 .md 文件带齐必填四字段 （type/owner/created/status），且值落在受控词表内。 4. 断链 —— .md 文件内部的相对 markdown 链接（`[文字](路径)`） 真的能解析到磁盘上存在的文件。 用法 python3 结构哨兵.py [团队根目录] # macOS / Linux py -3 结构哨兵.py [团队根目录] # Windows python3 结构哨兵.py [团队根目录] --json report.json macOS 12.3 起系统已移除 /usr/bin/python，光敲 `python` 不可移植； macOS/Linux 一律用 `python3`，Windows 用 `py -3`。 团队根目录省略时默认当前工作目录。全部干净时退出码 0，发现任何违规 时退出码 1——可以直接接进任何"跑完看退出码"式的流程，不需要解析 stdout。 设计说明 这是作者自己生产团队工作区里一套设计模式（结构哨兵 + 元数据 schema） 的刻意精简移植版，已脱敏、通用化，不带任何私有名字/路径。受控值表 （见下方 TYPE_VALUES / STATUS_VALUES）与团队自带的治理文档 `00_导航索引/元数据挂靠规则.md` 保持一致——那份文档是给人读的操作手册， 这份脚本是给机器跑的校验器，两者对齐同一张词表。改文件名、加新员工 都不需要改这份脚本：它扫描磁盘现状来发现一切，只有"六件套文件清单" 和"三个强制区目录名"是写死的——因为那是团队骨架契约本身，不是随部署 变化的内容。 """ from __future__ import annotations import argparse import json import re import sys from datetime import datetime, timezone from pathlib import Path # 运行时版本门（护栏不阻断）：低于 Python 3.8 时给一句提示。能执行到这里说明解析已 # 通过（硬门槛是上面的 from __future__ import annotations，需 3.7+）；仅提醒、不退出， # 避免误伤本可运行的解释器。提示用 ASCII，防未配好编码的老环境二次报错。 if sys.version_info < (3, 8): sys.stderr.write( "[sentinel] Python %d.%d detected; 3.8+ recommended. Older versions may hit " "obscure syntax errors; please upgrade (Windows: use 'py -3').\n" % (sys.version_info.major, sys.version_info.minor) ) try: sys.stdout.reconfigure(encoding="utf-8", errors="replace") sys.stderr.reconfigure(encoding="utf-8", errors="replace") except Exception: pass # --------------------------------------------------------------------------- # 受控值表（与 00_导航索引/元数据挂靠规则.md 保持一致） # --------------------------------------------------------------------------- TYPE_VALUES = {"索引", "规则", "状态", "流水", "沉淀-知识", "沉淀-校准", "归档"} STATUS_VALUES = {"现役", "草稿", "待校正", "已过期", "归档"} REQUIRED_FIELDS = ["type", "owner", "created", "status"] MANDATORY_ZONE_DIRS = ["00_导航索引", "02_共享知识库"] # + 01_数字员工/*/记忆（动态发现） # 源材料/待填骨架目录——不纳入 frontmatter 与孤儿检测（这些目录刻意保留占位符/ # 原样上游内容不动；豁免理由见元数据挂靠规则 §四"工作台/98/99/bak 不挂"同一条纪律）。 EXEMPT_DIR_NAMES = { "templates", "工作台", "98_归档", "99_回收站", "97_待归纳", ".agent-modpack", ".git", "__pycache__", "skills", } EMPLOYEE_TEMPLATE_DIRNAME_MARKER = "待填勿加载" # 子串匹配，不管标注具体怎么写 AGENT_HOME_SIX_PIECE = [ "AGENTS.md", "CLAUDE.md", "工作台", "记忆/README.md", "记忆/收件箱.md", "记忆/工作日志.md", ] # 女娲这个员工不走标准六件套装配（走内核+模板库+两本专属记忆账的独立落地路径， # 见 installer 的 build_plan()），存在性检查按名单跳过她，不误报。豁免仅限六件套 # 检查这一项——女娲照样要过 frontmatter/断链/孤儿检查，不整体免检。 NUWA_AGENT_NAMES = {"nuwa", "女娲"} NUWA_HOME_REQUIRED = [ "AGENTS.md", "CLAUDE.md", "记忆/判断校准日志.md", "记忆/造员工台账.md", ] FRONTMATTER_RE = re.compile(r"\A?---[ \t]*\r?\n(.*?)\r?\n---[ \t]*\r?\n", re.DOTALL) FIELD_LINE_RE = re.compile(r"^([A-Za-z_]+):[ \t]*(.*)$") ISO_DATE_RE = re.compile(r"^\d{4}-\d{2}-\d{2}$") # markdown 行内链接：[文字](目标)——图片语法的前导 "!" 天然落在匹配之外，不受影响。 MD_LINK_RE = re.compile(r"\[[^\]]*\]\(([^)]+)\)") def is_exempt_path(path: Path, root: Path) -> bool: rel_parts = path.relative_to(root).parts for part in rel_parts: if part in EXEMPT_DIR_NAMES: return True if EMPLOYEE_TEMPLATE_DIRNAME_MARKER in part: return True return False def read_text(path: Path) -> str | None: try: text = path.read_text(encoding="utf-8") except Exception: return None if text.startswith(""): text = text[1:] return text # --------------------------------------------------------------------------- # 检查一：存在性 # --------------------------------------------------------------------------- def check_existence(root: Path) -> list[dict]: violations: list[dict] = [] if not (root / "team-config.json").exists(): violations.append({ "check": "存在性", "severity": "high", "path": "team-config.json", "message": "team-config.json 不存在——团队参数化脊柱丢了。", }) agents_root = root / "01_数字员工" if not agents_root.is_dir(): violations.append({ "check": "存在性", "severity": "high", "path": "01_数字员工", "message": "01_数字员工/ 目录不存在。", }) return violations for agent_dir in sorted(p for p in agents_root.iterdir() if p.is_dir()): if EMPLOYEE_TEMPLATE_DIRNAME_MARKER in agent_dir.name: continue # 待填模板骨架单独按结构检查，不当活员工查 required = NUWA_HOME_REQUIRED if agent_dir.name in NUWA_AGENT_NAMES else AGENT_HOME_SIX_PIECE for rel in required: if not (agent_dir / rel).exists(): violations.append({ "check": "存在性", "severity": "high", "path": str((agent_dir / rel).relative_to(root)), "message": f"员工「{agent_dir.name}」的必需文件缺失。", }) return violations # --------------------------------------------------------------------------- # 检查二：孤儿（记忆/ 下的文件未在记忆/README.md 登记） # --------------------------------------------------------------------------- def check_orphans(root: Path) -> list[dict]: violations: list[dict] = [] agents_root = root / "01_数字员工" if not agents_root.is_dir(): return violations for agent_dir in sorted(p for p in agents_root.iterdir() if p.is_dir()): if agent_dir.name in NUWA_AGENT_NAMES: continue # 女娲按设计没有 记忆/README.md 索引——见 NUWA_HOME_REQUIRED mem_dir = agent_dir / "记忆" if not mem_dir.is_dir(): continue readme_path = mem_dir / "README.md" readme_text = read_text(readme_path) if readme_text is None: violations.append({ "check": "孤儿", "severity": "high", "path": str(readme_path.relative_to(root)), "message": "记忆/README.md 不存在或读取失败——本员工的孤儿检测已跳过。", }) continue for entry in sorted(mem_dir.iterdir()): if entry.is_dir(): continue if entry.name == "README.md": continue if entry.name.startswith(".") or entry.name.endswith(".bak"): continue if entry.name not in readme_text: violations.append({ "check": "孤儿", "severity": "medium", "path": str(entry.relative_to(root)), "message": f"「{entry.name}」磁盘上存在，但未在 " f"{readme_path.relative_to(root)} 中被提及——请登记或删除。", }) return violations # --------------------------------------------------------------------------- # 检查三：frontmatter schema # --------------------------------------------------------------------------- def parse_frontmatter(text: str) -> dict | None: m = FRONTMATTER_RE.match(text) if not m: return None fields: dict[str, str] = {} for line in m.group(1).splitlines(): fm = FIELD_LINE_RE.match(line) if fm: fields[fm.group(1)] = fm.group(2).strip() return fields def mandatory_zone_dirs(root: Path) -> list[Path]: dirs = [root / d for d in MANDATORY_ZONE_DIRS if (root / d).is_dir()] agents_root = root / "01_数字员工" if agents_root.is_dir(): for agent_dir in sorted(p for p in agents_root.iterdir() if p.is_dir()): if EMPLOYEE_TEMPLATE_DIRNAME_MARKER in agent_dir.name: continue mem = agent_dir / "记忆" if mem.is_dir(): dirs.append(mem) return dirs def check_frontmatter(root: Path) -> list[dict]: violations: list[dict] = [] for zone in mandatory_zone_dirs(root): for md_path in sorted(zone.rglob("*.md")): if is_exempt_path(md_path, root): continue rel = md_path.relative_to(root) text = read_text(md_path) if text is None: violations.append({ "check": "frontmatter", "severity": "high", "path": str(rel), "message": "文件读取失败。", }) continue fields = parse_frontmatter(text) if fields is None: violations.append({ "check": "frontmatter", "severity": "high", "path": str(rel), "message": "缺失 YAML frontmatter（强制区要求 type/owner/created/status 四字段）。", }) continue # 原生 schema 嗅探（v0.4.0，跟进源头团队哨兵同项升级）：团队三字段全缺 # 但含 name/description/version/title 任一原生字段 = 这是别的元数据体系的 # 文件（SKILL.md、插件清单等）落进了必挂区。报"需人工裁决"一条，而不是 # 四条误导性的"必填字段缺失"。 if (not fields.get("type") and not fields.get("owner") and not fields.get("status") and any(fields.get(k) for k in ("name", "description", "version", "title"))): violations.append({ "check": "frontmatter", "severity": "medium", "path": str(rel), "message": "该文件带的是另一套体系的 frontmatter（name/description/" "version/title），却住在必挂区——需人工裁决：挪去它所属体系" "的位置（如 90_方法论/skills/），或改挂团队 schema。", }) continue for f in REQUIRED_FIELDS: if not fields.get(f): violations.append({ "check": "frontmatter", "severity": "high", "path": str(rel), "message": f"必填字段缺失：{f}", }) if fields.get("type") and fields["type"] not in TYPE_VALUES: violations.append({ "check": "frontmatter", "severity": "high", "path": str(rel), "message": f"type 值「{fields['type']}」不在七值受控表内：{sorted(TYPE_VALUES)}", }) if fields.get("status") and fields["status"] not in STATUS_VALUES: violations.append({ "check": "frontmatter", "severity": "high", "path": str(rel), "message": f"status 值「{fields['status']}」不在五值受控表内：{sorted(STATUS_VALUES)}", }) created = fields.get("created") if created and not (ISO_DATE_RE.match(created) and _is_real_date(created)): violations.append({ "check": "frontmatter", "severity": "medium", "path": str(rel), "message": f"created 值「{created}」不是合法的 YYYY-MM-DD 日期。", }) # 归档滞留提示（v0.4.0，跟进源头团队哨兵同项升级）：标了 归档/已过期 的 # 文件仍住在现役必挂区，多半该挪进 98_归档/。刻意用低级别——有时过期文件 # 是有意原位留碑的，这是提醒不是违规。 if fields.get("status") in ("归档", "已过期"): violations.append({ "check": "frontmatter", "severity": "low", "path": str(rel), "message": f"status 已是「{fields['status']}」但文件仍住在现役必挂区——" "考虑移入 98_归档/（若其实仍在服役，就把 status 改回现役）。", }) return violations def _is_real_date(value: str) -> bool: try: datetime.strptime(value, "%Y-%m-%d") return True except ValueError: return False # --------------------------------------------------------------------------- # 检查四：断链（.md 文件内部相对链接） # --------------------------------------------------------------------------- def check_broken_links(root: Path) -> list[dict]: violations: list[dict] = [] for md_path in sorted(root.rglob("*.md")): if is_exempt_path(md_path, root): continue text = read_text(md_path) if text is None: continue for m in MD_LINK_RE.finditer(text): target = m.group(1).strip() if not target: continue if re.match(r"^[a-zA-Z][a-zA-Z0-9+.-]*://", target): # http(s)://、mailto: 等外部链接 continue if target.startswith("#"): continue if target.startswith("{{") and target.endswith("}}"): continue # 未解析的占位符，还不是真链接 file_part = target.split("#", 1)[0].strip() if not file_part: continue if file_part.startswith("/"): candidate = root / file_part.lstrip("/") else: candidate = (md_path.parent / file_part).resolve() if not candidate.exists(): violations.append({ "check": "断链", "severity": "medium", "path": str(md_path.relative_to(root)), "message": f"链接目标在磁盘上不存在：{target}", }) return violations # --------------------------------------------------------------------------- # 报告 # --------------------------------------------------------------------------- def run_all(root: Path) -> dict: checks = { "存在性": check_existence(root), "孤儿": check_orphans(root), "frontmatter": check_frontmatter(root), "断链": check_broken_links(root), } all_violations = [v for vs in checks.values() for v in vs] return { "哨兵版本": "0.1.0-min", "团队根目录": str(root), "运行时间": datetime.now(timezone.utc).isoformat(), "各项计数": {name: len(vs) for name, vs in checks.items()}, "违规总数": len(all_violations), "总体结论": "干净" if not all_violations else "发现漂移", "违规明细": all_violations, } def render_report_text(report: dict) -> str: lines: list[str] = [] lines.append(f"=== 结构哨兵 · {report['团队根目录']} ===") lines.append(f"运行时间 : {report['运行时间']}") lines.append(f"总体结论 : {report['总体结论']}") c = report["各项计数"] lines.append( f"各项计数 : 存在性={c['存在性']} 孤儿={c['孤儿']} " f"frontmatter={c['frontmatter']} 断链={c['断链']}" ) lines.append("") if not report["违规明细"]: lines.append("没有可报告的问题——结构看起来是干净的。") return "\n".join(lines) by_check: dict[str, list[dict]] = {} for v in report["违规明细"]: by_check.setdefault(v["check"], []).append(v) for check_name, items in by_check.items(): lines.append(f"-- {check_name}（{len(items)}） --") for v in items: lines.append(f" [{v['severity']}] {v['path']}") lines.append(f" {v['message']}") lines.append("") lines.append( f"共 {report['违规总数']} 项问题。这是护栏不是闸门——没有任何文件被自动改动，" f"该修的自己修，改完重跑一遍确认。" ) return "\n".join(lines) def main() -> int: parser = argparse.ArgumentParser(description="nomad 骨架团队工作区的最小结构哨兵。") parser.add_argument("team_root", nargs="?", default=".", help="团队根目录（默认当前工作目录）") parser.add_argument("--json", dest="json_out", default=None, help="额外把机器可读 JSON 报告写到这个路径") args = parser.parse_args() root = Path(args.team_root).resolve() if not root.is_dir(): print(f"错误：团队根目录不存在或不是目录：{root}") return 2 report = run_all(root) print(render_report_text(report)) if args.json_out: Path(args.json_out).write_text( json.dumps(report, ensure_ascii=False, indent=2), encoding="utf-8", newline="\n", ) print(f"\nJSON 报告已写入：{args.json_out}") return 0 if report["总体结论"] == "干净" else 1 if __name__ == "__main__": sys.exit(main())