| name | yy-check-rules-consistency |
| description | 检查 README.md 中的规则列表与实际 rules/ 目录内容的一致性。当需要验证规则列表排序和内容是否与目录一致时触发。 不用于检查 README 中的技能列表或 AGENTS.md 章节一致性,也不用于创建或修改具体规则文档内容。
|
yy-check-rules-consistency
描述
检查 README.md 中的规则列表与实际 rules/ 目录内容的一致性,验证排序和内容是否匹配,并修复发现的问题。
使用场景
- 需要验证 README.md 中的规则列表是否按字母顺序排序
- 需要验证规则列表与 rules/ 目录实际内容一致
- 需要修复规则列表的不一致问题
不应触发:
- 只是查看 README.md 内容
- 只是检查 rules/ 目录内容
- 不是规则相关的文档一致性检查
指令
步骤 1. 读取 README.md
- 读取项目根目录的 README.md 文件
- 提取
## Rules 规则 章节下的规则列表
步骤 2. 读取 rules/ 目录
- 列出 rules/ 目录下的所有子目录
- 过滤出有效的规则目录(包含 RULE.md 的目录)
- 读取每个 RULE.md 的描述,优先取 frontmatter
description 字段,无 frontmatter 时取一级标题
步骤 3. 验证字母顺序排序
- 检查 README.md 中的规则列表是否按字母顺序排序
- 如果未排序,记录需要调整的顺序
步骤 4. 验证条目一致性
- 比较 README.md 中的规则列表与 rules/ 目录中的实际规则
- 识别出只在 README.md 中存在的规则(冗余项)
- 识别出只在 rules/ 目录中存在的规则(缺失项)
步骤 5. 验证描述一致性
- 将 README.md 列表中冒号后的描述与 RULE.md 的描述逐条比对
- 识别出描述不一致的规则(描述不一致项)
步骤 6. 生成验证报告
- 输出排序检查结果
- 输出条目一致性检查结果
- 输出描述一致性检查结果
- 列出发现的所有问题
步骤 7. 修复问题
决策分支:
- 发现排序问题:按字母顺序重新排列规则列表
- 发现缺失项:在 README.md 中添加相应的规则条目,描述从 RULE.md 的 frontmatter
description 字段或一级标题提取
- 发现冗余项:从 README.md 中删除对应的规则条目
- 发现描述不一致:用 RULE.md 的描述更新 README.md 中对应条目的描述
- 无问题:跳过修复
步骤 8. 输出结果
## 验证结果
### 排序检查
- 状态: ✅ 通过 / ❌ 未通过
- 详情: [具体说明]
### 条目一致性检查
- 状态: ✅ 通过 / ❌ 未通过
- 缺失项: [规则列表]
- 冗余项: [规则列表]
### 描述一致性检查
- 状态: ✅ 通过 / ❌ 未通过
- 描述不一致项: [规则名称及差异说明]
### 修复操作
- [已执行 / 未执行] 修复操作
- 详情: [具体修复内容]