项目简介
此项目是基于 PHP 的自动化周报生成工具,用于帮助开发者高效生成和整理日报与周报。该工具能够快速提取 Git 提交记录,并自动生成 Markdown 格式的日报和周报,极大提升工作效率,适合需要定期提交工作记录的开发者或团队。
项目的主要特性和功能
- Git 记录提取:可快速从 Git 仓库获取指定时间段的提交记录。
- 报告自动生成:根据 Git 提交记录生成包含工作内容、提交记录链接等信息的 Markdown 格式日报和周报表格。
- 模板自定义:支持用户自定义周报模板。
- 简洁命令行:提供友好的命令行界面,操作简单直观。
安装使用步骤
安装
- 确保满足以下环境要求:
- PHP >= 7.0
- Composer
- Git
- Git Bash(仅 Windows 需要)
- 使用 Git 复制本项目或下载 Zip 压缩包。
- 安装依赖:
bash cd toolkit composer install
- 所有代码位于
toolkit
目录下,可阅读 toolkit/README.md 查看详细说明。
使用
- 生成本周模板:
bash php toolkit/new
在posts
目录下会生成文件名为年份W周数.md
的本周模板。 - 配置项目:打开
toolkit/config.php
文件,修改最下方projects
配置项,示例如下:php //... 'projects' => [ '一个惊世骇俗的项目' => [ // 按需修改 'path' => realpath('Git 仓库本地目录'), // 按需修改 ], ]
- 生成日报: ```bash php toolkit/today # 生成今天日报 php toolkit/today -1 # 生成昨天日报 php toolkit/today -2 # 生成前天日报
... 以此类推
生成的表格已格式化,可直接复制粘贴进周报模板。
4. 生成目录:
bash
php toc
```
该命令会扫描配置项指定的周报文件夹,自动生成目录。
下载地址
点击下载 【提取码: 4003】【解压密码: www.makuang.net】