README

在 composer 配置中轻松管理 git 钩。这个命令行工具可以轻松实现项目范围内 git 钩的一致使用。在 composer 文件中指定钩子可以让项目团队的每个成员都能访问到它们。这为每个人提供了一个一致的环境和行为，这非常好。还可以用于在计算机上为每个仓库全局管理 git 钩。这样，您可以为每个选择要工作的项目创建一组可靠的钩子。

安装

在您的 composer.json 文件的 extra 部分添加一个 hooks 部分，并将钩子添加到其中。

{
    "extra": {
        "hooks": {
            "pre-commit": [
                "echo committing as $(git config user.name)",
                "php-cs-fixer fix ." // fix style
            ],
            // verify commit message. ex: ABC-123: Fix everything
            "commit-msg": "grep -q '[A-Z]+-[0-9]+.*' $1",
            "pre-push": [
                "php-cs-fixer fix --dry-run ." // check style
                "phpunit"
            ],
            "post-merge": "composer install"
            "...": "..."
        }
    }
}

然后使用以下命令安装

composer require --dev brainmaestro/composer-git-hooks

这会将 cghooks 二进制文件安装到您的 vendor/bin 文件夹中。如果该文件夹不在您的路径中，您需要在每个命令前添加 vendor/bin/。

注意：在 v3 中不再支持在 composer.json 的 scripts 或 hooks 根部分中声明的钩子。

全局支持

您还可以全局安装它。当使用新增的用于管理全局 git 钩的支持时，这感觉更自然。

composer global require --dev brainmaestro/composer-git-hooks

所有命令都支持全局（除了测试钩子。仍然需要在包含 composer.json 文件的目录中）。

可选配置

失败时停止

当钩子是一系列命令时，在命令失败时停止执行可能很有用。

在 stop-on-failure 配置部分中指定受影响的钩子。

{
    "extra": {
        "hooks": {
            "config": {
                "stop-on-failure": ["pre-push"]
            },
            "pre-push": [
                "php-cs-fixer fix --dry-run --stop-on-violation .",
                "phpunit"
            ],
        }
    }
}

在更改 stop-on-failure 配置部分后，务必运行更新命令。

自定义钩子

可以在 `config` 部分的 custom-hooks 数组中添加自定义钩子。

{
    "extra": {
        "hooks": {
            "config": {
                "custom-hooks": ["pre-flow-feature-start"]
            },
            "pre-flow-feature-start": [
                "echo 'Starting a new feature...'"
            ]
        }
    }
}

在更改 custom-hooks 配置部分后，务必运行更新命令。注意：`config` 不是有效的自定义钩子值。

快捷方式

将 cghooks 脚本添加到您的 composer.json 文件的 scripts 部分。这样，可以使用 composer cghooks ${command} 运行命令。如果您不想编辑系统路径，这很理想。

{
    "scripts": {
        "cghooks": "vendor/bin/cghooks",
        "...": "..."
    }
}

Composer 事件

将以下事件添加到您的 composer.json 文件中。每当事件发生时，都会运行 cghooks 命令。有关 composer 事件系统的更多信息，请参阅 Composer 命令事件。

{
    "scripts": {
        "post-install-cmd": "cghooks add --ignore-lock",
        "post-update-cmd": "cghooks update",
        "...": "..."
    }
}

用法

以下所有命令都必须在包含您的 composer.json 文件的同一文件夹中运行，或者通过指定 --git-dir 选项指向包含 composer.json 文件的文件夹。

添加钩子

安装完成后，运行 cghooks add 以添加在 composer 配置中指定的所有有效 git 钩。

lock 文件包含已添加钩子的列表。

如果使用了 --global 标志，钩子将被全局添加，并且全局 git 配置也将被修改。如果没有提供目录，将回退到全局配置中的当前 core.hooksPath。如果该值未设置，则默认为 $COMPOSER_HOME（这个特定的回退只发生在 add 命令中）。如果回退后仍然没有路径，将报错。

更新钩子

运行 cghooks update 的更新命令基本上忽略锁文件，并尝试从 composer 文件中添加钩子。这类似于 add 命令的 --force 选项所做的那样。如果自从第一次添加钩子以来 composer.json 文件中的钩子已更改，此命令非常有用。

使用 --global 时，其工作原理类似，只不过如果未提供目录，则不会回退到 $COMPOSER_HOME。

移除钩子

可以使用 cghooks remove 轻松移除钩子。这将移除在 composer 配置中指定的所有钩子。

也可以通过传递参数来移除钩子。命令 cghooks remove pre-commit post-commit 将移除 pre-commit 和 post-commit 钩子。

小心：如果锁文件被篡改或使用了强制选项，则使用此包之前已经存在但指定在 composer 脚本配置中的钩子也将被移除。也就是说，如果您之前有一个 pre-commit 钩子，但您的当前 composer 配置中也有一个 pre-commit 钩子，此选项将导致命令移除您的初始钩子。

此操作在未提供目录时也不回退到 $COMPOSER_HOME。

列出钩子

可以使用 cghooks list-hooks 命令列出钩子。这基本上检查 composer 配置并列出实际有文件的钩子。

常见选项

以下选项适用于所有命令。

每个命令还有一个 -v 标志来控制日志的详细程度。目前只支持一个级别。

测试钩子

在添加钩子之前，可以使用 cghooks ${hook} 来测试钩子。例如，cghooks pre-commit 将运行 pre-commit 钩子。

brainmaestro / composer-git-hooks

维护者

详细信息