Documentation
README
Project Maturity Scanner
对任意项目进行 8 维度深度成熟度扫描,产出结构化 Markdown 报告。
工作流概览
语言检测 → 加载 Reference → 并行收集 8 维度数据 → 综合评分 → 输出报告
三个核心原则:
- 用数据说话,不做主观猜测 — 每个评分背后都有可复现的命令和数据
- 先收集后评分 — 禁止在信息不全时下结论
- 风险优先 — 高风险项放在报告最前面,方便读者优先关注
Step 1: 语言检测与 Reference 加载
1.1 自动检测
扫描项目根目录,按优先级判断主语言:
| 信号 | 判定 |
|---|---|
Cargo.toml |
Rust |
package.json + tsconfig.json |
TypeScript |
package.json(无 tsconfig) |
JavaScript/Node |
go.mod |
Go |
pyproject.toml / setup.py / requirements.txt |
Python |
pom.xml / build.gradle |
Java/Kotlin |
Gemfile |
Ruby |
CMakeLists.txt |
C/C++ |
| 以上皆无 | Generic(通用检查) |
多语言项目:按代码量占比识别主语言和次语言,报告中对每种语言分别评估。
1.2 加载语言 Reference
根据检测结果,读对应 reference 文件获取语言特定的检查命令和指标:
This is the opening of the README. Read the full README on GitHub.