getaiready/aiready-doc-drift
GitHub: getaiready/aiready-doc-drift
一款通过 AST 解析与 Git 历史分析，检测文档是否滞后于代码变更的轻量工具。
Stars: 0 | Forks: 0
# @aiready/doc-drift
[](https://npmjs.com/package/@aiready/doc-drift)
[](https://opensource.org/licenses/MIT)
## 概述
**文档漂移（Documentation Drift）**分析器结合 AST 解析与 Git 日志遍历，识别注释可能落后于实际实现逻辑的实例。
### 语言支持
- **完整支持：** TypeScript、JavaScript、Python、Java、Go、C#
- **能力：** JSDoc/Docstring/XML-Doc 漂移检测、签名不匹配
## 🏛️ 架构
```
🎯 USER
│
▼
🎛️ @aiready/cli (orchestrator)
│ │ │ │ │ │ │ │ │ │
▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼ ▼
[PAT] [CTX] [CON] [AMP] [DEP] [DOC] [SIG] [AGT] [TST] [CTR]
│ │ │ │ │ │ │ │ │ │
└─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┴─────┘
│
▼
🏢 @aiready/core
Legend:
PAT = pattern-detect CTX = context-analyzer
CON = consistency AMP = change-amplification
DEP = deps-health DOC = doc-drift ★
SIG = ai-signal-clarity AGT = agent-grounding
TST = testability CTR = contract-enforcement
★ = YOU ARE HERE
```
## 功能特性
- **漂移检测（Drift Detection）**：基于 Git 历史时间戳，检测文档是否比其所描述的代码更旧
- **签名不匹配（Signature Mismatches）**：在新增参数时，找出缺失的文档 `@param` 标签
## 安装
```
pnpm add @aiready/doc-drift
```
## 用法
```
aiready scan . --tools doc-drift
```
## 许可证
MIT
标签：AI代理上下文, AST解析, CMS安全, Docstring, Git版本控制, Go, JavaScript, JSDoc, JS文件枚举, npm包, Python, Ruby工具, SEO: 代码变更跟踪, SEO: 文档过时检测, XML文档, 代码分析, 代码变更, 依赖健康, 凭证管理, 开源许可证MIT, 数据可视化, 文档一致性, 文档管理, 文档过时, 无后门, 日志审计, 注释检测, 签名不匹配, 类型脚本, 网络安全研究, 自动化payload嵌入, 自动化攻击, 逆向工具