GitReporter

GitReporter 是一个 AI 自动生成报告的 VS Code 扩展，根据 Git 项目的提交记录，支持 DeepSeek、OpenAI 及其他兼容 OpenAI API 的服务商。

✨ 功能特性

• 📅 生成周报 - 总结过去 7 天的工作内容
• 📆 生成月报 - 总结过去 30 天的工作内容
• 📈 生成季度报 - 总结过去 90 天的工作内容
• 🤖 AI 驱动 - 使用 AI 智能分析提交记录（支持 DeepSeek、OpenAI 等）
• 📝 Markdown 格式 - 生成专业的 Markdown 格式报告
• 🎨 编辑器标题栏集成 - 在编辑器顶部标题栏提供便捷下拉菜单

📦 安装

从 VSIX 安装

1. 下载 .vsix 文件
2. 在 VS Code 中按 Ctrl+Shift+P，输入 "Install from VSIX"
3. 选择下载的 .vsix 文件

从源码安装

git clone https://github.com/your-username/gitreporter.git
cd gitreporter
npm install
npm run compile

然后按 F5 启动调试。

⚙️ 配置

在使用前，需要配置 API Key 和相关设置：

1. 打开 VS Code 设置（Ctrl + ,）
2. 搜索 "GitReporter"
3. 配置以下选项：

支持的 AI 服务商

本扩展支持任何兼容 OpenAI API 格式的服务商，常见配置示例：

DeepSeek（默认）

• API Base URL: https://api.deepseek.com
• Model: deepseek-chat
• 获取 API Key

OpenAI

• API Base URL: https://api.openai.com
• Model: gpt-4 或 gpt-3.5-turbo
• 获取 API Key

其他兼容服务商

如 Azure OpenAI、Claude (通过兼容层)、本地部署的 LLM 等，只需配置对应的 Base URL 和模型名称即可。

🚀 使用方法

方法一：使用编辑器标题栏（推荐）

1. 打开任意文件，在编辑器顶部右侧的标题栏中找到 📊 "生成报告" 图标
2. 点击图标展开下拉菜单
3. 选择要生成的报告类型：
   • 周报
   • 月报
   • 季报
   • 半年报告

方法二：使用命令面板

1. 按 Ctrl+Shift+P 打开命令面板
2. 输入 "GitReporter" 搜索命令
3. 选择要执行的命令：
   • GitReporter: 周报
   • GitReporter: 月报
   • GitReporter: 季报

📄 报告输出

生成的报告将保存在项目根目录的 reports/ 文件夹中，文件名格式为：

{report-type}-report-{timestamp}.md

例如：weekly-report-20241201-143052.md

报告内容结构

• 📋 工作概述 - 简要总结主要工作内容
• 🎯 主要成果 - 完成的主要功能或任务
• 🔧 技术改进 - 代码优化、bug 修复等
• 📈 工作量统计 - 提交次数、涉及的主要模块
• 📝 下一步计划 - 基于当前进度的建议

🔧 自定义模板

您可以通过设置 gitreporter.reportTemplate 来自定义报告模板。在模板中使用 {commits} 作为提交记录的占位符。

示例：

请根据以下提交记录生成一份简洁的工作周报：

{commits}

要求：使用中文，包含完成的工作和遇到的问题。

🛠️ 开发

环境要求

• Node.js >= 16
• VS Code >= 1.85.0

构建

# 安装依赖
pnpm install

# 编译
pnpm run compile

# 监听模式
pnpm run watch

# 打包
pnpm run package

📋 更新日志

查看 CHANGELOG.md 了解版本更新历史。

🐛 问题反馈

如果您在使用过程中遇到问题，请在 GitHub Issues 中提交反馈。