git-quick-stats API参考：函数接口与参数说明
项目地址: https://gitcode.com/gh_mirrors/gi/git-quick-stats git-quick-stats 是一个简单高效的 git 仓库统计工具，提供了丰富的 API 接口来获取各种 git 统计数据。无论你是项目管理者还是开发人员，都能通过这些函数快速了解项目的开发状况。🔥
🎯 核心函数接口概览
commitsCalendarByAuthor() - 作者提交日历
功能描述：显示指定作者按星期和月份的提交活动日历热图
参数说明：
$author(必填)：作者名称，用于筛选特定作者的提交记录
使用示例：
commitsCalendarByAuthor "John Doe"
commitsHeatmap() - 提交热力图
功能描述：显示最近30天（可配置）按小时分布的提交热力图
参数说明：
- 无直接参数，通过环境变量
_GIT_DAYS配置天数
配置参数：
_GIT_DAYS：设置热力图显示的天数，默认30天
detailedGitStats() - 详细Git统计
功能描述：按作者显示详细的贡献统计，包括提交数、插入行数、删除行数等
参数说明：
$branch(可选)：指定分支名称，默认为当前分支
排序配置：
_GIT_SORT_BY：设置排序字段和顺序，格式为"字段-顺序"- 字段：name, commits, insertions, deletions, lines
- 顺序：asc, desc
changelogs() - 变更日志
功能描述：以易读格式显示最新的提交历史
参数说明：
$author(可选)：指定作者，默认为所有作者
⚙️ 环境变量配置函数
filter_ignored_authors() - 作者过滤
功能描述：根据正则表达式过滤特定作者的提交记录
配置参数：
_GIT_IGNORE_AUTHORS：设置要忽略的作者正则表达式
showMenu() - 交互式菜单
功能描述：显示交互式菜单供用户选择统计选项
主题配置：
_MENU_THEME：设置菜单主题，可选值：default, legacy, none
🔧 工具函数
checkUtils() - 依赖检查
功能描述：检查系统是否安装了必要的工具依赖
必需工具：
- awk, basename, cat, column, date, echo, git, grep, head, printf, seq, sort, tput, tr, uniq
optionPicked() - 选项提示
功能描述：格式化显示用户选择的统计选项
参数说明：
$*(必填)：要显示的提示信息
usage() - 使用帮助
功能描述：显示完整的命令行参数说明和使用方法
📊 数据输出格式函数
统计输出格式
CSV输出：
- 通过
--csv-output-by-branch选项生成按分支的CSV格式统计
JSON输出：
- 通过
--json-output选项将git日志保存为JSON格式文件
🎨 自定义配置函数
时间范围配置
配置参数：
_GIT_SINCE：设置统计起始时间_GIT_UNTIL：设置统计结束时间
合并提交策略
配置参数：
_GIT_MERGE_VIEW：设置合并提交显示策略enable：显示合并提交和普通提交exclusive：仅显示合并提交- 默认：不显示合并提交
💡 使用技巧与最佳实践
函数调用顺序建议
- 先调用
checkUtils()确保环境依赖 - 配置所需的环境变量
- 调用相应的统计函数
- 使用
optionPicked()显示结果
性能优化建议
- 使用
_GIT_LIMIT限制输出数量 - 合理设置时间范围减少数据量
- 根据需要选择特定分支进行统计
git-quick-stats 的这些 API 函数为开发者提供了强大的 git 仓库分析能力，无论是个人项目还是团队协作，都能通过这些接口快速获取有价值的开发洞察。🚀
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
