公共文件
参考
包名、导出与 schema。
这里集中放你在把 VibeDocs 接入仓库或工具链时最常会查到的稳定入口和输出格式。
| 区域 | 稳定契约 | 说明 |
|---|---|---|
| 包名 | @leapx-ai/vibedocs |
VibeDocs 对外发布的 npm 包。 |
| 命令 | vibedocs |
本地文档操作 CLI 入口。 |
| 公共导出 |
@leapx-ai/vibedocs@leapx-ai/vibedocs/config@leapx-ai/vibedocs/reporting@leapx-ai/vibedocs/rule-engine
|
新增可以做，但删除或重命名应按 breaking change 处理。 |
| Report schema | schemas/report.schema.json |
结果中包含 diff 模式下的 suggested_docs 建议字段。 |
| Rule pack schema | schemas/rule-pack.schema.json |
本地只读覆盖，允许调整 severity、suggestion、owner hint 或禁用规则。 |
发布规则
versioning 与发版流程
- CLI、公共导出和 report schema 按 SemVer 管理。
CHANGELOG.md必须跟package.json一起更新。- Git tag 格式：
vX.Y.Z。 - GitHub Release 触发 npm 包发布工作流。