GitReport AI - VS Code 插件

GitReport AI 是一个强大的 VS Code 插件，它能够根据 Git 提交记录自动生成工作周报。该插件利用 DeepSeek API 进行智能总结，帮助您快速生成专业的工作报告。

主要功能

• 自动分析 Git 提交记录
• 智能总结工作内容
• 支持按当前用户过滤提交记录
• 支持自定义日期范围
• 支持保存上次使用的日期范围
• 提供多种预设日期范围选项
• 支持自定义报告模板
• 支持多语言（中文/英文）报告生成
• 支持导出为多种格式（Markdown/HTML/PDF）

安装

从 VS Code 市场安装

1. 在 VS Code 中打开扩展市场
2. 搜索 "GitReport AI"
3. 点击安装按钮

从 VSIX 文件安装

1. 下载最新的 .vsix 文件
2. 在 VS Code 中，选择 "扩展" 视图
3. 点击 "..." 菜单，选择 "从 VSIX 安装..."
4. 选择下载的 .vsix 文件

使用方法

1. 在 VS Code 中打开命令面板 (Ctrl+Shift+P 或 Cmd+Shift+P)
2. 输入 "GitReport AI: 生成工作报告"
3. 选择日期范围：
   • 使用上次日期范围：快速使用上次生成报告时使用的日期范围
   • 使用默认日期：使用系统默认的最近一周日期范围
   • 预设日期范围：选择最近两周、最近一月等预设选项
   • 自定义日期：手动输入开始和结束日期
4. 选择提交记录范围（如果配置为询问模式）：
   • 只显示我的提交：仅包含当前 Git 用户的提交记录
   • 显示所有人的提交：包含团队所有成员的提交记录
5. 等待报告生成完成
6. 查看生成的报告内容
7. 可选择导出为不同格式

配置选项

在 VS Code 设置中，您可以配置以下选项：

• gitreport-ai.deepseekApiKey: DeepSeek API 密钥
• gitreport-ai.reportTemplate: 自定义报告模板
• gitreport-ai.reportStartDate: 上次使用的开始日期
• gitreport-ai.reportEndDate: 上次使用的结束日期
• gitreport-ai.language: 报告语言（zh-CN/en-US）
• gitreport-ai.exportFormat: 导出格式（markdown/html/pdf）
• gitreport-ai.maxCommits: 最大提交记录数（默认：100）
• gitreport-ai.timeout: API 请求超时时间（默认：30000ms）
• gitreport-ai.filterByCurrentUser: 提交记录过滤方式（ask/always/never）

开发指南

环境要求

• Node.js >= 14.0.0
• VS Code >= 1.60.0
• Git >= 2.0.0

本地开发

1. 克隆仓库

git clone https://github.com/your-username/gitreport-ai.git
cd gitreport-ai

2. 安装依赖

npm install

3. 编译

npm run compile

4. 运行测试

npm test

5. 打包

npm run package

调试

1. 在 VS Code 中打开项目
2. 按 F5 启动调试
3. 在新窗口中测试插件功能

常见问题

1. API 密钥错误

   • 确保您已正确配置 DeepSeek API 密钥
   • 检查 API 密钥是否有效且未过期
   • 检查网络连接是否正常
   • 查看 VS Code 输出面板中的详细错误信息

2. 日期范围无效

   • 确保输入的日期格式正确 (YYYY-MM-DD)
   • 结束日期不能早于开始日期
   • 日期范围不能超过一年
   • 检查时区设置是否正确

3. 没有找到提交记录

   • 检查选择的日期范围内是否有 Git 提交
   • 确保当前工作区是一个有效的 Git 仓库
   • 检查 Git 配置是否正确
   • 尝试运行 git log 命令验证提交记录

4. 性能问题

   • 如果处理大量提交记录时遇到性能问题，可以调整 gitreport-ai.maxCommits 设置
   • 考虑使用更小的日期范围
   • 检查网络连接质量
   • 查看 VS Code 的性能分析工具

性能优化建议

1. API 调用优化

   • 使用请求缓存减少重复调用
   • 实现请求重试机制
   • 优化请求超时设置

2. Git 操作优化

   • 使用 Git 缓存减少重复查询
   • 优化提交记录过滤逻辑
   • 实现增量更新机制

3. 内存使用优化

   • 实现数据分页处理
   • 优化大型报告的内存使用
   • 及时清理临时文件

更新日志

v1.3.0

• 优化周报格式
• 内容整合功能
• 提升报告生成速度
• 改进用户界面体验

v1.2.0

• 新增多语言支持
• 新增多种导出格式
• 优化性能
• 改进错误处理

v1.1.0

• 新增"使用上次日期范围"选项
• 优化日期选择界面
• 支持保存上次使用的日期范围

v1.0.0

• 初始版本发布
• 支持基本的报告生成功能
• 支持自定义日期范围
• 支持预设日期范围选项

贡献指南

我们欢迎任何形式的贡献，包括但不限于：

• 提交 Bug 报告
• 提出新功能建议
• 改进文档
• 提交代码修改

请查看 CONTRIBUTING.md 了解详细的贡献指南。

许可证

本项目采用 AGPL-3.0 许可证。详见 LICENSE 文件。