feat(output): separate code and docs into subdirectories

Group copied project files under a dedicated code/ directory
Group generated analysis, manifest, and overview under docs/
This commit is contained in:
2026-04-02 10:36:29 +08:00
parent 5ba2e3217a
commit eef3464257
4 changed files with 56 additions and 27 deletions

View File

@@ -2,6 +2,8 @@
`uipath-explainator` 会按 UiPath 项目入口 `main.xaml` 递归提取 `Invoke Workflow``Invoke VBA`,复制到指定工作区,删除 `<ui:CommentOut>` 里的无效代码,再重新扫描并裁掉不再使用的文件,最后逐个调用 Gemini 生成说明文档。
输出会自动拆成独立的 `code/``docs/` 两个子目录,避免说明文档和项目文件混在一起。
## 安装
```bash
@@ -26,7 +28,7 @@ GEMINI_MODEL=gemini-2.5-flash
```bash
./.venv/bin/python -m uipath_explainator \
/path/to/uipath-project \
--output-dir workspace/project-copy \
--output-dir workspace/project-bundle \
--force
```
@@ -40,11 +42,12 @@ GEMINI_MODEL=gemini-2.5-flash
## 输出内容
输出目录会保留原项目的相对目录结构,并额外生成
输出目录现在是一个 bundle 目录,里面固定包含
- `manifest.json`: 扫描、剪枝、告警和分析结果清单
- `OVERVIEW.md`: 总览说明书,除了文件数量,还会解释“初次扫描 -> 清理 Comment Out -> 二次扫描 -> 剪枝 -> Gemini 分析”的整条流水线逻辑
- `*.analysis.md`: 每个最终保留文件对应的 Gemini 咨询式说明,固定包含:
- `code/`: 复制出来并经过清理、剪枝后的项目文件,保留原项目相对目录结构
- `docs/manifest.json`: 扫描、剪枝、告警和分析结果清单
- `docs/OVERVIEW.md`: 总览说明书,除了文件数量,还会解释“初次扫描 -> 清理 Comment Out -> 二次扫描 -> 剪枝 -> Gemini 分析”的整条流水线逻辑
- `docs/*.analysis.md`: 每个最终保留文件对应的 Gemini 咨询式说明,固定包含:
- 文件定位:这个文件在整个流程中的角色、触发方式、核心作用
- 流程拆解:按步骤说明它是怎么执行的
- 关键逻辑:条件判断、调用关系、边界情况