程

程沛权

git-commit-analytics：分析 Git Commit 记录生成工作日报

开源
程
程沛权2022/1/2 16:00:00
Star on GitHub

一个可以分析你的 Git 仓库 commit 记录的工具。它可以帮你生成一份工作日报 / 周报，或者你需要的更长时间范围的工作报告。

git-commit-analytics
git-commit-analytics

🚀 下载安装

这是一个客户端工具，所以你需要下载程序去使用它，点击 最新版本 去下载客户端。

注：

  • 由于最新版使用了新的打包工具，目前缺少 Windows 设备测试，如果无法运行，请下载 v1.4.1 版本的产物
  • 最新版本修复了 macOS 无法运行构建产物的问题，但如果依然遇到问题，可以选择克隆本仓库的代码，并通过 pnpm i 和 pnpm dev 使用。

⚡ 使用方法

创建并填写你的配置文件，然后运行程序，即可获得你的工作报告。

📂 配置文件

需要在与程序相同的文件夹下，创建一个名为 config.json 的文件，并写入以下格式的内容。

{
  "lang": "en",
  "authors": ["chengpeiquan"],
  "dateRange": ["2021-12-01", "2022-01-31"],
  "repos": ["D:\\Git\\git-commit-analytics"],
  "format": {
    "git-commit-analytics": "Git Commit Analytics"
  },
  "includes": ["feat", "fix", "docs", "style", "refactor", "test", "chore"],
  "excludes": ["typo", "backup", "progress"]
}

配置项说明如下：

keytypedescription
langstring设置软件的默认语言，支持 en （英语）和 zh （简体中文）。
authorsstring[]筛选 commit 的作者名称，支持多个作者名称，用于你在不同的仓库可能有不同的名字。
dateRange[string, string]填写 [开始日期， 结束日期] ， 支持合法的时间格式，会从开始日期的 00:00:00 统计到截止日期的 23:59:59 （如果不配置则默认运行程序的当天）。
reposstring[]你电脑里的 Git 仓库文件夹，需要提前切换到你要统计的分支。
format{ [key: string]: string }格式化你的文件夹名称为项目名。
includesstring[]要纳入统计的 commit message 前缀。
excludesstring[]在统计出来的结果里，排除掉包含了这些关键词的 commit message 。

其中，authors / includes / excludes 会创建为正则表达式去匹配数据。

📚 报告文件

报告文件会以 markdown 语法生成（可能是对程序员最通用的格式？），并以 .txt 格式的文件保存（可能是兼容性最好的格式？）。

会以项目名称作为二级标题归类，以 7 个类型的 commit 前缀作为三级标题归类：

typedescription
feat功能开发
fixBUG修复
docs完善文档
style优化样式
refactor代码重构
test测试用例
chore其他优化

可以点击 Commit message 和 Change log 编写指南 学习如何规范化提交 Git Commit 。

📝 Release Notes

详细更新内容请参考 更新记录 。