whisky

<p align="center"><img src="https://yellow-cdn.veclightyear.com/2b54e442/bdde4b72-eebe-4fd0-bfa2-4a7e474dca88.svg" width="75%" alt="Whisky 标志"></p> <p align="center"><img src="https://yellow-cdn.veclightyear.com/2b54e442/c172c5df-29a7-4cab-9937-d56f12544d76.png" width="75%" alt="Whisky 终端示例"></p>

简介

Whisky 是最简单的、框架无关的 CLI 工具，用于管理和执行整个团队的 PHP 项目 git 钩子。

Git 钩子是确保进入版本控制的代码满足组织代码质量标准的绝佳工具。然而，.git/hooks 并不包含在 git 树中。这使得让所有项目贡献者使用相同的检查和相同的设置变得不切实际。

安装

Whisky 的唯一依赖是 php^8.1。

你可以通过 composer 安装该包：

composer require --dev projektgopher/whisky
./vendor/bin/whisky install

这是推荐的方法，因为项目中的每个开发者都将可以使用该工具。

全局安装

Whisky 可以全局安装，但这意味着如果项目中的任何开发者想要使用它，他们也需要全局安装。

composer global require projektgopher/whisky
whisky install

如果 Whisky 在项目中同时全局和本地安装，运行的版本将取决于如何调用命令。

使用方法

install 命令将在项目根目录创建一个 whisky.json 文件：

// whisky.json
{
  "disabled": [],
  "hooks": {
    "pre-commit": [
      "./vendor/bin/pint --dirty"
    ],
    "pre-push": [
      "php artisan test"
    ]
  }
}

有关支持的 git 钩子的完整列表，请参阅 Git 文档。

警告 所有钩子都会按原样在终端中执行。在提交涉及 whisky.json 更改的内容时请记住这一点。

在 whisky.json 文件中添加或删除任何钩子（而不是单个命令）后，应该执行 ./vendor/bin/whisky update 以确保这些更改反映在你的 .git/hooks 目录中。

自动更新钩子

虽然我们建议将 Whisky 作为一个"选择加入"的工具，但通过添加几个 Composer 脚本，我们可以确保所有项目贡献者使用一致的 git 钩子。这将强制项目中的每个人使用 Whisky：

// composer.json
// ...  
  "scripts": {
    "post-install-cmd": [
      "whisky update"
    ],
    "post-update-cmd": [
      "whisky update"
    ]
  }
// ...

跳过钩子

有时你需要在不运行 git 钩子的情况下提交或推送更改， 比如当你要将工作转移到另一台计算机时。这通常可以通过使用 git 的原生 --no-verify 标志来完成。

git commit -m "wip" --no-verify

然而，某些 git 操作不支持此标志，比如 git merge --continue。 在这种情况下，运行以下命令将产生完全相同的效果。

./vendor/bin/whisky skip-once

注意 通过在你的 bash.rc 文件中添加 alias whisky=./vendor/bin/whisky，你可以缩短此命令的长度。

禁用钩子

将钩子的名称添加到 whisky.json 中的 disabled 数组中将禁用该钩子的运行。 这在构建尚未准备好供团队其他成员使用的工作流时很有用。

高级用法

对于比简单终端命令更复杂的操作，建议在项目根目录创建一个 scripts 目录。这还有一个额外的好处，即允许你运行用任何语言编写的脚本。

// whisky.json
// ...
  "pre-push": [
    "composer lint",
    "rustc ./scripts/complicated_thing.rs"
  ]
// ...

注意 在执行此操作时，请确保引用的任何脚本都是可执行的：

chmod +x ./scripts/*

测试

# 运行测试套件
composer test

# 无需进行虚拟提交即可测试钩子
git hook run pre-commit

故障排除

如果你同时在本地和全局安装了 Whisky，并且你的钩子被运行了两次，请尝试从其中一个安装中卸载 Whisky 的钩子。

# 移除全局 Whisky 钩子，保留本地钩子，
# 同时保留项目根目录中的 `whisky.json`。
whisky uninstall -n

贡献

注意 在贡献时不要构建二进制文件。二进制文件将在发布标记时构建。

请查看 CONTRIBUTING 以获取更多详细信息。

安全漏洞

请查看我们的安全策略，了解如何报告安全漏洞。

致谢

非常感谢 EXACTsports 对本包开发的支持。

• Len Woodward
• 所有贡献者

许可证

MIT 许可证 (MIT)。请查看 许可证文件 以获取更多信息。