README

在composer配置中轻松管理git hooks。这个命令行工具使得在项目中实现一致的git hooks使用变得简单。在composer文件中指定hooks，使得它们对项目团队中的每个成员都可用。这为每个人提供了一个一致的环境和行为，非常好。还可以用于全局管理计算机上每个仓库的git hooks。这样，您就可以为自己选择工作的每个项目制作一组可靠的hooks。

安装

将 hooks 部分添加到 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 根部分中声明的hooks。

全局支持

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

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

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

可选配置

失败时停止

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

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

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

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

自定义hooks

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

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

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

快捷方式

将 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 文件的文件夹。

添加Hooks

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

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

如果使用--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钩子，此选项将导致命令移除您的初始钩子。

如果使用--global且未提供目录，则也不会回退到$COMPOSER_HOME。

列出钩子

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

常用选项

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

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

测试钩子

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

bioman1464 / composer-git-hooks

维护者

详细信息