integer-net/todo-reminder

GrumPHP 扩展,提醒您处理未完成的待办事项

v0.2.0 2019-07-03 14:38 UTC

This package is auto-updated.

Last update: 2024-08-29 04:08:53 UTC


README

Latest Version on Packagist Software License Build Status Coverage Status Quality Score Total Downloads

一个命令行脚本,用于在 Git 提交后提醒更改的 PHP 文件中未完成的 TODO 注释。作为 post-commit Git 钩使用。

安装

在项目中通过 Composer 安装

composer require integer-net/todo-reminder

全局通过 Composer 安装

composer global require integer-net/todo-reminder

使用方法

要检查当前存储库的最后一次提交,请运行

vendor/bin/todo

如果您已全局安装 Todo Reminder,

todo --root /path/to/repository

要自动在每次提交后运行检查,请创建一个钩子 .git/hooks/post-commit,内容如下

#!/bin/sh
exec vendor/bin/todo

使钩子可执行,以便 Git 可以运行它

chmod +x .git/hooks/post-commit

变更日志

有关最近更改的更多信息,请参阅 CHANGELOG

测试

composer test

运行单元测试、变异测试和静态分析

贡献

有关详细信息,请参阅 CONTRIBUTINGCODE_OF_CONDUCT

安全性

如果您发现任何安全相关的问题,请通过电子邮件 fs@integer-net.de 联系我们,而不是使用问题跟踪器。

鸣谢

许可

MIT 许可证 (MIT)。有关更多信息,请参阅 许可文件