git-work-record

English | 简体中文

根据 Git 提交记录来写日报、周报、月报。

升级说明

如果你之前使用过 v1.x 的版本，请注意 v2 相比较 v1 有以下变化：

1. 废弃参数 style、markdown，可通过编程方式实现。
2. grep 重命名为 search，改成通过 JS 实现查找。
3. 参数 reverse 的实现改成通过 JS 对内容进行排序。
4. 如果在一段时间内连续提交的信息一致，输出时会被去重。

安装

# pnpm
pnpm add -g git-work-record
# npm
npm install -g git-work-record

使用

命令行中使用（推荐）

git-wr #缩写命令，推荐
git-work-record #或者使用这个命令

编程方式使用

import GitWrokRecord from "git-work-record";
const main = async () => {
	const logs = await GitWrokRecord({
		// 这里是参数，详见下面
	});
	// 返回的是提交记录，可以根据自己的需求进行再处理
};
main();

如果编程方式使用时遇到 Cannot find package 'git-work-record' 类似错误，可以在编程目录安装 git-work-record 或者检查 Node 环境变量。

参数

| 参数名 | 作用 | | ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | --author | Git 提交作者，默认是项目中配置的作者 | | --committer | Git 的实际提交者，默认不参与查询 | | --search | 只需要包含特定字符的提交信息 | | --since | 别名 day，类似 git log 的 since 参数，用来查询特定时间范围的提交记录。具体的时间取值，格式：?days , ?weeks , ?years, 2016-11-25 , 传递数字会当做 ?days，如 --since=2 ，会当做 2days 查询近 2 天的数据。 | | --copy | 自动拷贝内容到剪贴板，只有命令行使用时生效 | | --deep | 目录递归层级，如果需要同时查询多个子目录下的 Git 项目，可以传需要递归查询的层级，默认是 3 | | --reverse | 是否倒序查询 Git 提交记录，开启提交时间早的在前面、不开启提交时间晚的在前面，默认不开启 | | --cwd | 通过编程方式调用时必传，是查询 Git 项目的基础路径 |

打赏作者

如果你觉得这个项目帮助到了你，你可以帮作者买一杯果汁表示鼓励 🍹。

打赏需要支付宝、微信支付。如果你没有这两种支付方式，你可以给一个免费的 Star。