SuperAPI AI 工具集

git-report

编程与开发

查看项目

更新于 10-16 09:22

技能介绍

用途

git-report 用于根据 Git 提交记录自动生成周报或月报,减少手工整理提交历史的工作量。它支持按报告类型、指定用户和日期范围来生成报告。

触发方式

可通过以下语句触发:

  • "生成周报"
  • "生成月报"
  • "生成本周周报"
  • "生成12月月报"
  • "生成周报 @用户名"
  • "生成最近N天的周报"

参数解析

技能会从用户输入中解析以下参数:

  • 类型:周报(默认"周报")或月报("月报")
  • 用户:默认使用当前 git user.name,可指定如 "@张三"
  • 日期:默认本周/本月,可指定如 "12月"、"2025-01"、"最近10天"

解析示例:

  • "生成本周周报" → 类型=周报, 用户=当前, 日期=本周
  • "生成12月月报" → 类型=月报, 用户=当前, 日期=12月
  • "生成周报 @张三" → 类型=周报, 用户=张三, 日期=本周
  • "生成最近10天的周报" → 类型=周报, 用户=当前, 日期=最近10天
  • "生成用户@李四 最近7天" → 类型=周报, 用户=李四, 日期=最近7天

执行流程

  1. 检测 MCP 可用性:优先使用 mcp__server-git__git_log,不可用则使用 Bash git log。

  2. 计算日期范围:

    • 周报(无指定)→ 本周一 00:00 ~ 今天 23:59
    • 月报(无指定)→ 本月1日 00:00 ~ 今天 23:59
    • "12月月报" → 12月1日 ~ 12月31日(或今天,若当月)
    • "最近N天" → N天前 00:00 ~ 今天 23:59
  3. 获取用户名:指定 @用户名 则使用该用户,否则读取 git config user.name。

  4. 查询提交记录:

    • 使用 MCP(优先):调用 mcp__server-git__git_log,传入 repo_path(当前目录)、start_timestamp、end_timestamp,然后按 author 过滤。
    • 使用 Bash(降级):执行 git log --author="用户名" --since="起始日期" --until="结束日期" --pretty=format:"%h - %s (%ai)" --no-merges。
  5. 美化提交记录:禁止原样输出 git log,必须合并相似提交(同一功能的多次提交合并为一条)、过滤噪音(忽略 Merge commit、Delete 目录等无意义提交)、规范描述(将简短的 "更新"、"修改" 补充为完整描述)、分类整理(按功能模块或类型分组)。输出格式为序号列表,不含日期,例如:

  6. 完成用户认证模块开发,包括登录、注册、密码重置功能

  7. 添加签到日志请求详情和状态筛选功能

  8. 修复打包配置问题

  9. 填充模板:读取 assets/templates/weekly.md 或 monthly.md,替换变量:

  • {{DATE_RANGE}}:日期范围,如 "2025-01-06 ~ 2025-01-10"
  • {{USER}}:用户名
  • {{COMMITS}}:美化后的工作内容(表格或列表)
  • {{COMMIT_COUNT}}:提交总数
  • {{REPOS}}:涉及仓库名(从 repo_path 提取)
  • {{STAT_LINES}}:代码行数统计(仅模板包含时计算)
  1. 输出结果:将填充后的模板内容输出给用户。

模板自定义

模板位于 assets/templates/,用户可修改或新增模板。可选变量 {{STAT_LINES}} 在模板包含时生效,会额外执行:

git log --author="用户名" --since="起始" --until="结束" --shortstat --oneline | grep -E "^\s*\d+\s+file"

汇总 insertions/deletions。

多仓库支持

若用户指定多个路径,对每个路径分别查询,合并结果后生成报告。

限制

资料中未提供其他限制、收费、价格、平台或效果信息。