目录结构

├── README.md
├── composer.json
├── config.php    --- 配置项
├── helpers.php   --- 辅助函数
├── new           --- 生成周报模板
├── stubs         --- 模板目录
│   ├── report.php
│   └── toc.php
├── toc           --- 生成周报目录
└── today         --- 生成当日日报

配置项

你可以根据需要 config.php 的任意配置项，每个配置项都有注释说明。

辅助函数

通常情况下不需要修改，但也可以根据需要重写 helpers.php 的任意辅助函数。

生成周报模板

说明：生成周报模板，并输出到文件，文件名根据日期和配置项确定。

用法：

php new [+n]

• +n：可选参数，生成「未来第 n 周」的周报，不填则生成本周周报。例如 +1 则生成下周周报模板。

生成周报目录

说明：生成周报内容目录，并输出到文件，此命令将会覆盖原目录文件，文件路径根据日期和配置项确定。

用法：

php toc

生成当日日报

说明：提取某日 Git 提交记录，生成日报详情。

用法：

php today [-n]

• -n：可选参数，生成「过去第 n 天」的日报详情，不填则生成当日日报。例如 -1 则生成昨日日报。

模板目录

如需自定义周报模板，你可以修改这个目录下的各个模板文件，建议先尝试使用再根据需要修改并查看效果。