CaptainHook是一个针对 php 开发人员的易于使用且非常灵活的 git hook 库。它使您能够在简单的 json 文件中配置 git hook 操作。
您可以使用CaptainHook来验证或准备提交消息,确保代码质量或在提交或推送更改到 git 之前运行单元测试。您可以在拉取最新更改后自动清除本地缓存或安装最新的 Composer 依赖项。
CaptainHook可以轻松地在团队内共享钩子,甚至可以确保团队中的每个人都在本地激活钩子。
您可以运行 cli 命令,使用一些内置验证器,或者编写自己的由CaptainHook执行的 PHP 类。有关更多信息,请查看文档。
安装CaptainHook的首选方法是安装 PHAR 文件。您可以使用 Phive 或从 GitHub 发布页面下载 PHAR 来执行此操作。
phive安装captainhook
或者使用Composer来安装它。
作曲家要求 --dev Captainhook/captainhook-phar
如果您想获取源代码及其所有依赖项,您可以使用:
作曲家要求 --dev Captainhook/captainhook
安装 CaptainHook 后,您可以使用Captainhook可执行文件来创建配置。
供应商/bin/captainhook 配置
创建Captainhook.json配置文件后,您必须通过将钩子安装到本地 .git 目录来激活它们。为此,只需运行以下CaptainHook命令。
供应商/bin/captainhook 安装
观看这个简短的安装视频。
CaptainHook的目标之一是让团队轻松使用相同的 git hook。如果你想确保每个人都实际安装了钩子,你可以使用小型Composer插件hook-installer
。每次运行Composer命令时,它都会运行captainhook install
命令。
作曲家需要 --dev Captainhook/hook-installer
当然,队友仍然可以在不执行挂钩的情况下提交,这就是为什么您也应该在后端运行适当的检查。但至少这样没人会“意外”忘记安装它们。
以下是Captainhook.json配置文件的示例。
{“commit-msg”:{“启用”:true,“操作”:[ {“action”:“CaptainHookAppHookMessageActionBeams”} ] }, "预提交": {"启用": true,"操作": [ {“行动”:“phpunit”}, {“action”:“phpcs --standard = psr2 src”} ] }, "预推送": {"启用": false,"操作": [] } }
那么您想为CaptainHook
库做出贡献吗?出色的!非常感谢。我绝对需要你的帮助。
查看贡献指南。