codestaq/phook

用于创建 PHP Git Hooks 的辅助类

安装: 16

依赖项: 0

建议者: 0

安全: 0

星星: 6

关注者: 2

分支: 0

开放问题: 0

类型:cli-helper

v1.0 2013-02-10 12:34 UTC

This package is not auto-updated.

Last update: 2024-09-28 12:41:41 UTC


README

一个用于在 Git Hooks 中运行自定义函数的 PHP 类

用法

您可以通过 composer 安装此包

{
  "require": {
    "codestaq/phook": "1.0"
  }
}

这个类尽可能地详细,从函数名称方面来说。所以要在函数前后加上消息后运行一个简单的函数,您会输入

  use Codestaq\PHook;

  $ph = new PHook;
  
  $ph->say("Downloading some Gunther ... ")
     ->thenRun(function(){
        file_put_contents("Gunther.png", file_get_contents("https://dl.dropbox.com/u/30949096/Gunther.png"));
     })->andFinallySay("Done");

这将下载一张 Sassy Penguin 的图片到您的电脑。

还有更高级的命令,如 onTrigger,它只有在当前提交消息中找到特殊触发关键词时才会运行命令。

您还可以通过使用 unlessFails 命令添加一条消息,以显示命令失败时的消息,并且所有消息都可以使用颜色名称进行着色,如下所示

  $ph->say("This ")->green("Sentence ")->red("is Super ")->white("Colorful")->withoutACommand();

withoutACommand 函数将只显示消息而不运行任何函数,值得注意的是,如果您设置了触发器,即使没有函数会被运行,如果没有关键词,消息也不会显示。

支持的颜色有

  • 黑色
  • 红色
  • 绿色
  • 黄色
  • 蓝色
  • 品红色
  • 青色
  • 白色
  • 清除(无格式化)
  • 普通(重置为默认格式化)

更多示例请参阅 TestHook 文件。

致谢

这是一个由 Gabriel Manricks 创建的项目。您可以在推特上关注我: @gabrielmanricks

附言:

尽管我写了这是一个 Git Hook 库,但唯一真正的 Git 相关功能是触发器,所以如果您只需要一个具有颜色支持的终端打印程序,那么这会非常出色(包括命令部分)。