PD Rules Check

基于 18 套经典软件工程书籍和语言规范的编码规范审计工具。扫描项目或按用户选择，对照规范检查代码，输出带具体规则引用的结构化审计报告。

可用规范集

微观代码层（函数/变量级）

中观模块层（模块/API级）

宏观架构层

全局工程思维

工作流

模式 A：先扫描 → 后推荐（用户说"帮我看看项目"）

Step 1 — 项目快速扫描（L0 + L1）

扫描内容:
- 语言/框架识别: package.json, requirements.txt, go.mod, pom.xml, Cargo.toml 等
- 目录结构: 是否有 domain/, controller/, service/, test/, model/, repository/ 等
- 热点统计: 最大文件(行数)、最长函数(行数)、最深嵌套(层级)、最多参数
- 快速问题: 框架泄漏(grep import)、无超时外调(grep fetch/axios/requests)、无测试文件

Step 2 — 项目画像生成

生成表格:

• 语言、框架、推测架构
• 文件数、总行数、测试覆盖率
• 热点: 超过阈值的具体文件和函数
• 快速发现的问题清单

Step 3 — 规范推荐

根据项目特征匹配推荐（参见下方「匹配规则引擎」）。每条推荐标注优先级（高/中/低）和原因。

Step 4 — 用户确认

展示推荐清单，询问用户:

• 是否接受全部推荐
• 是否要调整（添加/删除某些规范）
• 是否要查看某个规范的详细说明

Step 5 — 深度审计

根据用户确认的规范集，读取 references/{book}/{book}.mini.md，逐条对照代码扫描，输出报告到 docs/pd-rule-check.md。

模式 B：用户选择 → 后审计（用户说"列出所有规范"）

Step 1 — 展示规范目录

向用户展示上方「可用规范集」完整列表，包含编号、名称、核心问题、规则数。

提示用户:

请输入编号选择 (如: 1,8,13)
或输入 "all" 全选
或输入编号查看规范详情 (如: "?1")

Step 2 — 查看规范详情（可选）

用户输入 ?N 时，读取 references/{book}/{book}.mini.md，展示:

• 适用场景 / 不适用场景
• 纠偏焦点
• Decision rules 和 Trigger rules 要点
• 与其他规范的兼容性

Step 3 — 兼容性检查

读取 references/COMPATIBILITY.md，检查用户选择的规范组合:

• ❌ 冲突: 警告用户并说明原因，让用户选择以哪个为准
• 🔁 重叠: 提示可能有重复检查，建议保留一个
• ✅ 互补: 通过

Step 4 — 执行审计

读取选中的 references/{book}/{book}.mini.md，对照项目代码逐条检查，输出报告到 docs/pd-rule-check.md。

直接模式：指定规范 + 指定路径

用户说"用 clean-code 审查 src/"时:

1. 直接读取 references/clean-code/clean-code.mini.md
2. 只扫描指定目录
3. 输出精简版报告

匹配规则引擎

项目特征 → 推荐规范的映射:

兼容性矩阵（精简）

从 references/COMPATIBILITY.md 读取。关键冲突:

审计扫描规则

可自动检测的（60%）

需人工判断的（40%）

审计报告格式

输出到 docs/pd-rule-check.md，结构:

# 代码规范审计报告

> 生成时间: YYYY-MM-DD
> 项目: /path/to/project
> 使用规范: xxx.mini, yyy.mini

## 一、项目概况
## 二、适用性分析
## 三、审计结果
  ### 🔴 严重问题
  ### 🟡 警告
  ### 🟢 建议
## 四、规范覆盖率统计
## 五、优先级建议
  ### 立即修复
  ### 短期改进
  ### 长期规划

每条发现必须包含:

• 规范来源 (具体到规则编号)
• 文件路径 + 行号
• 问题描述
• 影响分析
• 修复建议（含示例代码）

References

所有规范原始文件位于 references/ 目录:

references/
├── COMPATIBILITY.md                    # 兼容性矩阵
├── clean-code/
│   ├── clean-code.md                   # full 版
│   ├── clean-code.mini.md              # mini 版 (审计用)
│   └── clean-code.nano.md              # nano 版
├── clean-architecture/
├── a-philosophy-of-software-design/
├── code-complete/
├── domain-driven-design/
├── domain-driven-design-distilled/
├── implementing-domain-driven-design/
├── patterns-of-enterprise-application-architecture/
├── refactoring/
├── refactoring-guru/
├── release-it/
├── designing-data-intensive-applications/
├── the-pragmatic-programmer/
├── the-pragmatic-programmer/
├── working-effectively-with-legacy-code/
├── cpp-coding-standards/
│   ├── cpp-coding-standards.mini.md
│   └── cpp-coding-standards.nano.md
├── python-patterns/
│   ├── python-patterns.mini.md
│   └── python-patterns.nano.md
├── api-design/
│   ├── api-design.mini.md
│   └── api-design.nano.md
└── fastapi-patterns/
    ├── fastapi-patterns.mini.md
    └── fastapi-patterns.nano.md

审计时优先使用 .mini.md 版本。.md (full) 用于深度参考。.nano.md 用于快速提醒。