ccinn / husky-php

类似于 js-husky 客户端 git 钩子实现

v0.4.2 2023-01-09 03:23 UTC

README

Latest Stable Version Total Downloads Latest Unstable Version License PHP Version Require

PHP 与 composer 结合以实现类似于 js 的 NPM 模块 husky 的功能

简化 Git 钩子制作

Husky 可以防止不良的 git commitgit push 以及更多 Git 钩子

代码贡献者

该项目存在归功于所有贡献者。[贡献].

分支

  • v5.6-7.3.x => "ccinn/husky-php": "^0.1.0"
  • v7.4 => "ccinn/husky-php": "^0.2.0"
  • v8.0.0 => "ccinn/husky-php": "^0.4.0"

安装

在 composer.json 中

    "require-dev": {
        "ccinn/composer-husky-plugin": "^0.1.0",
        "ccinn/husky-php": "^0.4.0"
    },

或者

在 Shell 中

composer require --dev ccinn/composer-husky-plugin ccinn/husky-php

Docker

docker build --build-arg PHP_VERION=8.0.9 -t husky-php .

用法

您还可以使用 .huskyrc.huskyrc.json 文件配置钩子。

// .huskyrc or .huskyrc.json
{
  "hooks": {
    "pre-commit": "echo 'husky-php-pre-commit'",
    "pre-push": "echo 'husky-php-pre-push'",
    "...": "..."
  }
}

运行 git 行为钩子将被触发

git commit -m 'Keep calm and commit'

您将看到

husky-php-pre-commit

默认

默认情况下,pre-commit

默认支持的功能

  1. 检测代码冲突

  2. 测试代码规范

  3. 检查代码语法

窗口用户

您需要在 bash 环境中运行,例如:GitBash